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

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

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

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

List vaults

Request

List all vaults within the organization

Security

TokenAuth

Query

pageSizeinteger(int32)

The number of results to return per page (default 50, max 1000)

pageTokenstring

The token to retrieve the next page of results

correlationIdstring

Correlation ID for tracking various actions on the vault

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults?pageSize=0&pageToken=string&correlationId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json

filterobject(v2FilterResponse)

vaultsArray of objects(v2Vault)

Response

application/json

{
  "filter": {
    "previousPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "nextPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "total": 100
  },
  "vaults": [
    { … }
  ]
}

Create a vault

Request

Create a new vault

Security

TokenAuth

Bodyapplication/jsonrequired

namestringrequired

The name of the vault

Example: "Treasury vault"

descriptionstring

The description of the vault

Example: "A vault used by the treasury department"

externalIdstring

External ID of this vault, unique to the organization

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

correlationIdstring

Correlation ID for tracking correlating actions with this vault creation

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Treasury vault",
    "description": "A vault used by the treasury department",
    "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  }'

Responses

Bodyapplication/json

idstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

createdBystringrequired

The user ID that created the vault

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

createdAtstring(date-time)required

The date and time the vault was created

Example: "2022-03-29T10:22:22.420Z"

updatedAtstring(date-time)required

The date and time the vault was updated

Example: "2022-03-29T10:22:22.420Z"

namestringrequired

The name of the vault

Example: "Treasury vault"

descriptionstring

The description of the vault

Example: "A vault used by the treasury department"

externalIdstring

External ID of this vault, unique to the organization

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

correlationIdstring

Correlation ID for the vault

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

Response

application/json

{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "Treasury vault",
  "description": "A vault used by the treasury department",
  "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
}

Get a vault

Request

Get a vault by ID

Security

TokenAuth

Path

idstringrequired

The vault ID

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

Responses

Bodyapplication/json

idstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

createdBystringrequired

The user ID that created the vault

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

createdAtstring(date-time)required

The date and time the vault was created

Example: "2022-03-29T10:22:22.420Z"

updatedAtstring(date-time)required

The date and time the vault was updated

Example: "2022-03-29T10:22:22.420Z"

namestringrequired

The name of the vault

Example: "Treasury vault"

descriptionstring

The description of the vault

Example: "A vault used by the treasury department"

externalIdstring

External ID of this vault, unique to the organization

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

correlationIdstring

Correlation ID for the vault

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

Response

application/json

{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "Treasury vault",
  "description": "A vault used by the treasury department",
  "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
}

Update a vault

Request

Update a vault's name and description by ID

Security

TokenAuth

Path

idstringrequired

The vault ID

Bodyapplication/jsonrequired

namestringrequired

The name of the vault

Example: "Treasury vault"

descriptionstring

The description of the vault

Example: "A vault used by the treasury department"

correlationIdstring

Correlation ID for tracking various actions on the vault

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Treasury vault",
    "description": "A vault used by the treasury department",
    "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  }'

Responses

Bodyapplication/json

idstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

createdBystringrequired

The user ID that created the vault

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

createdAtstring(date-time)required

The date and time the vault was created

Example: "2022-03-29T10:22:22.420Z"

updatedAtstring(date-time)required

The date and time the vault was updated

Example: "2022-03-29T10:22:22.420Z"

namestringrequired

The name of the vault

Example: "Treasury vault"

descriptionstring

The description of the vault

Example: "A vault used by the treasury department"

externalIdstring

External ID of this vault, unique to the organization

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

correlationIdstring

Correlation ID for the vault

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

Response

application/json

{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "Treasury vault",
  "description": "A vault used by the treasury department",
  "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
}

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

Palisade API (2.0)

Addresses

Allow Addresses (deprecated)

API Credentials

Approvals

Approvers

Audit

Backup

Balances

Compliance

Counterparties

Devices

Information

MPC - Memberships

MPC - Quorums

MPC - Sessions

Organizations

Policies

Rates

Sweep Configurations

Tags

Transactions

Transactions - XRP

Users

Vaults

List vaults

Request

Responses

Was this page helpful?

Create a vault

Request

Responses

Was this page helpful?

Get a vault

Request

Responses

Was this page helpful?

Update a vault

Request

Responses

Was this page helpful?

Vault Tags

Wallets

Wallet Tags

Wallet Connect

Webhooks

Registry

Transactions - Sweep

Sweep Instances