Skip to main content
GET
Get aliases list
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

Query Parameters

resource_id
integer

CDN resource ID. Only aliases of this CDN resource are returned.

resource_id__in
string

Comma-separated list of CDN resource IDs.

status
enum<string>

Alias status. 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"

status__in
string

Comma-separated list of alias statuses.

automated
boolean

How the alias certificate is managed.

Possible values:

  • true – Certificate is issued and renewed automatically.
  • false – Certificate was added by a user.
ssl_id
integer

SSL certificate ID. Only aliases linked to this certificate are returned.

cname
string

Hostname substring, case-insensitive.

cname_startswith
string

Hostname prefix, case-insensitive.

cname_endswith
string

Hostname suffix, case-insensitive.

Search by alias ID or hostname.

ordering
string

Field to sort by. Prefix with - for descending order.

Possible values: id, cname, status, created, updated, resource_id.

limit
integer

Maximum number of items to return in the response. Cannot exceed 1000.

Required range: 1 <= x <= 1000
offset
integer

Number of items to skip from the beginning of the list.

Required range: x >= 0

Response

Successful.

count
integer
required

Total number of items.

next
string | null
required

URL to the next page of results. Null if current page is the last one.

previous
string | null
required

URL to the previous page of results. Null if current page is the first one.

results
object[]
required

List of items on the current page.