Skip to main content
GET
Error

Authorizations

x-cdata-authtoken
string
header
required

A Sync user auth token. Generate one via POST /v2/users/generate-token.

Query Parameters

$filter
string

OData-style filter expression applied to the collection, on endpoints that support filtering (e.g. name eq 'my_job'). Filters on resource fields such as id and name. Substring matching with contains(name,'my_job') is case-insensitive. startswith and endswith retain their existing behavior; case sensitivity depends on the AppDB collation.

$orderby
string

OData-style sort expression applied to the collection, on endpoints that support sorting (e.g. name asc, created_at desc).

$top
integer

Maximum number of records to return (pagination), where supported.

$skip
integer

Number of records to skip before returning results (pagination), where supported.

Response

One or more vaults

id
string
provider_key
string

Globally unique reference key. Immutable after create.

display_name
string
type
enum<string>

Vault provider type.

Available options:
Local,
System,
AzureKeyVault
scope
enum<string>

Vault scope. Registrations use system scope.

Available options:
SYSTEM
config
object

Provider configuration. Non-sensitive fields are returned as stored; sensitive fields (for example clientSecret) are returned masked (********). Empty for the Local vault. For the built-in System vault, standardPatterns and encryptedPatterns contain comma-separated environment variable names or wildcard patterns.

created_at
string<date-time>
updated_at
string<date-time>