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/

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

List organization approvers

Request

Returns the list of approvers within the approval set configured for the organization and optionally source type

Security
TokenAuth
Query
sourceTypestring

The source type

Enum"TRANSACTION""DEVICE""API_CREDENTIAL""ALLOW_LIST_ENTRY""POLICY""USER""APPROVAL_GROUP""ADDRESS"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/approvers?sourceType=TRANSACTION' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
approvalGroupsArray of objects(v2ApprovalGroup)
Response
application/json
{
  "approvalGroups": [
    { … }
  ]
}

Update organization approvers

Request

Updates the list of approvers within the approval set configured for the organization and source type

Security
TokenAuth
Bodyapplication/jsonrequired
approversArray of stringsrequired

A list of users in the approval group

Example: ["ce4918bf-a199-4ce2-85a3-d0d296855384","ce4918bf-a199-4ce2-85a3-d0d296855384"]
requiredApproverCountinteger(int32)required

The required approver count

Example: 1
sourceTypestring(v2SourceType)required
Enum"TRANSACTION""DEVICE""API_CREDENTIAL""ALLOW_LIST_ENTRY""POLICY""USER""APPROVAL_GROUP""ADDRESS"
timeoutDurationstring

Approval timeout duration. Defaults to 1 hour (3600s) if not specified. Minimum 5 minutes, maximum 24 hours.

Example: "3600s"
curl -i -X PUT \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/approvers \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "approvers": [
      "ce4918bf-a199-4ce2-85a3-d0d296855384",
      "ce4918bf-a199-4ce2-85a3-d0d296855384"
    ],
    "requiredApproverCount": 1,
    "sourceType": "TRANSACTION",
    "timeoutDuration": "3600s"
  }'

Responses

Bodyapplication/json
approversArray of stringsrequired

A list of users in the approval group

Example: ["ce4918bf-a199-4ce2-85a3-d0d296855384","ce4918bf-a199-4ce2-85a3-d0d296855384"]
requiredApproverCountinteger(int32)required

The required approver count

Example: 1
sourceTypestring(v2SourceType)required
Enum"TRANSACTION""DEVICE""API_CREDENTIAL""ALLOW_LIST_ENTRY""POLICY""USER""APPROVAL_GROUP""ADDRESS"
timeoutDurationstring

Approval timeout duration. Defaults to 1 hour (3600s) if not specified. Minimum 5 minutes, maximum 24 hours.

Example: "3600s"
Response
application/json
{
  "approvers": [
    "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "ce4918bf-a199-4ce2-85a3-d0d296855384"
  ],
  "requiredApproverCount": 1,
  "sourceType": "TRANSACTION",
  "timeoutDuration": "3600s"
}

List eligible approvers

Request

Returns the list of eligible approvers

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

Responses

Bodyapplication/jsonArray [
userIdstringrequired

The user ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
deviceIdsArray of stringsrequired

The device IDs

Example: ["ce4918bf-a199-4ce2-85a3-d0d296855384","ce4918bf-a199-4ce2-85a3-d0d296855384"]
]
Response
application/json
[
  {
    "userId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "deviceIds": [ … ]
  }
]

List wallet approvers

Request

Returns the list of approvers within the approval set configured for the wallet and optionally source type

Security
TokenAuth
Path
idstringrequired

The wallet ID

Query
sourceTypestring

The source type

Enum"TRANSACTION""DEVICE""API_CREDENTIAL""ALLOW_LIST_ENTRY""POLICY""USER""APPROVAL_GROUP""ADDRESS"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/approvers/{id}?sourceType=TRANSACTION' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
approvalGroupsArray of objects(v2ApprovalGroup)
Response
application/json
{
  "approvalGroups": [
    { … }
  ]
}

Update wallet approvers

Request

Updates the list of approvers within the approval set configured for the wallet and source type

Security
TokenAuth
Path
idstringrequired

The wallet ID

Bodyapplication/jsonrequired
approversArray of stringsrequired

A list of users in the approval group

Example: ["ce4918bf-a199-4ce2-85a3-d0d296855384","ce4918bf-a199-4ce2-85a3-d0d296855384"]
requiredApproverCountinteger(int32)required

The required approver count

Example: 1
sourceTypestring(v2SourceType)required
Enum"TRANSACTION""DEVICE""API_CREDENTIAL""ALLOW_LIST_ENTRY""POLICY""USER""APPROVAL_GROUP""ADDRESS"
timeoutDurationstring

Approval timeout duration. Defaults to 1 hour (3600s) if not specified. Minimum 5 minutes, maximum 24 hours.

Example: "3600s"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/approvers/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "approvers": [
      "ce4918bf-a199-4ce2-85a3-d0d296855384",
      "ce4918bf-a199-4ce2-85a3-d0d296855384"
    ],
    "requiredApproverCount": 1,
    "sourceType": "TRANSACTION",
    "timeoutDuration": "3600s"
  }'

Responses

Bodyapplication/json
approversArray of stringsrequired

A list of users in the approval group

Example: ["ce4918bf-a199-4ce2-85a3-d0d296855384","ce4918bf-a199-4ce2-85a3-d0d296855384"]
requiredApproverCountinteger(int32)required

The required approver count

Example: 1
sourceTypestring(v2SourceType)required
Enum"TRANSACTION""DEVICE""API_CREDENTIAL""ALLOW_LIST_ENTRY""POLICY""USER""APPROVAL_GROUP""ADDRESS"
timeoutDurationstring

Approval timeout duration. Defaults to 1 hour (3600s) if not specified. Minimum 5 minutes, maximum 24 hours.

Example: "3600s"
Response
application/json
{
  "approvers": [
    "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "ce4918bf-a199-4ce2-85a3-d0d296855384"
  ],
  "requiredApproverCount": 1,
  "sourceType": "TRANSACTION",
  "timeoutDuration": "3600s"
}

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

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