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

Get the Firehose configuration for streaming audit events

Request

Get the Firehose configuration for streaming audit events

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

Responses

Bodyapplication/json
streamNamestring(Firehose stream name)required

Firehose stream name

Example: "audit-logs-stream"
regionstring(Firehose region)required

Firehose region

Example: "eu-west-2"
assumeRoleArnstring(ARN of the role to assume for Firehose access)required

ARN of the role for the Palisade auditor to assume for Firehose access. Must have firehose:PutRecordBatch permissions on the stream.

Example: "arn:aws:iam::123456789012:role/my-audit-logs-role"
statusobject(v2FirehoseConfigurationStatus)required
status.​statestring(v2FirehoseConfigurationState)required
Enum"FIREHOSE_CONFIG_STATE_PENDING""FIREHOSE_CONFIG_STATE_ENABLED""FIREHOSE_CONFIG_STATE_DISABLED"
status.​lastErrorstring

Last error message if any

Example: "User: arn:aws:iam::663932549156:user/audit-service is not authorized to perform: sts:AssumeRole"
status.​lastErrorAtstring(date-time)

Timestamp of the last error

Example: "2022-03-29T10:22:22.420Z"
status.​consecutiveFailuresinteger(int32)required

Number of consecutive failures

Example: 3
status.​successfulUploadsinteger(int32)required

Total number of successful uploads

Example: 120
status.​failedUploadsinteger(int32)required

Total number of failed uploads

Example: 30
Response
application/json
{
  "streamName": "audit-logs-stream",
  "region": "eu-west-2",
  "assumeRoleArn": "arn:aws:iam::123456789012:role/my-audit-logs-role",
  "status": {
    "state": "FIREHOSE_CONFIG_STATE_PENDING",
    "lastError": "User: arn:aws:iam::663932549156:user/audit-service is not authorized to perform: sts:AssumeRole",
    "lastErrorAt": "2022-03-29T10:22:22.420Z",
    "consecutiveFailures": 3,
    "successfulUploads": 120,
    "failedUploads": 30
  }
}

Set the Firehose configuration for streaming audit events

Request

Set the Firehose configuration for streaming audit events

Security
TokenAuth
Bodyapplication/jsonrequired
streamNamestring(Firehose stream name)required

Firehose stream name

Example: "audit-logs-stream"
regionstring(Firehose region)required

Firehose region

Example: "eu-west-2"
assumeRoleArnstring(ARN of the role to assume for Firehose access)required

ARN of the role for the Palisade auditor to assume for Firehose access. Must have firehose:PutRecordBatch permissions on the stream.

Example: "arn:aws:iam::123456789012:role/my-audit-logs-role"
enabledboolean(Whether to enable the Firehose stream)

Whether to enable the Firehose stream. Set to false to temporarily disable without deleting the configuration. Defaults to true (enabled/pending).

Example: true
curl -i -X PUT \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/audit/firehose/configuration \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "streamName": "audit-logs-stream",
    "region": "eu-west-2",
    "assumeRoleArn": "arn:aws:iam::123456789012:role/my-audit-logs-role",
    "enabled": true
  }'

Responses

Bodyapplication/json
streamNamestring(Firehose stream name)required

Firehose stream name

Example: "audit-logs-stream"
regionstring(Firehose region)required

Firehose region

Example: "eu-west-2"
assumeRoleArnstring(ARN of the role to assume for Firehose access)required

ARN of the role for the Palisade auditor to assume for Firehose access. Must have firehose:PutRecordBatch permissions on the stream.

Example: "arn:aws:iam::123456789012:role/my-audit-logs-role"
statusobject(v2FirehoseConfigurationStatus)required
status.​statestring(v2FirehoseConfigurationState)required
Enum"FIREHOSE_CONFIG_STATE_PENDING""FIREHOSE_CONFIG_STATE_ENABLED""FIREHOSE_CONFIG_STATE_DISABLED"
status.​lastErrorstring

Last error message if any

Example: "User: arn:aws:iam::663932549156:user/audit-service is not authorized to perform: sts:AssumeRole"
status.​lastErrorAtstring(date-time)

Timestamp of the last error

Example: "2022-03-29T10:22:22.420Z"
status.​consecutiveFailuresinteger(int32)required

Number of consecutive failures

Example: 3
status.​successfulUploadsinteger(int32)required

Total number of successful uploads

Example: 120
status.​failedUploadsinteger(int32)required

Total number of failed uploads

Example: 30
Response
application/json
{
  "streamName": "audit-logs-stream",
  "region": "eu-west-2",
  "assumeRoleArn": "arn:aws:iam::123456789012:role/my-audit-logs-role",
  "status": {
    "state": "FIREHOSE_CONFIG_STATE_PENDING",
    "lastError": "User: arn:aws:iam::663932549156:user/audit-service is not authorized to perform: sts:AssumeRole",
    "lastErrorAt": "2022-03-29T10:22:22.420Z",
    "consecutiveFailures": 3,
    "successfulUploads": 120,
    "failedUploads": 30
  }
}

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