Vaults
List vaults
get/v1/vaults
Request
- Base URLhttps://docs.ripple.com (the document declares no server; this is the origin it was published from)
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
limitinteger
The number of entities to return.
startingAfterstring uuid
Entity id used to the determine beginning of query results.
sortBy'id' | 'alias' | 'lock' | 'metadata.createdAt' | 'metadata.lastModifiedAt'
Property name used to sort the query results.
sortOrder'ASC' | 'DESC'
Sort order applied to the query results.
aliasstring
Return entities with aliases that contains or equals to provided alias.
publicKeystring
Return entities matching given public key. It should be provided in Base64 format.
lockCore
Return entities matching given lock status.
metadata.createdBystring uuid
Return entities that were created by matching user.
metadata.lastModifiedBystring uuid
Return entities that were last modified by matching user.
metadata.descriptionstring
Return entities with descriptions that contains or equals to provided description.
metadata.customPropertiesstring[]
Return entities that contains provided custom properties.
additionalDetails.processingStatus'Pending' | 'Preparing' | 'Completed'
Return entities matching given processing status.
Response
Changes
No recorded changes to this operation across all 3 revisions of this API.