Certificates
Get a list of the planet's certificates for a configuration
Certificates were retrieved successfully
Internal Server Error
GET /api/v4.0/conf/{config}/certificates HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"cert_body": "text",
"expires": "2025-08-20",
"id": "text",
"issuer": "text",
"le_auto_renew": true,
"le_auto_replace": true,
"le_hash": "",
"private_key": "text",
"san": [
"text"
],
"subject": "text",
"uploaded": "2025-08-20T10:16:11.463Z",
"revoked": false,
"crl": [
"text"
],
"cdp": [
"text"
],
"side": "server"
}
]
}
Get a specific Certificate for a configuration
Certificate was retrieved successfully
Validation Error
Internal Server Error
GET /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"links": [
{
"link": "text",
"provider": "text",
"region": "text"
}
],
"cert_body": "text",
"expires": "2025-08-20",
"id": "text",
"issuer": "text",
"le_auto_renew": true,
"le_auto_replace": true,
"le_hash": "",
"private_key": "text",
"san": [
"text"
],
"subject": "text",
"uploaded": "2025-08-20T10:16:11.463Z",
"revoked": false,
"crl": [
"text"
],
"cdp": [
"text"
],
"side": "server"
}
Change settings for a specific certificate. ("le_" parameters refer to Let's Encrypt.)
true
true
Certificate modified successfully
Validation Error
PUT /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host:
Accept: */*
No content
Create new certificate for a specific list of domains. Generate new certificate or upload existing one based on input parameters. "le_" parameters refer to Let's Encrypt.
(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
[]
{"id":"","le_auto_renew":true,"le_auto_replace":true,"le_hash":"","provider_links":[]}
Certificate created
Validation Error
POST /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 350
{
"provider_links": [
{
"link": "text",
"provider": "text",
"region": "text"
}
],
"cert_body": "text",
"expires": "2025-08-20",
"id": "text",
"issuer": "text",
"le_auto_renew": true,
"le_auto_replace": true,
"le_hash": "",
"private_key": "text",
"san": [
"text"
],
"subject": "text",
"uploaded": "2025-08-20T10:16:11.463Z",
"revoked": false,
"crl": [
"text"
],
"cdp": [
"text"
],
"side": "server"
}
{
"message": "Successfully created entry"
}
Delete an individual Certificate from the specified configuration
Certificate deleted successfully
Input Error
Validation Error
Internal Server Error
DELETE /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host:
Accept: */*
No content
Certificate's PEM retrieved successfully
Input Error
Validation Error
Internal Server Error
GET /api/v4.0/conf/{config}/certificates/{entry_id}/pem HTTP/1.1
Host:
Accept: */*
binary
Certificate's PFX retrieved successfully
Input Error
Validation Error
Internal Server Error
GET /api/v4.0/conf/{config}/certificates/{entry_id}/pfx HTTP/1.1
Host:
Accept: */*
binary
Last updated
Was this helpful?