OMomnistack-sh
Vaults

List vaults

Changed on

Lists vaults using ID-based pagination. See vaults.

get/vaults

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/vaults
  • Auth
    HTTP bearer

Query parameters

limitinteger

The maximum number of resources to return, between 1 and 100. Defaults to 20.

order'asc' | 'desc'

The order in which paginated resources are returned.

The order in which resources are returned. Defaults to desc.

afterstring

Return resources after this resource ID in the selected order.

metadataobject

Exact string matches supplied as metadata[key]=value. All supplied pairs must match. Up to 16 pairs, with keys from 1 to 64 characters and values up to 512 characters. Filtering is eventually consistent; metadata changes may take time to appear.

'active' | 'archived'

Whether a vault or credential is active or archived.

OR
VaultStatusParam[]

Filter by one status or a list, such as status=active or status[]=active&status[]=archived. Both statuses are included by default.

Response

A page of vaults.

object'list' required

The object type, which is always list.

first_idstring nullable required

The ID of the first resource in data, or null if the page is empty.

last_idstring nullable required

The ID of the last resource in data, or null if the page is empty. Pass this as after with the same order and filters.

has_moreboolean required

Whether there are more resources to retrieve after this page.

Changes

  • 051b70dab8ddRevision changes
    • breaking

      for the query request parameter limit, default value 20 was added

    • breaking

      for the query request parameter limit, the min was increased from 0.00 to 1.00

    • warning

      for the query request parameter limit, the max was set to 100.00

  • df811f5267b3Revision changes
    • info

      added the new optional query request parameter metadata