Get aliases list

Get information about aliases.

The response is always paginated.

GET /cdn/aliases

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cdn.aliases.list()
page = page.results[0]
print(page.id)

200

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 123,
      "cname": "shop.example.com",
      "resource_id": 4567,
      "automated": true,
      "challenge_type": "http_01",
      "ssl_id": null,
      "active": true,
      "enabled": true,
      "status": "http_only",
      "ssl_status": "pending",
      "ssl_validity_not_after": null,
      "created": "2026-09-01T10:00:00Z",
      "updated": "2026-09-01T10:00:00Z"
    }
  ]
}

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.

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"

status__in · string

Comma-separated list of alias statuses.

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_status__in · string

Comma-separated list of certificate outcomes.

ssl_validity_not_after_lte · string

Only aliases whose served certificate expires at or before this date and time (ISO 8601/RFC 3339 format, UTC).

ssl_validity_not_after_gte · string

Only aliases whose served certificate expires at or after this date and time (ISO 8601/RFC 3339 format, UTC).

automated · boolean

How the alias certificate is managed.

Possible values:

• true – A Let's Encrypt certificate is issued and renewed automatically.
• false – The certificate was added by you.

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 · string

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

200

application/json

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.

Show child attributes