Skip to content

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/wallet/api-docs/palisade-api/palisade-api/v2/vaults/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired

The vault 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
{ "id": "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" }