Certificates

PreviousBackend Services NextConfigs

Last updated 2 months ago

Was this helpful?

List Certificates

get

Get a list of the planet's certificates for a configuration

Path parameters

configstringRequired

Responses

200

Certificates were retrieved successfully

application/json

500

Internal Server Error

application/json

get

GET /api/v4.0/conf/{config}/certificates HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "cert_body": "text",
      "expires": "2025-05-12",
      "id": "text",
      "issuer": "text",
      "le_auto_renew": true,
      "le_auto_replace": true,
      "le_hash": "text",
      "private_key": "text",
      "san": [
        "text"
      ],
      "subject": "text",
      "uploaded": "2025-05-12T15:49:28.387Z",
      "revoked": true,
      "crl": [
        "text"
      ],
      "cdp": [
        "text"
      ],
      "side": "client"
    }
  ]
}

Get Certificate

get

Get a specific Certificate for a configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Certificate was retrieved successfully

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get

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-05-12",
  "id": "text",
  "issuer": "text",
  "le_auto_renew": true,
  "le_auto_replace": true,
  "le_hash": "text",
  "private_key": "text",
  "san": [
    "text"
  ],
  "subject": "text",
  "uploaded": "2025-05-12T15:49:28.387Z",
  "revoked": true,
  "crl": [
    "text"
  ],
  "cdp": [
    "text"
  ],
  "side": "client"
}

Modify Certificate

put

Change settings for a specific certificate. ("le_" parameters refer to Let's Encrypt.)

Path parameters

configstringRequired

entry_idstringRequired

Query parameters

le_auto_renewbooleanOptionalDefault: true

le_auto_replacebooleanOptionalDefault: true

replace_cert_idstringOptional

Responses

200

Certificate modified successfully

422

Validation Error

application/json

put

PUT /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host: 
Accept: */*

No content

Delete Certificate

delete

Delete an individual Certificate from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Certificate deleted successfully

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

delete

DELETE /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host: 
Accept: */*

No content

Get Certificate PEM

get

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Certificate's PEM retrieved successfully

application/x-pem-file

Responsestring · binary

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get

GET /api/v4.0/conf/{config}/certificates/{entry_id}/pem HTTP/1.1
Host: 
Accept: */*

binary

Get Certificate PFX

get

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Certificate's PFX retrieved successfully

application/json

Responsestring · binary

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get

GET /api/v4.0/conf/{config}/certificates/{entry_id}/pfx HTTP/1.1
Host: 
Accept: */*

binary

Add Certificate

post

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.

Path parameters

configstringRequired

entry_idstringRequiredPattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)

Query parameters

domainsstring[]OptionalDefault: []

Body

all ofOptionalDefault: {"id":"","le_auto_renew":true,"le_auto_replace":true,"le_hash":"","provider_links":[]}

Responses

201

Certificate created

application/json

422

Validation Error

application/json

post

POST /api/v4.0/conf/{config}/certificates/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "provider_links": [
    {
      "link": "text",
      "provider": "text",
      "region": "text"
    }
  ],
  "cert_body": "text",
  "expires": "2025-05-12",
  "id": "text",
  "issuer": "text",
  "le_auto_renew": true,
  "le_auto_replace": true,
  "le_hash": "text",
  "private_key": "text",
  "san": [
    "text"
  ],
  "subject": "text",
  "uploaded": "2025-05-12T15:49:28.387Z",
  "revoked": true,
  "crl": [
    "text"
  ],
  "cdp": [
    "text"
  ],
  "side": "client"
}

{
  "message": "Successfully created entry"
}