G-g-core
Aliases

Get alias details

Changed on
get/cdn/aliases/{alias_id}

Request

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

Path parameters

alias_idinteger required

Alias ID.

Response

Successful.

idinteger

Alias ID.

cnamestring

Alias hostname. Cannot be changed after creation.

resource_idinteger

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

automatedboolean

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.
challenge_type'dns_01' | 'http_01'

Domain validation method used to issue the Let's Encrypt certificate for the alias.

Possible values:

  • dns_01 – Validation via a CNAME record for _acme-challenge.<alias hostname>, shown in ssl_provisioning.acme_delegation.
  • http_01 – Validation via an HTTP request to the alias hostname. The alias hostname must point to your CDN CNAME, shown in ssl_provisioning.http_validation. The request is served with the settings of the alias's CDN resource, so they must not block or redirect /.well-known/acme-challenge/.
ssl_idinteger nullable

ID of the SSL certificate served for the alias.

activeboolean

Whether you have enabled the alias.

Possible values:

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

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.
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.
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.
ssl_validity_not_afterstring nullable

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

createdstring

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

updatedstring

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

Example response

{
  "id": 123,
  "cname": "shop.example.com",
  "resource_id": 4567,
  "automated": true,
  "challenge_type": "http_01",
  "ssl_id": 890,
  "active": true,
  "enabled": true,
  "status": "active",
  "ssl_status": "issued",
  "ssl_validity_not_after": "2027-01-01T10:00:00Z",
  "created": "2026-09-01T10:00:00Z",
  "updated": "2026-09-01T10:05:00Z",
  "ssl_provisioning": {
    "acme_delegation": {
      "cname_name": "_acme-challenge.shop.example.com",
      "cname_target": "0a1b2c3d4e5f6789.le-challenges.example.net"
    },
    "http_validation": {
      "cname_name": "_acme-challenge.shop.example.com",
      "cname_target": "0a1b2c3d4e5f6789.le-challenges.example.net"
    }
  }
}

Changes

  • d034c0d6d6ffRevision changes
    • breaking

      the // response's property type changed from object to no type for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

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

    • info

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

    • info

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

    • info

      added to the // response property allOf list for the response 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's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status