G-g-core
Aliases

Get alias certificate issuing details

Changed on

Get details about the latest Let's Encrypt certificate issuance attempt for an alias, including the CNAME records to create for domain validation and the state of each domain validation challenge. Returns attempts in all statuses.

While the alias is switching to a Let's Encrypt certificate, the attempt for the new certificate is returned.

get/cdn/aliases/{alias_id}/status

Request

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

Path parameters

alias_idinteger required

Alias ID.

Response

Successful.

idinteger

ID of the attempt to issue a Let's Encrypt certificate.

startedstring

Date when the process of issuing a Let's Encrypt certificate was started (ISO 8601/RFC 3339 format, UTC).

finishedstring nullable

Date when the process of issuing a Let's Encrypt certificate was finished (ISO 8601/RFC 3339 format, UTC).

The field is null if the issuing process is not finished.

activeboolean

Defines whether the Let's Encrypt certificate issuing process is active.

Possible values:

  • true – Issuing process is active.
  • false – Issuing process is completed.
attempts_countinteger

Number of attempts to issue the Let's Encrypt certificate.

next_attempt_timestring nullable

Time of the next scheduled attempt to issue the Let's Encrypt certificate (ISO 8601/RFC 3339 format, UTC).

reasonstring nullable

Why this attempt was opened.

Possible values:

  • initial – First attempt to issue a certificate.
  • renewal – A scheduled renewal of an existing certificate.
  • manual – Manually triggered, for example via a retry.
  • switch – Switching from your own certificate to a Let's Encrypt certificate.
  • extend – Extending the set of domains covered by the certificate.
challenge_typestring nullable

The domain validation method this attempt uses.

Possible values:

  • dns_01 – Validation via a DNS record.
  • http_01 – Validation via an HTTP request.
requested_domainsstring[] nullable

Domains this attempt requested a certificate for.

validation_statestring

State of the domain validation for this attempt.

Possible values:

  • PENDING – Validation has not started yet.
  • AWAITING_CNAME – Waiting for the CNAME records below to be created.
  • VALIDATING – Validation is in progress.
  • COMPLETED – Validation succeeded.
  • FAILED – Validation did not succeed.
resourceinteger nullable

Always null for an alias.

Example response

{
  "id": 1,
  "statuses": [
    {
      "id": 1,
      "status": "DONE",
      "created": "2021-10-29T13:21:01.550849Z",
      "retry_after": "2024-01-01T10:00:00Z"
    }
  ],
  "latest_status": {
    "id": 1,
    "status": "DONE",
    "created": "2021-10-29T13:21:01.550849Z",
    "retry_after": "2024-01-01T10:00:00Z"
  },
  "started": "2021-10-29T13:20:56.543678Z",
  "finished": "2021-10-29T13:21:01.550849Z",
  "attempts_count": 1,
  "next_attempt_time": "2021-10-29T13:21:01.550849Z",
  "reason": "initial",
  "challenge_type": "dns_01",
  "requested_domains": [
    "shop.example.com"
  ],
  "challenges": [
    {
      "domain": "shop.example.com",
      "challenge_type": "http_01",
      "state": "invalid",
      "error": "A 404 error occurred when attempting to connect to the validation URL."
    }
  ],
  "validation_state": "AWAITING_CNAME",
  "cname_records": [
    {
      "cname_name": "_acme-challenge.shop.example.com",
      "cname_target": "0a1b2c3d4e5f6789.le-challenges.example.net"
    }
  ]
}

Changes

  • d034c0d6d6ffRevision changes
    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list 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

  • 9b685d687b49Revision changes
    • info

      endpoint added