Certificates

PreviousBackend Services NextConfigs

Last updated 5 months ago

Was this helpful?

Get Certificate

Get a specific Certificate for a configuration

get

/api/v4.0/conf/{config}/certificates/{entry_id}

Path parameters

configConfigrequired

entry_idIdrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

500

{
  "links": [],
  "cert_body": "text",
  "expires": "2025-02-21",
  "id": "text",
  "issuer": "text",
  "le_auto_renew": true,
  "le_auto_replace": true,
  "le_hash": "",
  "private_key": "text",
  "subject": "text",
  "uploaded": "2025-02-21T18:02:44.608Z",
  "san": [
    "text"
  ]
}

Certificate was retrieved successfully

Delete Certificate

Delete an individual Certificate from the specified configuration

delete

/api/v4.0/conf/{config}/certificates/{entry_id}

Path parameters

configConfigrequired

entry_idIdrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

422

500

No body

Certificate deleted successfully

List Certificates

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

get

/api/v4.0/conf/{config}/certificates

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

500

{
  "total": 1,
  "items": [
    {
      "cert_body": "text",
      "expires": "2025-02-21",
      "id": "text",
      "issuer": "text",
      "le_auto_renew": true,
      "le_auto_replace": true,
      "le_hash": "",
      "private_key": "text",
      "subject": "text",
      "uploaded": "2025-02-21T18:02:44.608Z",
      "san": [
        "text"
      ]
    }
  ]
}

Certificates were retrieved successfully

Modify Certificate

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

put

/api/v4.0/conf/{config}/certificates/{entry_id}

Path parameters

configConfigrequired

entry_idIdrequired

Query parameters

le_auto_renewLe Auto Renew

le_auto_replaceLe Auto Replace

replace_cert_idReplace Cert Id

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

No body

Certificate modified successfully

Add Certificate

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.

post

/api/v4.0/conf/{config}/certificates/{entry_id}

Path parameters

configConfigrequired

entry_idIdrequired

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

Query parameters

domainsDomains

Body

cert_bodyCert Body

expiresExpires

idIdrequired

Unique id

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

issuerIssuer

le_auto_renewLe Auto Renew

le_auto_replaceLe Auto Replace

le_hashLe Hash

private_keyPrivate Key

subjectSubject

uploadedUploaded

sanSan

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/certificates/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"id":"","le_auto_renew":true,"le_auto_replace":true,"le_hash":"","provider_links":[]}'

201

422

{
  "message": "Successfully created entry"
}

Certificate created

Get Certificate Pfx

get

/api/v4.0/conf/{config}/certificates/{entry_id}/pfx

Path parameters

configConfigrequired

entry_idIdrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

422

500

text

Certificate's pfx retrieved successfully