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.
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.
/api/v2/acme-accountsList ACME accounts
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
page | integer | Page number, starting from 1 |
page_size | integer | Items per page |
sort | string | Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id` |
tenant_id | integer | Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data |
ca | string | Only list accounts of this CA. |
/api/v2/acme-accountsCreate ACME account
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
tenant_id | integer | 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
| Field | Type | Description |
|---|---|---|
api_key | string | Mask of the ZeroSSL REST API key (`****abcd`); empty = not set. The key is stored encrypted and never returned in plaintext. |
caRequired | string | CA that issues certificates: lets = Let's Encrypt; zerossl = ZeroSSL. |
directory | string | ACME directory URL; empty = the CA's URL in the controller's acme.directories (the production URL by default). |
eab_hmac | string | Masked (last 4 chars shown as `****abcd` when 16+ chars, otherwise `********`); plaintext is never returned. |
eab_kid | string | EAB key ID (used by ZeroSSL). |
email | string | |
enabled | boolean | Whether enabled |
nameRequired | string | Name |
recheck | boolean | When true, re-check the stored API key; on success the account becomes usable again and certificates waiting on it are retried immediately. |
/api/v2/acme-accounts/{id}Get ACME account
Authentication: User (some parameters admin only)
/api/v2/acme-accounts/{id}Update ACME account
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
api_key | string | Mask of the ZeroSSL REST API key (`****abcd`); empty = not set. The key is stored encrypted and never returned in plaintext. |
caRequired | string | CA that issues certificates: lets = Let's Encrypt; zerossl = ZeroSSL. |
directory | string | ACME directory URL; empty = the CA's URL in the controller's acme.directories (the production URL by default). |
eab_hmac | string | Masked (last 4 chars shown as `****abcd` when 16+ chars, otherwise `********`); plaintext is never returned. |
eab_kid | string | EAB key ID (used by ZeroSSL). |
email | string | |
enabled | boolean | Whether enabled |
nameRequired | string | Name |
recheck | boolean | When true, re-check the stored API key; on success the account becomes usable again and certificates waiting on it are retried immediately. |
/api/v2/acme-accounts/{id}Delete ACME account
Authentication: User (some parameters admin only)
ACME accounts object
| Field | Type | Description |
|---|---|---|
api_checked_at | string | Time the API key was last checked. |
api_error | string | Last account-level error from checking the API key or issuing with it. |
api_key | string | Mask of the ZeroSSL REST API key (`****abcd`); empty = not set. The key is stored encrypted and never returned in plaintext. |
api_state | string | 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. |
ca | string | CA that issues certificates: lets = Let's Encrypt; zerossl = ZeroSSL. |
created_at | string | Created at |
directory | string | ACME directory URL; empty = the CA's URL in the controller's acme.directories (the production URL by default). |
eab_hmac | string | Masked (last 4 chars shown as `****abcd` when 16+ chars, otherwise `********`); plaintext is never returned. |
eab_kid | string | EAB key ID (used by ZeroSSL). |
email | string | |
enabled | boolean | Whether enabled |
id | integer | Record ID |
last_error | string | Last error |
name | string | Name |
recheck | boolean | When true, re-check the stored API key; on success the account becomes usable again and certificates waiting on it are retried immediately. |
status | string | new = not registered yet; registered = registered with the CA; error = registration failed (see last_error). |
tenant_id | integer | Owning tenant; null = platform account. |
updated_at | string | Updated at |
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.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"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"
}