Tools

Extract Certificate from PFX File

post

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

Body

multipart/form-data

fileNamestring · binaryRequired

passwordstringOptional

Required if the certificate is password-protected

Responses

200

Request was successful

application/json

Responseany

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/api/v4.3/tools/certificates/extractpfx

HTTPcURLJavaScriptPython

POST /api/v4.3/tools/certificates/extractpfx HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 39

{
  "fileName": "binary",
  "password": "text"
}

No content

Extract Certificate from PEM File

post

When given a PEM file, extracts and returns the certificate body

Body

multipart/form-data

fileNamestring · binaryRequired

passwordstringOptional

Required if the certificate is password-protected

Responses

200

Request was successful

application/json

Responseany

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/api/v4.3/tools/certificates/extractpem

HTTPcURLJavaScriptPython

POST /api/v4.3/tools/certificates/extractpem HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 39

{
  "fileName": "binary",
  "password": "text"
}

No content

Extract Certificate from DER File

post

When given a DER file, extracts and returns the certificate body

Body

multipart/form-data

fileNamestring · binaryRequired

passwordstringOptional

Required if the certificate is password-protected

Responses

200

Request was successful

application/json

Responseany

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/api/v4.3/tools/certificates/extractder

HTTPcURLJavaScriptPython

POST /api/v4.3/tools/certificates/extractder HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 39

{
  "fileName": "binary",
  "password": "text"
}

No content

Get Planet DNS information

get

Get DNS zone ID and predefined records

Responses

200

Successfully retrieved DNS information

application/json

Responseany

400

Input Error

application/json

500

Internal Server Error

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v4.3/tools/dns-information HTTP/1.1
Host: 
Accept: */*

No content

Publish

put

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.

Path parameters

configstringRequired

Bodyobject · ToolsPublishConfigPutRequest[]

application/json

namestringOptional

urlstringOptional

Responses

200

Configuration published successfully

application/json

400

Publish Configuration Validation Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

503

Publish Already In Progress

application/json

put

/api/v4.3/tools/publish/{config}

HTTPcURLJavaScriptPython

PUT /api/v4.3/tools/publish/{config} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 30

[
  {
    "name": "text",
    "url": "text"
  }
]

{
  "message": "Successfully updated entry"
}