Environment Variables

Read and update project environment variables, inspect custom environments, and read shared environment variables.

`create_project_env`

Create one or more environment variables.

Parameter	Type	Required	Description
`idOrName`	string	Yes	The unique project identifier or the project name
`upsert`	string	No	Allow override of environment variable if it already exists
`teamId`	string	No	Team ID to use for this operation.
`slug`	string	No	Team slug to use for this operation. Use instead of teamId.
`requestBody`	object \| Array<object>	Yes	Request body for this tool.

Edit an environment variable.

Parameter	Type	Required	Description
`idOrName`	string	Yes	The unique project identifier or the project name
`id`	string	Yes	The unique environment variable identifier
`teamId`	string	No	Team ID to use for this operation.
`slug`	string	No	Team slug to use for this operation. Use instead of teamId.
`requestBody`	object	Yes	Request body for this tool.

Retrieve the environment variables of a project by id or name.

Parameter	Type	Required	Description
`idOrName`	string	Yes	The unique project identifier or the project name
`gitBranch`	string	No	If defined, the git branch of the environment variable to filter the results (must have target=preview)
`decrypt`	string	No	If true, the environment variable value will be decrypted Allowed values: `"true"`, `"false"`.
`source`	string	No	The source that is calling the endpoint.
`customEnvironmentId`	string	No	The unique custom environment identifier within the project
`customEnvironmentSlug`	string	No	The custom environment slug (name) within the project
`teamId`	string	No	Team ID to use for this operation.
`slug`	string	No	Team slug to use for this operation. Use instead of teamId.

Retrieve a custom environment.

Parameter	Type	Required	Description
`idOrName`	string	Yes	The unique project identifier or the project name
`environmentSlugOrId`	string	Yes	The unique custom environment identifier within the project
`teamId`	string	No	Team ID to use for this operation.
`slug`	string	No	Team slug to use for this operation. Use instead of teamId.

Retrieve the decrypted value of an environment variable of a project by id.

Parameter	Type	Required	Description
`idOrName`	string	Yes	The unique project identifier or the project name
`id`	string	Yes	The unique ID for the environment variable to get the decrypted value.
`teamId`	string	No	Team ID to use for this operation.
`slug`	string	No	Team slug to use for this operation. Use instead of teamId.

Retrieve the decrypted value of a Shared Environment Variable by id.

Parameter	Type	Required	Description
`id`	string	Yes	The unique ID for the Shared Environment Variable to get the decrypted value.
`teamId`	string	No	Team ID to use for this operation.
`slug`	string	No	Team slug to use for this operation. Use instead of teamId.

Retrieve custom environments.

Parameter	Type	Required	Description
`idOrName`	string	Yes	The unique project identifier or the project name
`gitBranch`	string	No	Fetch custom environments for a specific git branch
`teamId`	string	No	Team ID to use for this operation.
`slug`	string	No	Team slug to use for this operation. Use instead of teamId.

Was this helpful?