Update a Variable

Path Params
string
required

The ID of the variable to update.

Query Params
boolean
Defaults to false

Enables the final variable to override variables from a lower scope

include
array of strings

The comma-separated list of relationship paths.

include
Body Params
data
object

A Variable describes the configuration and value of a variable in a workspace.

In Scalr there are "terraform" and "environment" variables.

  • Terraform variables define values to be passed into the corresponding Terraform input variable
    that is defined in the Configuration Version to be used in a run. Scalr Terraform variables
    are added to the terraform.tfvars.json file in the working directory of the workspace prior to any run.
    The values passed in can be HCL structures if the hcl attribute is true.
  • Environment variables define shell variables that are added to the run time environment of a workspace
    using export VAR=value. These variables can pass authentication parameters to providers
    or any data required for local processing, such as via local-exec provisioners.
Responses

404

Variable not found, or user unauthorized to perform action.

422

Malformed request body (missing attributes, wrong types, etc.)

4XX

Client error.

5XX

Server error.

Language
Credentials
Bearer
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json