Certificate Actions

Get all Actions for a Certificate

Returns all Action objects for a Certificate. You can code the results by using the sort URI parameter, and filter them with the status parameter.

Only type managed Certificates can have Actions. For type uploaded Certificates the actions key actions will always contain an empty array.

HTTP Request

GET /certificates/{id}/actions

Path Parameters

id integer required

ID of the Resource
Query Parameters

sort string

Possible enum values:

id id:asc id:desc command command:asc command:desc status status:asc status:desc progress progress:asc progress:desc started started:asc started:desc finished finished:asc finished:desc

Can be used multiple times

Response

Retry Issuance or Renewal

Retry a failed Certificate issuance or renewal.

Call specific error code

Code Description
caa_record_does_not_allow_ca

CAA record does not allow certificate authority
ca_dns_validation_failed

Certificate Authority: DNS validation failed
ca_too_many_authorizations_failed_recently

Certificate Authority: Too many authorizations failed recently
ca_too_many_certificates_issued_for_registered_domain

Certificate Authority: Too many certificates issued for registered domain
ca_too_many_duplicate_certificates

Certificate Authority: Too many duplicate certificates
could_not_verify_domain_delegated_to_zone

Could not verify domain delegated to zone
dns_zone_not_found

DNS zone not found
dns_zone_is_secondary_zone

DNS zone is a secondary zone

Example curl

curl \
    -H "Authorization: Bearer $API_TOKEN" \
    'https://api.hetzner.cloud/v1/certificates/{id}/actions'

Example curl

Content-Type: application/json
Status: 200

Response sample

{
  "actions": [
    {
      "command": "issue_certificate",
      "error": {
        "code": "action_failed",
        "message": "Action failed"
      },
      "finished": "2021-01-30T23:57:00+00:00",
      "id": 14,
      "progress": 100,
      "resources": [
        {
          "id": 896,
          "type": "certificate"
        }
      ],
      "started": "2021-01-30T23:55:00+00:00",
      "status": "success"
    }
  ]
}

Example curl

curl \
    -H "Authorization: Bearer $API_TOKEN" \
    'https://api.hetzner.cloud/v1/certificates/{id}/actions'

Example curl

Content-Type: application/json
Status: 200

Response sample

{
  "actions": [
    {
      "command": "issue_certificate",
      "error": {
        "code": "action_failed",
        "message": "Action failed"
      },
      "finished": "2021-01-30T23:57:00+00:00",
      "id": 14,
      "progress": 100,
      "resources": [
        {
          "id": 896,
          "type": "certificate"
        }
      ],
      "started": "2021-01-30T23:55:00+00:00",
      "status": "success"
    }
  ]
}