Skip to main content
POST
Create alias
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.customer.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 is served. ssl_id is required.
Example:

true

active
boolean

Whether the alias is enabled. Defaults to true. The alias is served once its certificate is ready.

Example:

true

Response

Successful.

id
integer

Alias ID.

Example:

123

cname
string

Alias hostname. Cannot be changed after creation.

Example:

"shop.customer.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 was added by you.
Example:

true

ssl_id
integer

ID of the SSL certificate served for the alias.

Example:

890

active
boolean

Whether you have enabled the alias. Enabling it does not by itself make it live: the alias is served only while status is active, ssl_issuing or ssl_error.

Possible values:

  • true – The alias is enabled and is served once its certificate is ready.
  • 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:

  • pending – The certificate has not been issued yet; the alias is not served.
  • active – The alias is served with its certificate.
  • ssl_issuing – A new certificate is being issued; the current one keeps being served.
  • ssl_error – Certificate issuance failed; a previously issued certificate keeps being served.
  • inactive – The alias or its CDN resource is disabled; the alias is not served.
Available options:
pending,
active,
ssl_issuing,
ssl_error,
inactive
Example:

"active"

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"