Roles / Global Variables: Get

Description

Retrieve detailed information about Global Variable in the Role's scope.

HTTP Request

GET /api/v1beta0/user/envId/roles/roleId/global-variables/globalVariableName/

Parameters

Name Required Description Location
envId
integer
Yes

The ID of the Environment scoping this request.

path
roleId
integer
Yes

The ID of a Role object.

path
globalVariableName
string
Yes

The name of the Global Variable being accessed.

path

Request body

Do not supply a body with this request.

Successful Response (Status 200)

The JSON representation of a GlobalVariable object.

The API replies with a GlobalVariableDetailsResponse object. Example response body:

{
  "data": {
    "category": "string", 
    "computedCategory": "string", 
    "computedValue": "string", 
    "declaredIn": "scalr", 
    "definedIn": "scalr", 
    "description": "string", 
    "hidden": true, 
    "locked": true, 
    "name": "string", 
    "requiredIn": "scalr", 
    "type": "GlobalVariable", 
    "value": "string"
  }, 
  "errors": [
    {
      "code": "string", 
      "message": "string"
    }
  ], 
  "meta": {
    "sample": "string"
  }, 
  "warnings": [
    {
      "code": "string", 
      "message": "string"
    }
  ]
}

Other Response Messages

HTTP Status Code Reason Response Model
400

A client-side error was made.

An ApiErrorResponse object
401

The request was not authenticated.

An ApiErrorResponse object
403

Insufficient permissions.

An ApiErrorResponse object
404

Resource not found.

An ApiErrorResponse object
409

Conflict with current state.

An ApiErrorResponse object
422

This request was well-formed but was rejected due to semantic errors.

An ApiErrorResponse object
500

A server-side error occurred.

An ApiErrorResponse object
501

This feature is not implemented in Scalr.

An ApiErrorResponse object
503

The service is currently unavailable.

An ApiErrorResponse object

Try it out!

Parameter Value Description
envId

The ID of the Environment scoping this request.

roleId

The ID of a Role object.

globalVariableName

The name of the Global Variable being accessed.