G-g-core
Aliases

Get aliases list

Changed on

Get information about aliases.

The response is always paginated.

get/cdn/aliases

Request

  • Base URL
    https://api.gcore.com
  • URL
    https://api.gcore.com/cdn/aliases
  • Auth
    HTTP apikey

Query parameters

resource_idinteger

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

resource_id__instring

Comma-separated list of CDN resource IDs.

status'inactive' | 'pending' | 'http_only' | 'active'

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.
Example:active
status__instring

Comma-separated list of alias statuses.

ssl_status'pending' | 'issued' | 'failed' nullable

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.
Example:issued
ssl_status__instring

Comma-separated list of certificate outcomes.

ssl_validity_not_after_ltestring

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

ssl_validity_not_after_gtestring

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

automatedboolean

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_idinteger

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

cnamestring

Hostname substring, case-insensitive.

cname_startswithstring

Hostname prefix, case-insensitive.

cname_endswithstring

Hostname suffix, case-insensitive.

searchstring

Search by alias ID or hostname.

orderingstring

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

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

limitinteger

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

offsetinteger

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

Response

Successful.

countinteger required

Total number of items.

nextstring nullable required

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

previousstring nullable required

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

Example response

{
  "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"
    }
  ]
}

Changes

  • d034c0d6d6ffRevision changes
    • breaking

      removed the enum value ssl_error from the query request parameter status

    • breaking

      removed the enum value ssl_issuing from the query request parameter status

    • warning

      added the new http_only enum value to the /// response property for the response status

    • info

      added the new enum value http_only to the query request parameter status

    • info

      added the optional property /// to the response with the status

    • info

      removed the ssl_error enum value from the /// response property for the response status

    • info

      removed the ssl_issuing enum value from the /// response property for the response status

  • 9b685d687b49Revision changes
    • breaking

      the response property /// became nullable for the status

    • info

      added the new optional query request parameter ssl_status

    • info

      added the new optional query request parameter ssl_status__in

    • info

      added the new optional query request parameter ssl_validity_not_after_gte

    • info

      added the new optional query request parameter ssl_validity_not_after_lte

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status