Certificates

List Certificates

get

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

Path parameters

configstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/certificates'

200

500

200

{
  "total": 1,
  "items": [
    {
      "cert_body": "text",
      "expires": "2025-04-03",
      "id": "text",
      "issuer": "text",
      "le_auto_renew": true,
      "le_auto_replace": true,
      "le_hash": "text",
      "private_key": "text",
      "san": [
        "text"
      ],
      "subject": "text",
      "uploaded": "2025-04-03T05:52:07.768Z",
      "revoked": true,
      "crl": [
        "text"
      ],
      "cdp": [
        "text"
      ],
      "side": "client"
    }
  ]
}

Certificates were retrieved successfully

Get Certificate

get

Get a specific Certificate for a configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/certificates/{entry_id}'

200

422

500

200

{
  "links": [
    {
      "link": "text",
      "provider": "text",
      "region": "text"
    }
  ],
  "cert_body": "text",
  "expires": "2025-04-03",
  "id": "text",
  "issuer": "text",
  "le_auto_renew": true,
  "le_auto_replace": true,
  "le_hash": "text",
  "private_key": "text",
  "san": [
    "text"
  ],
  "subject": "text",
  "uploaded": "2025-04-03T05:52:07.768Z",
  "revoked": true,
  "crl": [
    "text"
  ],
  "cdp": [
    "text"
  ],
  "side": "client"
}

Certificate was retrieved successfully

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_renewboolean · default: trueoptional

le_auto_replaceboolean · default: trueoptional

replace_cert_idstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/certificates/{entry_id}'

200

422

200

No body

Certificate modified successfully

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_idstringrequired

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

Query parameters

domainsstring[] · default: []optional

Body

all of · default: {"id":"","le_auto_renew":true,"le_auto_replace":true,"le_hash":"","provider_links":[]}optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/certificates/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "provider_links": [
      {
        "link": "text",
        "provider": "text",
        "region": "text"
      }
    ],
    "cert_body": "text",
    "expires": "2025-04-03",
    "id": "text",
    "issuer": "text",
    "le_auto_renew": true,
    "le_auto_replace": true,
    "le_hash": "text",
    "private_key": "text",
    "san": [
      "text"
    ],
    "subject": "text",
    "uploaded": "2025-04-03T05:52:07.768Z",
    "revoked": true,
    "crl": [
      "text"
    ],
    "cdp": [
      "text"
    ],
    "side": "client"
  }'

201

422

201

{
  "message": "Successfully created entry"
}

Certificate created

Delete Certificate

delete

Delete an individual Certificate from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/certificates/{entry_id}'

200

400

422

500

200

No body

Certificate deleted successfully

Get Certificate PEM

get

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/x-pem-file

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/certificates/{entry_id}/pem'

200

400

422

500

200

binary

Certificate's PEM retrieved successfully

Get Certificate PFX

get

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/certificates/{entry_id}/pfx'

200

400

422

500

200

binary

Certificate's PFX retrieved successfully