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

List all credentials

Request

List all credentials

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

Responses

Bodyapplication/jsonArray [
idstringrequired

The credential ID

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

The credential name

Example: "Treasury"
descriptionstring

The credential description

Example: "Credentials that belong to trading desk #1"
categorystring(v2Category)required
Enum"CONTROLS""WALLETS""TRANSACTIONS""AUDIT"
permissionsArray of stringsrequired

The credential permissions

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
createdBystringrequired

The ID of the user who created the credential

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

The ID of the organization who created the credential

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the credential was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the credential was updated

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

The credential client ID

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

The credential client secret

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

The credential active status

Example: true
statusstring(v2CredentialStatus)required
Enum"CREATED""ENABLED""DISABLED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""DELETION_APPROVAL_PENDING""DELETION_APPROVAL_COMPLETE"
proposedPermissionsArray of stringsrequired

The proposed credential permissions

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
allowedIpsArray of strings

List of IP addresses (in IP address or CIDR notation) that the credential is allowed to use

Example: ["88.9.2.1","88.10.2.1/0"]
]
Response
application/json
[
  {
    "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "name": "Treasury",
    "description": "Credentials that belong to trading desk #1",
    "category": "CONTROLS",
    "permissions": [ … ],
    "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdAt": "2022-03-29T10:22:22.420Z",
    "updatedAt": "2022-03-29T10:22:22.420Z",
    "clientId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "clientSecret": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "active": true,
    "status": "CREATED",
    "proposedPermissions": [ … ],
    "allowedIps": [ … ]
  }
]

Create credentials

Request

Create a set of API credentials

Security
TokenAuth
Bodyapplication/jsonrequired
namestringrequired

A helpful name to help identify the credentials

Example: "Treasury"
descriptionstring

A helpful description to help identify the credentials

Example: "Credentials that belong to trading desk #1"
categorystring(v2Category)required
Enum"CONTROLS""WALLETS""TRANSACTIONS""AUDIT"
permissionsArray of stringsrequired

The permissions that the credential will have

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
allowedIpsArray of strings

List of IP addresses (in IP address or CIDR notation) that the credential is allowed to use

Example: ["88.9.2.1","88.10.2.1/0"]
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/credentials \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Treasury",
    "description": "Credentials that belong to trading desk #1",
    "category": "CONTROLS",
    "permissions": [
      "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
    ],
    "allowedIps": [
      "88.9.2.1",
      "88.10.2.1/0"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired

The credential ID

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

The credential name

Example: "Treasury"
descriptionstring

The credential description

Example: "Credentials that belong to trading desk #1"
categorystring(v2Category)required
Enum"CONTROLS""WALLETS""TRANSACTIONS""AUDIT"
permissionsArray of stringsrequired

The credential permissions

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
createdBystringrequired

The ID of the user who created the credential

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

The ID of the organization who created the credential

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the credential was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the credential was updated

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

The credential client ID

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

The credential client secret

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

The credential active status

Example: true
statusstring(v2CredentialStatus)required
Enum"CREATED""ENABLED""DISABLED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""DELETION_APPROVAL_PENDING""DELETION_APPROVAL_COMPLETE"
proposedPermissionsArray of stringsrequired

The proposed credential permissions

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
allowedIpsArray of strings

List of IP addresses (in IP address or CIDR notation) that the credential is allowed to use

Example: ["88.9.2.1","88.10.2.1/0"]
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "name": "Treasury",
  "description": "Credentials that belong to trading desk #1",
  "category": "CONTROLS",
  "permissions": [
    "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
  ],
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "clientSecret": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "active": true,
  "status": "CREATED",
  "proposedPermissions": [
    "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
  ],
  "allowedIps": [
    "88.9.2.1",
    "88.10.2.1/0"
  ]
}

List all credential info

Request

List all credential info

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

Responses

Bodyapplication/jsonArray [
idstringrequired

The credential ID

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

The ID of the organization who created the credential

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

The credential name

Example: "Treasury"
]
Response
application/json
[
  {
    "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "name": "Treasury"
  }
]

Client credentials exchange

Request

OAuth client credentials exchange for access token

Bodyapplication/jsonrequired
clientIdstringrequired

The client ID

Example: "jhYMYU4opaGhdsXuebOwQXqV0pZcGuph"
clientSecretstringrequired

The client ID

Example: "zjI4XChsnwMh8wvKQG2tVBLUI4k9JittZQGerUfHv0CiqZZ_5MofAfRQ15pnKY-B"
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/credentials/oauth/token \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "jhYMYU4opaGhdsXuebOwQXqV0pZcGuph",
    "clientSecret": "zjI4XChsnwMh8wvKQG2tVBLUI4k9JittZQGerUfHv0CiqZZ_5MofAfRQ15pnKY-B"
  }'

Responses

A successful response.

Bodyapplication/json
accessTokenstringrequired

The access token

Example: "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImxBMmpQWDd5NWZTR0tMWDFtMkpucyJ9.eyJodHRwczovL3BhbGlzYWRlLmNvIjp7ImRldmljZUlkIjpudWxsLCJvcmdhbml6YXRpb25JZCI6ImNlNDkxOGJmLWExOTktNGNlMi04NWEzLWQwZDI5Njg1NTM4NCIsInNpZ25hdHVyZVZlcmlmaWNhdGlvbktleSI6bnVsbCwidXNlcklkIjoiYTdkNzI2YTUtZjZlMC00ZmE2LWJiOGUtM2Q5OTNhZjY0MzUxIn0sImlzcyI6Imh0dHBzOi8vcGFsaXNhZGUtZGV2ZWxvcG1lbnQuZXUuYXV0aDAuY29tLyIsInN1YiI6IlVNbWZ5RWNPcnN3Szl4ODJvQWw0ZnpLRjlCTmRheW5KQGNsaWVudHMiLCJhdWQiOiJodHRwczovL2FwaS5wYWxpc2FkZS5jby8iLCJpYXQiOjE3MDQ5ODg0NDQsImV4cCI6MTcwNDk5MjA0NCwiYXpwIjoiVU1tZnlFY09yc3dLOXg4Mm9BbDRmektGOUJOZGF5bkoiLCJzY29wZSI6ImJhbGFuY2VzOnJlYWQ6b3JnOmlkPWNlNDkxOGJmLWExOTktNGNlMi04NWEzLWQwZDI5Njg1NTM4NDoqIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIiwicGVybWlzc2lvbnMiOlsiYmFsYW5jZXM6cmVhZDpvcmc6aWQ9Y2U0OTE4YmYtYTE5OS00Y2UyLTg1YTMtZDBkMjk2ODU1Mzg0OioiXX0.RdKm2CvCAJYDno4dCdQ-G8k4ia7oHnVFW7O9mrcPhxnBayKPa2kLPcDJbFineU2s_AIlCjp6-1Bx6gOTytNVI4hWpS8ho_QSkQVipDAltq06Lg0N__NYZG11ZaDwlC0MLC2zcTYwIZcHY2_cC5kwOQ5Dc4no_IFCPtU_UbepqXZuj9uJda-9vrLv0zFoKD7bKUQkSaDam7Qvq6J7Q-sKwu_8wZ3tfSLqk53ECLZn4d9sJnsWaXixoQd1s0w5qKDSwjRMLeB8rm2ATAR4r4FayCKrSYgAuaK0heoYS158x69ThtTWZJFi0gPf1yD2DpshiEAFWyv4mMkH7YVs-fi6_x"
scopestringrequired

The scope

Example: "balances:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
expiresIninteger(int64)required

The expiration time in seconds

Example: 3600
tokenTypestringrequired

The token type

Example: "Bearer"
Response
application/json
{
  "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImxBMmpQWDd5NWZTR0tMWDFtMkpucyJ9.eyJodHRwczovL3BhbGlzYWRlLmNvIjp7ImRldmljZUlkIjpudWxsLCJvcmdhbml6YXRpb25JZCI6ImNlNDkxOGJmLWExOTktNGNlMi04NWEzLWQwZDI5Njg1NTM4NCIsInNpZ25hdHVyZVZlcmlmaWNhdGlvbktleSI6bnVsbCwidXNlcklkIjoiYTdkNzI2YTUtZjZlMC00ZmE2LWJiOGUtM2Q5OTNhZjY0MzUxIn0sImlzcyI6Imh0dHBzOi8vcGFsaXNhZGUtZGV2ZWxvcG1lbnQuZXUuYXV0aDAuY29tLyIsInN1YiI6IlVNbWZ5RWNPcnN3Szl4ODJvQWw0ZnpLRjlCTmRheW5KQGNsaWVudHMiLCJhdWQiOiJodHRwczovL2FwaS5wYWxpc2FkZS5jby8iLCJpYXQiOjE3MDQ5ODg0NDQsImV4cCI6MTcwNDk5MjA0NCwiYXpwIjoiVU1tZnlFY09yc3dLOXg4Mm9BbDRmektGOUJOZGF5bkoiLCJzY29wZSI6ImJhbGFuY2VzOnJlYWQ6b3JnOmlkPWNlNDkxOGJmLWExOTktNGNlMi04NWEzLWQwZDI5Njg1NTM4NDoqIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIiwicGVybWlzc2lvbnMiOlsiYmFsYW5jZXM6cmVhZDpvcmc6aWQ9Y2U0OTE4YmYtYTE5OS00Y2UyLTg1YTMtZDBkMjk2ODU1Mzg0OioiXX0.RdKm2CvCAJYDno4dCdQ-G8k4ia7oHnVFW7O9mrcPhxnBayKPa2kLPcDJbFineU2s_AIlCjp6-1Bx6gOTytNVI4hWpS8ho_QSkQVipDAltq06Lg0N__NYZG11ZaDwlC0MLC2zcTYwIZcHY2_cC5kwOQ5Dc4no_IFCPtU_UbepqXZuj9uJda-9vrLv0zFoKD7bKUQkSaDam7Qvq6J7Q-sKwu_8wZ3tfSLqk53ECLZn4d9sJnsWaXixoQd1s0w5qKDSwjRMLeB8rm2ATAR4r4FayCKrSYgAuaK0heoYS158x69ThtTWZJFi0gPf1yD2DpshiEAFWyv4mMkH7YVs-fi6_x",
  "scope": "balances:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*",
  "expiresIn": 3600,
  "tokenType": "Bearer"
}

List available permissions

Request

List available permissions for the use with API credentials

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

Responses

A successful response.

Bodyapplication/json
walletsobjectrequired
Example: {"balances":{"read":["org","vault","key"]},"key":{"create":["org","vault"],"read":["org","vault","key"],"update":["org","vault","key"]},"vault":{"create":["org"],"read":["org","vault"]}}
transactionsobjectrequired
Example: {"transaction":{"read":["org","vault","key"],"create":["org","vault","key"]}}
controlsobjectrequired
Example: {"allowaddress":{"create":["org","vault","key"],"delete":["org","vault","key"],"read":["org","vault","key"]},"keylimit":{"create":["org","vault","key"],"delete":["org","vault","key"],"read":["org","vault","key"]}}
auditobjectrequired
Response
application/json
{
  "wallets": {
    "balances": { … },
    "key": { … },
    "vault": { … }
  },
  "transactions": {
    "transaction": { … }
  },
  "controls": {
    "allowaddress": { … },
    "keylimit": { … }
  }
}

Get credentials

Request

Get a set of API credentials by ID

Security
TokenAuth
Path
idstringrequired

The credential ID

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

Responses

Bodyapplication/json
idstringrequired

The credential ID

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

The credential name

Example: "Treasury"
descriptionstring

The credential description

Example: "Credentials that belong to trading desk #1"
categorystring(v2Category)required
Enum"CONTROLS""WALLETS""TRANSACTIONS""AUDIT"
permissionsArray of stringsrequired

The credential permissions

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
createdBystringrequired

The ID of the user who created the credential

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

The ID of the organization who created the credential

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the credential was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the credential was updated

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

The credential client ID

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

The credential client secret

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

The credential active status

Example: true
statusstring(v2CredentialStatus)required
Enum"CREATED""ENABLED""DISABLED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""DELETION_APPROVAL_PENDING""DELETION_APPROVAL_COMPLETE"
proposedPermissionsArray of stringsrequired

The proposed credential permissions

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
allowedIpsArray of strings

List of IP addresses (in IP address or CIDR notation) that the credential is allowed to use

Example: ["88.9.2.1","88.10.2.1/0"]
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "name": "Treasury",
  "description": "Credentials that belong to trading desk #1",
  "category": "CONTROLS",
  "permissions": [
    "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
  ],
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "clientSecret": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "active": true,
  "status": "CREATED",
  "proposedPermissions": [
    "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
  ],
  "allowedIps": [
    "88.9.2.1",
    "88.10.2.1/0"
  ]
}

Delete credential

Request

Delete a specific set of API credentials

Security
TokenAuth
Path
idstringrequired

The credential ID

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

Responses

A successful response.

Bodyapplication/json
object(v2DeleteCredentialResponse)
Response
application/json
{}

Update credential active status

Request

Update the active status on a specific set of API credentials

Security
TokenAuth
Path
idstringrequired

The credential ID

Bodyapplication/jsonrequired
activebooleanrequired

The credential enabled status

Example: true
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/credentials/{id}/active' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "active": true
  }'

Responses

Bodyapplication/json
idstringrequired

The credential ID

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

The credential name

Example: "Treasury"
descriptionstring

The credential description

Example: "Credentials that belong to trading desk #1"
categorystring(v2Category)required
Enum"CONTROLS""WALLETS""TRANSACTIONS""AUDIT"
permissionsArray of stringsrequired

The credential permissions

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
createdBystringrequired

The ID of the user who created the credential

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

The ID of the organization who created the credential

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the credential was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the credential was updated

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

The credential client ID

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

The credential client secret

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

The credential active status

Example: true
statusstring(v2CredentialStatus)required
Enum"CREATED""ENABLED""DISABLED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""DELETION_APPROVAL_PENDING""DELETION_APPROVAL_COMPLETE"
proposedPermissionsArray of stringsrequired

The proposed credential permissions

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
allowedIpsArray of strings

List of IP addresses (in IP address or CIDR notation) that the credential is allowed to use

Example: ["88.9.2.1","88.10.2.1/0"]
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "name": "Treasury",
  "description": "Credentials that belong to trading desk #1",
  "category": "CONTROLS",
  "permissions": [
    "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
  ],
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "clientSecret": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "active": true,
  "status": "CREATED",
  "proposedPermissions": [
    "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
  ],
  "allowedIps": [
    "88.9.2.1",
    "88.10.2.1/0"
  ]
}

Get credential info

Request

Get a set of API credential info by ID

Security
TokenAuth
Path
idstringrequired

The credential ID

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

Responses

Bodyapplication/json
idstringrequired

The credential ID

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

The ID of the organization who created the credential

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

The credential name

Example: "Treasury"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "name": "Treasury"
}

Update credential permissions

Request

Update the permissions set on a specific set of API credentials

Security
TokenAuth
Path
idstringrequired

The credential ID

Bodyapplication/jsonrequired
permissionsArray of stringsrequired

The permissions that the credential will have

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/credentials/{id}/permissions' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "permissions": [
      "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired

The credential ID

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

The credential name

Example: "Treasury"
descriptionstring

The credential description

Example: "Credentials that belong to trading desk #1"
categorystring(v2Category)required
Enum"CONTROLS""WALLETS""TRANSACTIONS""AUDIT"
permissionsArray of stringsrequired

The credential permissions

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
createdBystringrequired

The ID of the user who created the credential

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

The ID of the organization who created the credential

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the credential was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the credential was updated

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

The credential client ID

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

The credential client secret

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

The credential active status

Example: true
statusstring(v2CredentialStatus)required
Enum"CREATED""ENABLED""DISABLED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""DELETION_APPROVAL_PENDING""DELETION_APPROVAL_COMPLETE"
proposedPermissionsArray of stringsrequired

The proposed credential permissions

Example: ["vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"]
allowedIpsArray of strings

List of IP addresses (in IP address or CIDR notation) that the credential is allowed to use

Example: ["88.9.2.1","88.10.2.1/0"]
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "name": "Treasury",
  "description": "Credentials that belong to trading desk #1",
  "category": "CONTROLS",
  "permissions": [
    "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
  ],
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "clientSecret": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "active": true,
  "status": "CREATED",
  "proposedPermissions": [
    "vault:read:org:id=ce4918bf-a199-4ce2-85a3-d0d296855384:*"
  ],
  "allowedIps": [
    "88.9.2.1",
    "88.10.2.1/0"
  ]
}

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

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