API reference¶
The client-facing API uses bearer API keys:
Client endpoints¶
| Method | Endpoint | Required scope |
|---|---|---|
GET |
/api/v1/certificates |
certificates:read |
GET |
/api/v1/certificates/{name} |
certificates:read |
GET |
/api/v1/certificates/{name}/versions |
certificates:read |
GET |
/api/v1/certificates/{name}/certificate.pem |
certificates:read |
GET |
/api/v1/certificates/{name}/chain.pem |
certificates:read |
GET |
/api/v1/certificates/{name}/fullchain.pem |
certificates:read |
GET |
/api/v1/certificates/{name}/private-key.pem |
private_keys:read |
POST |
/api/v1/certificates/{name}/renew |
renewals:trigger |
All certificate endpoints also enforce the API key’s certificate allowlist.
Public health endpoints¶
| Method | Endpoint |
|---|---|
GET |
/api/v1/health |
GET |
/api/v1/ready |
Administrator endpoints use browser sessions and are not available to API keys.