docs/source/api/v4/letsencrypt_dnsrecords.rst

..
..
.. 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-v4-letsencrypt-dnsrecord:

**************************
``letsencrypt/dnsrecords``
**************************

``GET``
========
Gets DNS challenge records for Let's Encrypt DNS challenge for a specified :abbr:`FQDN (Fully Qualified Domain Name)`.

:Auth. Required: Yes
:Roles Required: "admin" or "operations"
:Permissions Required: DS-SECURITY-KEY:READ
:Response Type:  Array

Request Structure
-----------------
.. table:: Request Query Parameters

	+------+----------+--------------------------------------------------------------------------------------------------+
	| Name | Required | Description                                                                                      |
	+======+==========+==================================================================================================+
	| fqdn | no       | Return only DNS challenge records for the specified :abbr:`FQDN (Fully Qualified Domain Name)`   |
	+------+----------+--------------------------------------------------------------------------------------------------+

.. code-block:: http
	:caption: Request Example

	GET /api/4.0/letsencrypt/dnsrecord?fqdn=_acme-challenge.demo1.example.com. HTTP/1.1
	Host: trafficops.infra.ciab.test
	User-Agent: curl/7.47.0
	Accept: */*
	Cookie: mojolicious=...


Response Structure
------------------
:fqdn:      The :abbr:`FQDN (Fully Qualified Domain Name)` for the TXT record location to complete the DNS challenge
:record:    The record provided by Let's Encrypt to complete the DNS challenge

.. code-block:: http
	:caption: Response Example

	HTTP/1.1 200 OK
	Content-Type: application/json

	{ "response": [
		{
			"fqdn":"_acme-challenge.demo1.example.com.",
			"record":"testRecord"
		}
	]}