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 Policies API

Used to manage connections policies

Ripple Labs Policies 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 Policies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 7 operations across 5 paths, and defines 24 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.

7 operations 5 paths 24 schemas 1 DELETE3 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 Policies 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 7

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

Policies 7

Used to manage connections policies

GET
/v2/policy-rules/limits
List organization wallet limits
PolicyService_ListGlobalWalletLimits 67 params → 200400401403404default
POST
/v2/policy-rules/limits:list
List organization wallet limits
PolicyService_ListGlobalWalletLimits2 body → 200400401403404default
GET
/v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits
List wallet limit policies
PolicyService_ListWalletLimits 70 params → 200400401403404default
PUT
/v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits
Create a wallet limit policy
PolicyService_CreateWalletLimit 2 params body → 200400401403404default
GET
/v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits/{id}
Get a wallet limit policy
PolicyService_GetWalletLimit 3 params → 200400401403404default
DELETE
/v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits/{id}
Delete a wallet limit policy
PolicyService_DeleteWalletLimit 3 params → 200400401403404default
POST
/v2/vaults/{vaultId}/wallets/{walletId}/policy-rules/limits:list
List wallet limit policies
PolicyService_ListWalletLimits2 2 params body → 200400401403404default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are commonv2Asset (19 properties), v2WalletLimit (14 properties), v2WalletLimitFilter (10 properties), v2TimestampFilter (9 properties). Each schema is shown below with its type and property counts.

v2WalletLimit
object
14 properties 10 required
v2ListGlobalWalletLimitsRequest
object
5 properties
v2WalletLimitStatus
string
v2DeleteWalletLimitResponse
object
commonv2Asset
object
19 properties 5 required
v2ListWalletLimitsResponse
object
2 properties
v2LimitType
string
v2Standard
string
protobufAny
object
1 property
v2BoolFilter
object
2 properties
TimestampFilterTimestampRange
object
2 properties
v2TimestampFilter
object
9 properties
v2Matcher
object
3 properties 1 required
v2ListGlobalWalletLimitsResponse
object
2 properties
v2FilterResponse
object
3 properties 1 required
v2AssetSource
string
v2MatcherType
string
v2WalletLimitFilter
object
10 properties
v2Blockchain
string
v2StringFilter
object
8 properties
v2SortOrder
string
v2BlockchainFilter
object
4 properties
v2FilterRequest
object
4 properties
rpcStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-policies-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