Skip to main content
POST
/
platform
/
recovery-point
Create recovery point
curl --request POST \
  --url https://api.rootkey.ai/api-v1/platform/recovery-point \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Full Backup 2026-07-03",
  "vaults": [
    "<string>"
  ],
  "timeRange": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  }
}
'
{
  "password": "AB12-CdEfGhIjKlMn-OpQrStUvWxYz-AaBbCcDdEeFf"
}

Authorizations

​
x-api-key
string
header
required

ROOTKey API key (rk_live_... for production, rk_test_... for the test network).

Body

application/json
​
name
string
required
Example:

"Full Backup 2026-07-03"

​
scope
enum<string>
required

'global' includes all org vaults; 'partial' requires vaults

Available options:
global,
partial
​
vaults
string[]

Vault addresses (required when scope='partial')

​
timeRange
object

Response

Recovery point creation accepted

​
password
string

One-time decryption password for the resulting archive

Example:

"AB12-CdEfGhIjKlMn-OpQrStUvWxYz-AaBbCcDdEeFf"