Skip to content

Palisade API (2.0)

The Palisade API enables programmatic interaction with the various features of the Palisade platform

Click here for the API docs
Download OpenAPI description
palisade-api.json
palisade-api.yaml
Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/

Sandbox server (uses TESTNET data, private keys and accounts)

https://api.sandbox.palisade.co/

Palisade server (uses MAINNET data, private keys and accounts)

https://api.palisade.co/

Addresses

Used to manage addresses

Operations

Allow Addresses (deprecated)

Used to manage legacy allow addresses

API Credentials

Used to manage credentials

Operations

Approvals

Used to manage approvals

Operations

Approvers

Used to manage approvers

Operations

Audit

Used to manage configuration for audit

Operations

Backup

Used to manage backups

Operations

List all backup strategies

Request

Retrieves all backup strategies for the authenticated organization

Security
TokenAuth
curl -i -X GET \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/backup/strategies \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
strategiesArray of objects(List of backup strategies)

List of backup strategies

Response
application/json
{
  "strategies": [
    { … }
  ]
}

Create a new backup strategy

Request

Creates a new backup strategy with the provided name and backup keys

Security
TokenAuth
Bodyapplication/jsonrequired
namestring(Name of the backup strategy (2-64 characters))

Name of the backup strategy (2-64 characters)

recoveryPublicKeysArray of objects(List of backup keys - DER formatted, hex encoded RSA public keys (min 4096 bits))

List of backup keys - DER formatted, hex encoded RSA public keys (min 4096 bits)

s3Configobject(v2S3Config)
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/backup/strategies \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "recoveryPublicKeys": [
      {
        "name": "string",
        "publicKey": "string"
      }
    ],
    "s3Config": {
      "bucket": "string",
      "region": "string",
      "assumeRoleArn": "string"
    }
  }'

Responses

The created backup strategy

Bodyapplication/json
idstring(Unique identifier for the backup strategy (UUID v7))

Unique identifier for the backup strategy (UUID v7)

orgIdstring(Organization ID this backup strategy belongs to)

Organization ID this backup strategy belongs to

namestring(Name of the backup strategy (2-64 characters))

Name of the backup strategy (2-64 characters)

recoveryPublicKeysArray of objects(List of backup keys - DER formatted, hex encoded RSA public keys (min 4096 bits))

List of backup keys - DER formatted, hex encoded RSA public keys (min 4096 bits)

createdAtstring(date-time)(Creation timestamp)

Creation timestamp

createdBystring(User who created the backup strategy)

User who created the backup strategy

s3Configobject(v2S3Config)
Response
application/json
{
  "id": "string",
  "orgId": "string",
  "name": "string",
  "recoveryPublicKeys": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "s3Config": {
    "bucket": "string",
    "region": "string",
    "assumeRoleArn": "string"
  }
}

Get a backup strategy by ID

Request

Retrieves a specific backup strategy using its unique identifier

Security
TokenAuth
Path
idstringrequired

ID of the backup strategy to retrieve

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/backup/strategies/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The requested backup strategy

Bodyapplication/json
idstring(Unique identifier for the backup strategy (UUID v7))

Unique identifier for the backup strategy (UUID v7)

orgIdstring(Organization ID this backup strategy belongs to)

Organization ID this backup strategy belongs to

namestring(Name of the backup strategy (2-64 characters))

Name of the backup strategy (2-64 characters)

recoveryPublicKeysArray of objects(List of backup keys - DER formatted, hex encoded RSA public keys (min 4096 bits))

List of backup keys - DER formatted, hex encoded RSA public keys (min 4096 bits)

createdAtstring(date-time)(Creation timestamp)

Creation timestamp

createdBystring(User who created the backup strategy)

User who created the backup strategy

s3Configobject(v2S3Config)
Response
application/json
{
  "id": "string",
  "orgId": "string",
  "name": "string",
  "recoveryPublicKeys": [
    { … }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "s3Config": {
    "bucket": "string",
    "region": "string",
    "assumeRoleArn": "string"
  }
}

Balances

Used to view balances

Operations

Compliance

Used to manage compliance

Operations

Counterparties

Used to manage counterparties

Operations

Devices

Used to manage devices

Operations

Information

Used to view information about the platform

Operations

MPC - Memberships

Used to manage MPC memberships

Operations

MPC - Quorums

Used to manage MPC quorums

Operations

MPC - Sessions

Used to manage MPC sessions

Operations

Organizations

Used to manage organizations

Operations

Policies

Used to manage connections policies

Operations

Rates

Used to retrieve rates

Operations

Sweep Configurations

Used to manage sweep configurations

Operations

Tags

Used to manage organization tags

Operations

Transactions

Used to manage transactions

Operations

Transactions - XRP

Used to manage XRP specific transactions

Operations

Users

Used to manage users

Operations

Vaults

Used to manage vaults

Operations

Vault Tags

Used to manage vault tags

Operations

Wallets

Used to manage wallets

Operations

Wallet Tags

Used to manage wallet tags

Operations

Wallet Connect

Used to manage connections

Operations

Webhooks

Used to manage webhooks

Operations

Registry

Operations

Transactions - Sweep

Operations

Sweep Instances

Operations