Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ripple Labs Vaults API

Used to manage vaults

Ripple Labs Vaults API is one of 36 APIs that Ripple Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Vaults. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 5 operations across 3 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against 2 base URLs: https://api.sandbox.palisade.co, https://api.palisade.co.

5 operations 3 paths 13 schemas 2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.ripple.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ripple Labs Vaults API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (TokenAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Vaults 5

Used to manage vaults

GET
/v2/vaults
List vaults
VaultService_ListVaults 68 params → 200400401403404default
POST
/v2/vaults
Create a vault
VaultService_CreateVault body → 200400401403404default
GET
/v2/vaults/{id}
Get a vault
VaultService_GetVault 1 param → 200400401403404default
PUT
/v2/vaults/{id}
Update a vault
VaultService_UpdateVault 1 param body → 200400401403404default
POST
/v2/vaults:list
List vaults
VaultService_ListVaults2 body → 200400401403404default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are v2TimestampFilter (9 properties), v2StringFilter (8 properties), v2Vault (8 properties), v2VaultFilter (7 properties). Each schema is shown below with its type and property counts.

protobufAny
object
1 property
v2SortOrder
string
v2VaultFilter
object
7 properties
v2ListVaultsRequest
object
6 properties
TimestampFilterTimestampRange
object
2 properties
v2TimestampFilter
object
9 properties
v2FilterRequest
object
4 properties
v2Vault
object
8 properties 5 required
v2ListVaultsResponse
object
2 properties
v2FilterResponse
object
3 properties 1 required
rpcStatus
object
3 properties
v2StringFilter
object
8 properties
v2CreateVaultRequest
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-vaults-api-openapi.yml Raw ↑

Other APIs Ripple Labs publishes across the network.

Ripple Labs Addresses API
Ripple Labs API Credentials API
Ripple Labs Auditing API
Ripple Labs Authentication API
Ripple Labs Balances and statements API
Ripple Labs Balances API
Ripple Labs Beneficiary confirmation API
Ripple Labs Counterparties API
Ripple Labs Diagnostics API
Ripple Labs Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API