variables

Get a Variable

Show details of a specific variable.

For sensitive: true variables, their actual value is not exposed, and null returned instead.

get/vars/{var}

Request

  • Base URL
    https://example.scalr.io/api/iacp/v3
  • URL
    https://example.scalr.io/api/iacp/v3/vars/{var}
  • Auth
    HTTP bearer

Path parameters

varstring required

The ID of the variable to show.

Query parameters

includestring[]

The comma-separated list of relationship paths.

usersstring

The comma-separated list of fields to return in response for User resource.

varsstring

The comma-separated list of fields to return in response for Variable resource.

The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.

Response

Success.

includedobject[]
metaobject

Changes

No recorded changes to this operation across all 2 revisions of this API.