Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
secrets
Secrets

List Secrets

List Secrets

get/secrets

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id, name or secret_type.

If set, return records where the specified field is equal to the supplied value. Valid fields are workspace_id, name or secret_type. Valid field combinations are [ workspace_id, name ], [ workspace_id, secret_type ], [ secret_type, name ] or [ workspace_id, secret_type, name ].

If set, return records where the specified field is prefixed by the supplied value. Valid fields are name.

Response

A list of Secrets objects.

idinteger

Secret ID.

workspace_idinteger

Workspace ID. 0 means the default workspace.

namestring

Secret name.

descriptionstring

Internal description for your reference.

secret_type'basic' | 'token' | 'headers' | 'certificate' | 'key_value'

Secret type.

metadataobject

Non-secret metadata for the Secret type.

value_field_namesstring[]

Names of configured secret value fields. Secret values are never returned.

created_atstring date-time

Secret create date/time.

updated_atstring date-time

Secret update date/time.

Example response

[
  {
    "id": 1,
    "name": "Production API token",
    "description": "Used by production API integrations.",
    "secret_type": "token",
    "metadata": {
      "key": "example value"
    },
    "value_field_names": [
      "example"
    ],
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]