Retrieve

Get a secret by name

This endpoint requires you to disable end-to-end encryption. For more information, you should consult this note.

Authorizations

Authorization

string

header

required

An access token in Infisical

X-API-Key

string

header

required

An API Key in Infisical

Path Parameters

secretName

string

required

The name of the secret to get.

Query Parameters

workspaceId

string

The ID of the project to get the secret from.

environment

string

The slug of the environment to get the secret from.

secretPath

string

default:

/

The path of the secret to get.

version

number

The version of the secret to get.

type

enum<string>

default:

shared

The type of the secret to get.

Available options:

shared,

personal

include_imports

enum<string>

default:

false

Weather to include imported secrets or not.

Available options:

true,

false

Response

200 - application/json

secret

object

required

Show child attributes

secret._id

string

required

secret.environment

string

required

secret.id

string

required

secret.secretKey

string

required

secret.secretValue

string

required

secret.type

string

required

secret.version

number

required

secret.workspace

string

required

secret.secretComment

string