Pagination
Query parameters
1-indexed page number. Values less than 1 are clamped to 1.
Items per page. Clamped to the range
[1, 100]. Requesting limit=500 returns 100 items.Optional zero-based offset. When provided, overrides
page. Useful for cursor-style paging.?page=3&limit=25 and ?offset=50&limit=25 return the same window.
List response envelope
The page of results.
Single-resource envelope
GET /:id, POST, PUT, and PATCH responses wrap one object in data:
DELETE returns 204 No Content with an empty body on success.
Error envelope
Errors always use the shape below and set an appropriate HTTP status code.HTTP status codes
| Code | When it appears |
|---|---|
200 OK | Successful GET, PUT, PATCH, or action POST |
201 Created | Successful POST that creates a resource |
204 No Content | Successful DELETE |
400 Bad Request | Validation failure, missing required fields, malformed IDs |
401 Unauthorized | No or invalid session / API key |
403 Forbidden | Authenticated but lacks permission |
404 Not Found | Resource does not exist or belongs to a different workspace |
409 Conflict | Duplicate resource |
429 Too Many Requests | Rate limit tripped on sensitive endpoints |
500 Internal Server Error | Unhandled server error; response includes a stable code |
503 Service Unavailable | Upstream dependency (PKI Core, ACME directory) is unreachable |
Retries
GET endpoints are safe to retry. Mutating endpoints are not idempotent by default — retrying may produce duplicate records. Wrap retries in your own idempotency layer (for example, deduplicate by common name and serial number).
Filtering and search
Filtering is per-endpoint. Common patterns:?status=active|expiring|expired|revokedon the certificates list?search=<term>for substring match on common name and issuer?type=<value>on discovery scans
Sorting
The default sort is by creation date descending. There is no publicsort= parameter — if you need a specific ordering, page through with limit=100 and sort client-side.
See also
- API overview — response envelopes and workspace context
- Authentication — status codes for auth failures