revault-api

Appearance

List policies ​

GET/policies

Query parameters ​

NameTypeDescriptionRequired
page
number
Which page to fetch
min: 1, max: 9007199254740991
pageSize
number
Page size to use
min: 1, max: 30
name
string
Search by matching name
isPrivate
boolean
Search private policies
sortBy
"name" | "createdAt" | "updatedAt"
Sort by attribute
sortOrder
"asc" | "desc"
Sort order

Response schema ​

{
// Current page
page: number;
// Next page or null if there is none
next: number | null;
// Previous page or null if there is none
prev: number | null;
// Max count of items per page
pageSize: number;
// Total count of items
total: number;
// Array of results
results: Array<{
// Internal unique identifier
id: string;
// Legacy internal unique identifier (for retro-compatibility)
legacyId: number;
// Policy name
name: string;
// Policy description
description: string | null;
currency: string | null;
network: string | null;
// Whether the policy is private
isPrivate: boolean;
// List of governance rules
rules: Array<{
// Review steps
reviewSteps: Array<
|
Review step with users
|
Review step with group
>;
Optional
// Threshold for the transaction value
threshold?: {
// Minimum transaction amount
min: string | null;
// Maximum transaction amount
max: string | null;
};
Optional
// IDs of whitelists for the recipient address
whitelistIds?: Array<string>;
// Allowed operation type
operationType:
| "SEND"
| "STAKE"
| "DEPLOY_CONTRACT"
| "EXECUTE_CONTRACT"
| "ACTIVATE_TOKEN"
| "RECEIVE"
| "SIGN_MESSAGE"
| "SIGN_DIGESTS"
;
}>;
// Related whitelists
whitelists: Array<{
// Internal unique identifier
id: string;
// Legacy internal unique identifier (for retro-compatibility)
legacyId: number;
// Whitelist name
name: string;
// Whitelist status
status: "ACTIVE" | "INACTIVE";
addresses: Array<{
// Address name
name: string;
// Address currency
currency: string;
// Address value
address: string;
Optional
// List of destination tags (applicable for Ripple currency)
destinationTags?: Array<string>;
}>;
// Creation timestamp
createdAt: string;
// Last modification timestamp
updatedAt: string;
// Whitelist description
description: string | null;
}>;
// Referenced users
users: Array<{
// Internal unique identifier
id: string;
// Legacy internal unique identifier (for retro-compatibility)
legacyId: number;
// If true, user can read all resources on the workspace
legacyViewAll: boolean;
// User's workspace name
workspaceName: string;
// User name
name: string;
// User's device ID (for non-API users)
deviceUserId: string | null;
// User's device type
deviceType: "PSD" | "SOFT_PSD" | "API";
// User role
role: "ADMIN" | "OPERATOR" | "READ_ONLY_API_KEY";
// User public key
pubKey: string;
// User status
status: "ACTIVE" | "INACTIVE";
// Whether the user is suspended
isSuspended: boolean;
// Creation timestamp
createdAt: string;
// Last modification timestamp
updatedAt: string;
}>;
// Referenced groups
groups: Array<{
// Internal unique identifier
id: string;
// Legacy internal unique identifier (for retro-compatibility)
legacyId: number;
// Group name
name: string;
// Group description
description: string | null;
// Group status
status: "ACTIVE" | "INACTIVE";
// Creation timestamp
createdAt: string;
// Last modification timestamp
updatedAt: string;
}>;
// Creation timestamp
createdAt: string;
// Last modification timestamp
updatedAt: string;
}>;
}

Examples ​

bash
curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {jwt}" \
  "$API_BASE_URL/policies"
ts
const url = "<base-url>/policies";

const headers = {
  "Content-Type": "application/json",
  Authorization: "Bearer <jwt>"
};

fetch(url, { headers }).then(res => {
  console.log(res)
});
python
import requests

url = "<base-url>/policies"

headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer <jwt>"
}

print(requests.get(url, headers=headers))