Skip to main content
GET
Get alias certificate issuing details
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

Path Parameters

alias_id
integer
required

Alias ID.

Response

Successful.

id
integer

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

Example:

1

statuses
object[]

Detailed information about attempts to issue a Let's Encrypt certificate.

latest_status
object | null

Detailed information about last attempt to issue a Let's Encrypt certificate.

The field is null until the first attempt of the issuing process has been recorded.

started
string

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

Example:

"2021-10-29T13:20:56.543678Z"

finished
string | null

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.

Example:

"2021-10-29T13:21:01.550849Z"

active
boolean

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

Possible values:

  • true - Issuing process is active.
  • false - Issuing process is completed.
Example:

false

attempts_count
integer

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

Example:

1

next_attempt_time
string | null

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

Example:

"2021-10-29T13:21:01.550849Z"

resource
integer

CDN resource ID.

Example:

1

reason
string | null

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

"initial"

challenge_type
string | null

The domain validation method this attempt uses.

Possible values:

  • dns_01 - Validation via a DNS record.
  • http_01 - Validation via an HTTP request.
Example:

"dns_01"

requested_domains
string[] | null

Domains this attempt requested a certificate for.

Example:
validation_state
string

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

"AWAITING_CNAME"

cname_records
object[]

CNAME records to create so Let's Encrypt domain validation can complete for the alias hostname.