Certificates

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

totalintegerOptionalExample: 1

500

Internal Server Error

application/json

get/api/v4.3/conf/{config}/certificates

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

{
  "total": 1,
  "items": [
    {
      "cert_body": "text",
      "exp_date": "2026-07-14",
      "id": "text",
      "issuer": "text",
      "le_auto_renew": true,
      "le_auto_replace": true,
      "le_hash": "",
      "name": "text",
      "private_key": "text",
      "san": [
        "text"
      ],
      "subject": "text",
      "upload_time": "2026-07-14T09:20:48.450Z",
      "revoked": false,
      "crl": [
        "text"
      ],
      "cdp": [
        "text"
      ],
      "side": "server"
    }
  ]
}

Get Certificate

get

Get a specific Certificate for a configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Certificate was retrieved successfully

application/json

cert_bodystringOptional

exp_datestring · dateOptional

idstringRequired

Unique id

Pattern: ^[A-Za-z0-9\-\_]*$

issuerstringOptional

le_auto_renewbooleanOptionalDefault: true

le_auto_replacebooleanOptionalDefault: true

le_hashstringOptionalDefault: ""

namestringOptional

Display name for the certificate. Can only contain letters, numbers, dashes, and underscores. If omitted, defaults to the certificate ID.

Pattern: ^[A-Za-z0-9\-\_]*$

private_keystringOptional

sanstring[]Optional

subjectstringOptional

upload_timestring · date-timeOptional

revokedbooleanOptionalDefault: false

crlstring[]Optional

Certificate Revocation List

Default: []

cdpstring[]Optional

Certificate Distribution Point

Default: []

sidestring · enumOptionalDefault: serverPossible values:

422

Validation Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/conf/{config}/certificates/{entry_id}

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

{
  "links": [
    {
      "link": "text",
      "provider": "text",
      "region": "text"
    }
  ],
  "cert_body": "text",
  "exp_date": "2026-07-14",
  "id": "text",
  "issuer": "text",
  "le_auto_renew": true,
  "le_auto_replace": true,
  "le_hash": "",
  "name": "text",
  "private_key": "text",
  "san": [
    "text"
  ],
  "subject": "text",
  "upload_time": "2026-07-14T09:20:48.450Z",
  "revoked": false,
  "crl": [
    "text"
  ],
  "cdp": [
    "text"
  ],
  "side": "server"
}

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

namestringOptional

Display name for the certificate. Can only contain letters, numbers, dashes, and underscores.

Pattern: ^[A-Za-z0-9\-\_]*$

Responses

200

Certificate modified successfully

No content

422

Validation Error

application/json

put/api/v4.3/conf/{config}/certificates/{entry_id}

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

No content

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

cert_bodystringOptional

exp_datestring · dateOptional

idstringRequired

Unique id

Pattern: ^[A-Za-z0-9\-\_]*$

issuerstringOptional

le_auto_renewbooleanOptionalDefault: true

le_auto_replacebooleanOptionalDefault: true

le_hashstringOptionalDefault: ""

namestringOptional

Display name for the certificate. Can only contain letters, numbers, dashes, and underscores. If omitted, defaults to the certificate ID.

Pattern: ^[A-Za-z0-9\-\_]*$

private_keystringOptional

sanstring[]Optional

subjectstringOptional

upload_timestring · date-timeOptional

revokedbooleanOptionalDefault: false

crlstring[]Optional

Certificate Revocation List

Default: []

cdpstring[]Optional

Certificate Distribution Point

Default: []

sidestring · enumOptionalDefault: serverPossible values:

Responses

201

Certificate created

application/json

messagestringRequired

Information about successful create operation

Example: Successfully created entry

422

Validation Error

application/json

post/api/v4.3/conf/{config}/certificates/{entry_id}

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

{
  "provider_links": [
    {
      "link": "text",
      "provider": "text",
      "region": "text"
    }
  ],
  "cert_body": "text",
  "exp_date": "2026-07-14",
  "id": "text",
  "issuer": "text",
  "le_auto_renew": true,
  "le_auto_replace": true,
  "le_hash": "",
  "name": "text",
  "private_key": "text",
  "san": [
    "text"
  ],
  "subject": "text",
  "upload_time": "2026-07-14T09:20:48.450Z",
  "revoked": false,
  "crl": [
    "text"
  ],
  "cdp": [
    "text"
  ],
  "side": "server"
}

{
  "message": "Successfully created entry"
}

Delete Certificate

delete

Delete an individual Certificate from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Certificate deleted successfully

No content

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

delete/api/v4.3/conf/{config}/certificates/{entry_id}

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

No content

Get Certificate PFX

get

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Certificate's PFX retrieved successfully

application/json

string · binaryOptional

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/conf/{config}/certificates/{entry_id}/pfx

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

binary

Get Certificate PEM

get

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Certificate's PEM retrieved successfully

application/x-pem-file

string · binaryOptional

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/conf/{config}/certificates/{entry_id}/pem

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

binary

PreviousBackend Services NextConfigs

Last updated 2 months ago

Was this helpful?