Retrieve

Get a secret by name

Authorizations

Authorization

string

headerrequired

An access token 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.

workspaceSlug

string

The slug 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

expandSecretReferences

enum<string>

default: false

Whether or not to expand secret references.

Available options:

true,

false

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._id

string

required

secret.workspace

string

required

secret.environment

string

required

secret.version

number

required

secret.type

string

required

secret.secretKey

string

required

secret.secretValue

string

required

secret.secretComment

string

required

secret.createdAt

string

required

secret.updatedAt

string

required

secret.secretReminderNote

string | null

secret.secretReminderRepeatDays

number | null

secret.skipMultilineEncoding

boolean | null

default: false

secret.metadata

any | null

secret.tags

object[]

Show child attributes

secret.tags.id

string

required

secret.tags.slug

string

required

secret.tags.color

string | null

secret.tags.name

string

required