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

fileNameFilenamerequired

passwordPasswordrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v4.0/tools/certificates/extractpfx' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"fileName":"text","password":"text"}'

200

422

500

200

No body

Request was successful

Get Planet DNS information

Get DNS zone ID and predefined records

get

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

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/tools/dns-information'

200

400

500

200

No body

Successfully retrieved DNS information

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

configConfigrequired

Body

nameName

urlUrl

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v4.0/tools/publish/{config}' \
  --header 'Content-Type: application/json' \
  --data '[{}]'

200

400

422

500

503

200

{
  "message": "Successfully updated entry"
}

Configuration published successfully