Tools

Extract Certificate from PFX File

When given a PFX file, extracts and returns the certificate body and private key

POST/api/v4.0/tools/certificates/extractpfx

Body

multipart/form-data

fileName*Filename

password*Password

Response

200422500

Request was successful

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/tools/certificates/extractpfx', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "fileName": "binary",
      "password": "text"
    }),
});
const data = await response.json();

Response

422500

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

Get Planet DNS information

Get DNS zone ID and predefined records

GET/api/v4.0/tools/dns-information

Response

200400500

Successfully retrieved DNS information

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/tools/dns-information', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400500

{
  "message": "text"
}

Publish

Publish the current version of the specified configuration to the system storage bucket. By default, the name and url of the bucket are 'prod' and 'gs://rbz-$PLANETNAME-config/prod'. These values are also available in the console; navigate to System -> System DB -> select the system namespace -> publishinfo -> the buckets settings. Also, only one publish operation can occur at a time. If a 503 error is received, the previous operation has not yet finished, so the publish command should be resent until it is successful.

PUT/api/v4.0/tools/publish/{config}

Path parameters

config*Config

Body

application/json

nameName

urlUrl

Response

200400422500503

Configuration published successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/tools/publish/{config}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {}
    ]),
});
const data = await response.json();

Response

200400422500503

{
  "message": "Successfully updated entry"
}