Version 2.4.7.20261116085428 · latest

ACME accounts acme-accounts

CA accounts used for automatic issuance (Let's Encrypt, ZeroSSL). Registered with the CA on first issuance.

Pick an endpoint to see its example call on the right.

CertificatesAuthentication: User (some parameters admin only)5 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/acme-accountsList ACME accounts

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
sortstring Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_idinteger Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data
castring Only list accounts of this CA.
Values ["lets","zerossl"]
POST/api/v2/acme-accountsCreate ACME account

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
tenant_idinteger Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data

Request body application/json

FieldTypeDescription
api_keystring Mask of the ZeroSSL REST API key (`****abcd`); empty = not set. The key is stored encrypted and never returned in plaintext.
caRequiredstring CA that issues certificates: lets = Let's Encrypt; zerossl = ZeroSSL.
Values ["lets","zerossl"]
directorystring ACME directory URL; empty = the CA's URL in the controller's acme.directories (the production URL by default).
eab_hmacstring Masked (last 4 chars shown as `****abcd` when 16+ chars, otherwise `********`); plaintext is never returned.
eab_kidstring EAB key ID (used by ZeroSSL).
emailstring Email
enabledboolean Whether enabled
nameRequiredstring Name
recheckboolean When true, re-check the stored API key; on success the account becomes usable again and certificates waiting on it are retried immediately.
GET/api/v2/acme-accounts/{id}Get ACME account

Authentication: User (some parameters admin only)

PUT/api/v2/acme-accounts/{id}Update ACME account

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
api_keystring Mask of the ZeroSSL REST API key (`****abcd`); empty = not set. The key is stored encrypted and never returned in plaintext.
caRequiredstring CA that issues certificates: lets = Let's Encrypt; zerossl = ZeroSSL.
Values ["lets","zerossl"]
directorystring ACME directory URL; empty = the CA's URL in the controller's acme.directories (the production URL by default).
eab_hmacstring Masked (last 4 chars shown as `****abcd` when 16+ chars, otherwise `********`); plaintext is never returned.
eab_kidstring EAB key ID (used by ZeroSSL).
emailstring Email
enabledboolean Whether enabled
nameRequiredstring Name
recheckboolean When true, re-check the stored API key; on success the account becomes usable again and certificates waiting on it are retried immediately.
DELETE/api/v2/acme-accounts/{id}Delete ACME account

Authentication: User (some parameters admin only)

ACME accounts object

FieldTypeDescription
api_checked_atstring Time the API key was last checked.
read-only
api_errorstring Last account-level error from checking the API key or issuing with it.
read-only
api_keystring Mask of the ZeroSSL REST API key (`****abcd`); empty = not set. The key is stored encrypted and never returned in plaintext.
read-only
api_statestring API key state: none = not set; ok = usable; blocked = account-level error (quota reached, unpaid, key rejected; retried after 6 hours or after a successful recheck); error = the key cannot be decrypted and must be re-entered.
read-onlyValues ["none","ok","blocked","error"]
castring CA that issues certificates: lets = Let's Encrypt; zerossl = ZeroSSL.
Values ["lets","zerossl"]
created_atstring Created at
read-only
directorystring ACME directory URL; empty = the CA's URL in the controller's acme.directories (the production URL by default).
eab_hmacstring Masked (last 4 chars shown as `****abcd` when 16+ chars, otherwise `********`); plaintext is never returned.
eab_kidstring EAB key ID (used by ZeroSSL).
emailstring Email
enabledboolean Whether enabled
idinteger Record ID
read-only
last_errorstring Last error
read-only
namestring Name
recheckboolean When true, re-check the stored API key; on success the account becomes usable again and certificates waiting on it are retried immediately.
statusstring new = not registered yet; registered = registered with the CA; error = registration failed (see last_error).
read-onlyValues ["new","registered","error"]
tenant_idinteger Owning tenant; null = platform account.
read-only
updated_atstring Updated at
read-only

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command