v4

latestOpenAPI 3.0.32026-07-312,317012.2 MB
Secrets

List secrets

get/api/v3/secrets/raw

Query parameters

metadataFilterstring

Unencrypted secret metadata key-value pairs used to filter secrets. Only metadata with unencrypted values is supported. When querying for multiple metadata pairs, the query is treated as an AND operation. Secret metadata format is key=value1,value=value2|key=value3,value=value4.

workspaceIdstring

The ID of the project to list secrets from.

workspaceSlugstring

The slug of the project to list secrets from. This parameter is only applicable by machine identities.

environmentstring

The slug of the environment to list secrets from.

secretPathstring

The secret path to list secrets from.

viewSecretValue'true' | 'false'

Whether or not to retrieve the secret value.

expandSecretReferences'true' | 'false'

Whether or not to expand secret references.

recursive'true' | 'false'

Whether or not to fetch all secrets from the specified base path, and all of its subdirectories. Note, the max depth is 20 deep.

include_imports'true' | 'false'

Weather to include imported secrets or not.

tagSlugsstring

The comma separated tag slugs to filter secrets.

Response

Default Response