Skip to content

Get a certificate attempt

GET
/api/organizations/{organizationId}/certificates/{certificateId}/attempts/{id}

Returns a single certificate attempt including its ordered pipeline steps. Attempts are read-only; they are created and updated by the certificate renewer / message handlers, not via the API. Inspect the steps array for the per-step status, timing, and error details of the underlying ACME or upload pipeline.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

organizationId*

Organization identifier

Type
string
Required
certificateId*

Certificate identifier

Type
string
Required
id*

certificate-attempt identifier

Type
string
Required

Responses

certificate-attempt resource

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"id": "9f1c2d3e-4b5a-6789-abcd-ef0123456789",
  
"type": "acme_renew",
  
"status": "succeeded",
  
"startedAt": "2026-07-01T09:15:00+00:00",
  
"finishedAt": "2026-07-01T09:16:42+00:00",
  
"errorCode": "acme_error",
  
"errorMessage": "DNS challenge validation failed",
  
"sansSnapshot": [
  
  
[
  
  
  
"example.com",
  
  
  
"www.example.com"
  
  
]
  
],
  
"issuedExpiresAt": "2026-09-29T09:16:42+00:00",
  
"steps": [
  
  
{
  
  
  
"id": "string",
  
  
  
"name": "string",
  
  
  
"status": "string",
  
  
  
"startedAt": "string",
  
  
  
"finishedAt": "string",
  
  
  
"message": "string",
  
  
  
"errorCode": "string",
  
  
  
"context": {
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI