v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

Vault Proxy Connections

Filter & list connections

Fetch list of connections for given query parameters. By default, deleted connections are excluded from the results.

get/token/connections

Query parameters

filter[connectionType]'inbound' | 'outbound'

Filter for a list of connections by connectionType.

filter[live]boolean

Filter connections based on their live status.

filter[searchTerm]string

Filter connections based on a partial or full match in their ID, name, or description.

filter[includeDeleted]boolean

When set to true, includes deleted connections in the results. Default is false.

Response

Success.

Example response

{
  "results": [
    {
      "updatedAt": "2025-03-11T09:31:52.131176Z",
      "createdAt": "2025-03-11T09:31:52.131176Z",
      "deletedAt": "2025-03-11T09:31:52.131176Z"
    }
  ]
}