Certificates

Get Certificate

Get a specific Certificate for a configuration

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

Path parameters

config*Config

entry_id*Id

Response

200422500

Certificate was retrieved successfully

Body

application/json

cert_bodyCert Body

expiresExpires

id*Id

Unique id

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

issuerIssuer

le_auto_renewLe Auto Renew

le_auto_replaceLe Auto Replace

le_hashLe Hash

private_keyPrivate Key

sanSan

subjectSubject

uploadedUploaded

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422500

{
  "links": [
    {
      "link": "text",
      "provider": "text",
      "region": "text"
    }
  ]
}

Delete Certificate

Delete an individual Certificate from the specified configuration

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

Path parameters

config*Config

entry_id*Id

Response

200400422500

Certificate deleted successfully

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400422500

{
  "message": "text"
}

List Certificates

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

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

Path parameters

config*Config

Response

200500

Certificates were retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of Certificate response

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/certificates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "total": 1,
  "items": [
    {
      "links": [
        {
          "link": "text",
          "provider": "text",
          "region": "text"
        }
      ]
    }
  ]
}

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

config*Config

entry_id*Id

Query parameters

Response

200422

Certificate modified successfully

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

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

config*Config

entry_id*Id

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

Query parameters

Body

application/json

cert_bodyCert Body

expiresExpires

id*Id

Unique id

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

issuerIssuer

le_auto_renewLe Auto Renew

le_auto_replaceLe Auto Replace

le_hashLe Hash

private_keyPrivate Key

sanSan

subjectSubject

uploadedUploaded

Response

201422

Certificate created

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

Get Certificate Pfx

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

Path parameters

config*Config

entry_id*Id

Response

200400422500

Certificate's pfx retrieved successfully

Body

application/json

Response Export Api Certificates PFXG

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/certificates/{entry_id}/pfx', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400422500

binary