Skip to main content
POST
Python
This endpoint is in beta. BETA

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Body

application/json
cname
string
required

Alias hostname. Wildcard hostnames are not supported.

Example:

"shop.example.com"

resource_id
integer
required

ID of the CDN resource whose settings the alias is served with.

Example:

4567

ssl_id
integer | null

ID of your own SSL certificate to serve for the alias. The certificate must cover the alias hostname. A Let's Encrypt certificate issued for one of your CDN resources cannot be used.

Omit it to have a Let's Encrypt certificate issued automatically.

Example:

890

automated
boolean

How the alias certificate is managed. Defaults to true when ssl_id is omitted and to false when ssl_id is passed.

Possible values:

  • true – A Let's Encrypt certificate is issued and renewed automatically. ssl_id must be omitted.
  • false – Your own certificate referenced by ssl_id, if any, is served.
Example:

true

challenge_type
enum<string>

Domain validation method used to issue the Let's Encrypt certificate. Defaults to dns_01. Can be passed only when automated is true.

Available options:
dns_01,
http_01
Example:

"http_01"

active
boolean

Whether the alias is enabled. Defaults to true.

Example:

true

Response

Successful.

id
integer

Alias ID.

Example:

123

cname
string

Alias hostname. Cannot be changed after creation.

Example:

"shop.example.com"

resource_id
integer

ID of the CDN resource whose settings the alias is served with. Cannot be changed after creation.

Example:

4567

automated
boolean

How the alias certificate is managed. Can be changed while the alias is served.

Possible values:

  • true – A Let's Encrypt certificate is issued and renewed automatically.
  • false – The certificate referenced by ssl_id, if any, was added by you.
Example:

true

challenge_type
enum<string> | null

Domain validation method used to issue the Let's Encrypt certificate for the alias. null when automated is false.

Available options:
dns_01,
http_01
Example:

"http_01"

ssl_id
integer | null

ID of the SSL certificate served for the alias.

Example:

890

active
boolean

Whether you have enabled the alias.

Possible values:

  • true – The alias is enabled.
  • false – The alias is paused and is not served.
Example:

true

enabled
boolean

Whether the alias is enabled by the system. Follows the state of the CDN resource.

Possible values:

  • true – The alias can be served.
  • false – The alias is not served because its CDN resource is not active.
Example:

true

status
enum<string>

Alias status.

Possible values:

  • inactive – The alias or its CDN resource is disabled; the alias is not served.
  • pending – The alias configuration has not reached the CDN yet.
  • http_only – The alias is served over HTTP only.
  • active – The alias is served over HTTP and HTTPS.
Available options:
inactive,
pending,
http_only,
active
Example:

"active"

ssl_status
enum<string> | null

Outcome of the certificate we manage for the alias.

Possible values:

  • pending – A certificate attempt is in progress, or was stopped by pausing the alias and starts again after it is resumed.
  • issued – The latest attempt succeeded.
  • failed – The latest attempt ended without a certificate.
  • null – No certificate is managed for the alias: the alias uses a certificate you provided, or is automated and has never opened an attempt.
Available options:
pending,
issued,
failed
Example:

"issued"

ssl_validity_not_after
string | null

Date and time when the served certificate expires (ISO 8601/RFC 3339 format, UTC). null while no certificate is served.

Example:

"2027-01-01T10:00:00Z"

created
string

Date and time when the alias was created (ISO 8601/RFC 3339 format, UTC).

Example:

"2026-09-01T10:00:00Z"

updated
string

Date and time when the alias was last changed (ISO 8601/RFC 3339 format, UTC).

Example:

"2026-09-01T10:05:00Z"