v4

latestOpenAPI 3.0.32026-07-312,317012.2 MB
Secrets

Get a secret by name

get/api/v3/secrets/raw/{secretName}

Path parameters

secretNamestring required

The name of the secret to get.

Query parameters

workspaceIdstring

The ID of the project to get the secret from.

workspaceSlugstring

The slug of the project to get the secret from.

environmentstring

The slug of the environment to get the secret from.

secretPathstring

The path of the secret to get.

versionnumber

The version of the secret to get.

type'shared' | 'personal'

The type of the secret to get.

viewSecretValue'true' | 'false'

Whether or not to retrieve the secret value.

expandSecretReferences'true' | 'false'

Whether or not to expand secret references.

include_imports'true' | 'false'

Weather to include imported secrets or not.

Response

Default Response