mattjackson220 commented on a change in pull request #3534: TP Delivery Service Generate SSL update, new letsencrypt generate and… URL: https://github.com/apache/trafficcontrol/pull/3534#discussion_r335675118
########## File path: docs/source/api/deliveryservices_sslkeys_generate_letsencrypt.rst ########## @@ -0,0 +1,64 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-deliveryservices-sslkeys-generate-letsencrypt: + +************************************************* +``deliveryservices/sslkeys/generate/letsencrypt`` +************************************************* + +``POST`` +======== +Generates an SSL certificate and private key using Let's Encrypt for a :term:`Delivery Service` + +:Auth. Required: Yes +:Roles Required: "admin" or "operations" +:Response Type: Object (string) + +Request Structure +----------------- +:key: The 'xml_id' of the :term:`Delivery Service` for which keys will be generated +:version: The version of the keys being generated +:hostname: The desired hostname of the :term:`Delivery Service` + + .. note:: In most cases, this must be the same as the :term:`Delivery Service` URL' + +:cdn: The CDN of the :term:`Delivery Service` for which the certs will be generated +:deliveryservice: The :term:`Delivery Service` for which keys will be generated Review comment: i thought that in theory xml id and delivery service do not have to be the same (there are 2 fields in the DeliveryServiceSSLKeys object) but it looks like in practice they are the same so i will remove one of them from this ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
