Variables mAPI reference
Complete reference documentation for the Variables resource.
Variables
#Variables are used to store shared attributes for your workflows and templates at the environment level.
List variables
#Returns a list of variables. When an environment is specified, returns per-environment variables. Otherwise, returns project-scoped variables with per-environment overrides.
Endpoint
Query parameters
The environment slug.
The slug of a branch to use. This option can only be used when environment is "development".
Filter variables by type. Supports 'public' or 'secret'.
The cursor to fetch entries after.
The cursor to fetch entries before.
The number of entries to fetch per-page.
Returns
A paginated list of Variable. Contains a list of entries and page information.
A list of entries.
The description of the variable.
A map of environment slugs to their override values. Only present for project-scoped responses.
The timestamp of when the variable was created.
The key of the variable.
The type of the variable.
The timestamp of when the variable was last updated.
The default value of the variable. For secret variables, this is obfuscated.
The information about a paginated result.
The cursor to fetch entries after. Will only be present if there are more entries to fetch.
The cursor to fetch entries before. Will only be present if there are more entries to fetch before the current page.
The number of entries to fetch per-page.
Get a variable
#Returns a single variable by key with per-environment value overrides.
Endpoint
Path parameters
The key of the variable to retrieve.
Returns
An environment variable object.
The description of the variable.
A map of environment slugs to their override values. Only present for project-scoped responses.
The timestamp of when the variable was created.
The key of the variable.
The type of the variable.
The timestamp of when the variable was last updated.
The default value of the variable. For secret variables, this is obfuscated.
Variable
#An environment variable object.
Attributes
The description of the variable.
A map of environment slugs to their override values. Only present for project-scoped responses.
The timestamp of when the variable was created.
The key of the variable.
The type of the variable.
The timestamp of when the variable was last updated.
The default value of the variable. For secret variables, this is obfuscated.