API docs by Redocly

IONOS Cloud - CDN Distribution API (1.2.0)

Download OpenAPI specification:Download

This API manages CDN distributions.

IONOS Cloud - CDN API documentation

Distributions

A CDN distribution resource.

This tag groups all operations for distributions.

Retrieve all Distributions

This endpoint enables retrieving all Distributions using pagination and optional filters.

Authorizations:
tokenAuth
query Parameters
offset
integer <int32> >= 0
Default: 0

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100
Example: limit=100

The maximum number of elements to return. Use together with offset for pagination.

filter.domain
string [ 2 .. 253 ] characters ^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-...
Example: filter.domain=example.com

filters resources by domain.

filter.state
string
Enum: "AVAILABLE" "BUSY" "FAILED" "UNKNOWN"
Example: filter.state=AVAILABLE

filters resources by state.

Responses

Response samples

Content type
application/json
{
  • "id": "24c578a9-361f-54d4-a326-a3f3070d5a03",
  • "type": "collection",
  • "href": "/distributions",
  • "items": [
    ],
  • "offset": 0,
  • "limit": 42,
  • "_links": {}
}

Create Distribution

Creates a new Distribution.

The full Distribution needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
Request Body schema: application/json

Distribution to create.

object

Metadata

required
object (Distribution)

A CDN distribution resource.

Responses

Request samples

Content type
application/json
{
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "9ba15778-16c4-543c-8775-e52acf4853f5",
  • "type": "distribution",
  • "href": "/distributions/9ba15778-16c4-543c-8775-e52acf4853f5",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Distribution

Returns the Distribution by ID.

Authorizations:
tokenAuth
path Parameters
distributionId
required
string <uuid>
Example: 9ba15778-16c4-543c-8775-e52acf4853f5

The ID (UUID) of the Distribution.

Responses

Response samples

Content type
application/json
{
  • "id": "9ba15778-16c4-543c-8775-e52acf4853f5",
  • "type": "distribution",
  • "href": "/distributions/9ba15778-16c4-543c-8775-e52acf4853f5",
  • "metadata": {
    },
  • "properties": {
    }
}

Ensure Distribution

Ensures that the Distribution with the provided ID is created or modified. The full Distribution needs to be provided to ensure (either update or create) the Distribution. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations:
tokenAuth
path Parameters
distributionId
required
string <uuid>
Example: 9ba15778-16c4-543c-8775-e52acf4853f5

The ID (UUID) of the Distribution.

Request Body schema: application/json

update Distribution

id
required
string <uuid>

The ID (UUID) of the Distribution.

object

Metadata

required
object (Distribution)

A CDN distribution resource.

Responses

Request samples

Content type
application/json
{
  • "id": "9ba15778-16c4-543c-8775-e52acf4853f5",
  • "metadata": { },
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "id": "9ba15778-16c4-543c-8775-e52acf4853f5",
  • "type": "distribution",
  • "href": "/distributions/9ba15778-16c4-543c-8775-e52acf4853f5",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Distribution

Deletes the specified Distribution.

Authorizations:
tokenAuth
path Parameters
distributionId
required
string <uuid>
Example: 9ba15778-16c4-543c-8775-e52acf4853f5

The ID (UUID) of the Distribution.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}