Skip to content

List Backups

Request

Security
httpAuth
Query
limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring, (uuid)

Entity id used to the determine beginning of query results.

sortBystring

Property name used to sort the query results.

Enum:"id""alias""metadata.createdAt""metadata.lastModifiedAt"
sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"
vaultIdstring, (uuid)

Return entities matching given vault id.

Example:vaultId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be
lastOnlyboolean

Return entities with acknowledged status and limits results to latest one.

Example:lastOnly=true
acknowledgedboolean

Return entities with acknowledged status equals true.

Example:acknowledged=true
data.typestring

Return entities that matches given type.

Enum:"VaultHsm""VaultMpc"
Example:data.type=VaultMpc
metadata.createdBystring, (uuid)

Return entities that were created by matching user.

Example:metadata.createdBy=fdeeeb4b-f987-4ec4-9880-1eb280581d49
metadata.lastModifiedBystring, (uuid)

Return entities that were last modified by matching user.

Example:metadata.lastModifiedBy=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b
metadata.descriptionstring, >= 0 characters

Return entities with descriptions that contains or equals to provided description.

Example:metadata.description=description1
metadata.customPropertiesArray of strings

Return entities that contains provided custom properties.

Example:metadata.customProperties=key1:value1&metadata.customProperties=key2:value2
additionalDetails.processingStatusstring

Return entities matching given processing status.

Enum:"Pending""Preparing""Completed""Failed"
Example:additionalDetails.processingStatus=Pending
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/devbox/v1/backups?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=id&sortOrder=ASC&vaultId=8e92eb53-40e7-4809-bb52-7e7b3b41a4be&lastOnly=true&acknowledged=true&data.type=VaultMpc&metadata.createdBy=fdeeeb4b-f987-4ec4-9880-1eb280581d49&metadata.lastModifiedBy=90c4cf2f-ebe0-4bf7-91cd-4c45cd02277b&metadata.description=description1&metadata.customProperties=key1%3Avalue1%2Ckey2%3Avalue2&additionalDetails.processingStatus=Pending' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
itemsArray of objectsrequired
countinteger, (int32)required
currentStartingAfterstring
nextStartingAfterstring
Response
{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "string",
  "nextStartingAfter": "string"
}