Skip to content

List certificate attempts

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

Returns the issuance, renewal, and upload attempts recorded for a certificate, newest first (25 per page). Each attempt captures the lifecycle status, type, timing, and any error of a single certificate operation. Attempts are read-only - they are created and maintained by the certificate renewer / message handlers, not via the API. The per-step breakdown is omitted from this collection view; fetch a single attempt to see its steps.

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

Query Parameters

page

The collection page number

Type
integer
Default
1
itemsPerPage

The number of items per page

Type
integer
Default
25
Minimum
0
Maximum
100

Responses

certificate-attempt collection

JSON
{
  
"totalItems": 0,
  
"search": {
  
  
"@type": "string",
  
  
"template": "string",
  
  
"variableRepresentation": "string",
  
  
"mapping": [
  
  
  
{
  
  
  
  
"@type": "string",
  
  
  
  
"variable": "string",
  
  
  
  
"property": "string",
  
  
  
  
"required": true
  
  
  
}
  
  
]
  
},
  
"view": {
  
  
"@id": "string",
  
  
"@type": "string",
  
  
"first": "string",
  
  
"last": "string",
  
  
"previous": "string",
  
  
"next": "string"
  
},
  
"member": [
  
  
{
  
  
  
"@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"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI