Retrieve Distribution

Returns the Distribution by ID.

get

Authorizations

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

distributionIdstring · uuidRequired

The ID (UUID) of the Distribution.

Example: 9ba15778-16c4-543c-8775-e52acf4853f5

Responses

200

Getting Distribution was successful.

application/json

idstring · uuidRequired

The ID (UUID) of the Distribution.

Example: 9ba15778-16c4-543c-8775-e52acf4853f5

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the Distribution.

Example: /distributions/9ba15778-16c4-543c-8775-e52acf4853f5

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get/distributions/{distributionId}

GET /distributions/{distributionId} HTTP/1.1
Host: cdn.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "ddc2b9d6-3a8a-4f1a-8f8d-9a6c7e1a3b2c",
    "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": "R1",
          "sniMode": "distribution"
        }
      }
    ]
  }
}