Retrieve a Distribution

Prerequisite: Only contract administrators, owners, and users with accessAndManageCdn privilege can create and manage CDN distributions using the API. You can also set user privileges in the DCD. For more information, see Set User Privileges.

To retrieve a CDN distribution, perform a GET request with the distributionId of the CDN.

Endpoint

Use the following endpoint to retrieve a CDN distribution: https://cdn.de-fra.ionos.com/distributions/{distributionId}.

Request

Note: The following request contains a sample distributionId. Replace them with the distributionId value, whose information you want to retrieve.

curl --location \
--request GET 'https://cdn.de-fra.ionos.com/distributions/9ba15778-16c4-543c-8775-e52acf4853f5' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO' \
--header 'Content-Type: application/json'

Path Parameters

Below is the list of mandatory path parameter:

Path Parameter	Type	Description	Example
distributionId	string	The ID (UUID) of the CDN distribution.	9ba15778-16c4-543c-8775-e52acf4853f5

Request Header Parameters

To make authenticated requests to the API, the following fields are mandatory in the request header:

Header Parameters	Required	Type	Description
Authorization	yes	string	The Bearer token enables requests to authenticate using a JSON Web Token (JWT). From the DCD, Generate authentication token.
Content-Type	yes	string	Set this to application/json.

Response

200 Successful operation

{
  "id": "9ba15778-16c4-543c-8775-e52acf4853f5",
  "type": "distribution",
  "href": "/distributions/9ba15778-16c4-543c-8775-e52acf4853f5",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "publicEndpointIpv4": "1.2.3.4",
    "publicEndpointIpv6": "2001:db8::ff00:42:8329",
    "ownershipTxtFqdn": "_dep_ws_mutex.example.com",
    "ownershipTxtValue": "4b2a9f1e8c7d6053a2b1c0d9e8f7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9_1720000000000",
    "state": "AVAILABLE",
    "message": "In progress."
  },
  "properties": {
    "domain": "example.com",
    "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
    "routingRules": [
      {
        "scheme": "http/https",
        "prefix": "/api",
        "upstream": {
          "host": "server.example.com",
          "caching": true,
          "waf": true,
          "geoRestrictions": {
            "blockList": [
              "CN",
              "RU"
            ]
          },
          "rateLimitClass": "R100",
          "sniMode": "origin"
        }
      }
    ]
  }
}

Result: The CDN distribution details are retrieved for the given distributionId.

Domain ownership verification: The read-only metadata.ownershipTxtFqdn and metadata.ownershipTxtValue fields provide the details for a TXT record you can publish in DNS to claim ownership of the distribution's domain. Create a TXT record using the name from ownershipTxtFqdn and the value from ownershipTxtValue. If another user currently claims the same domain, you must publish this record before the distribution can reach the AVAILABLE state. Keep the TXT record published permanently to retain ownership of the domain.