logo

Scoped Variables

Endpoints related to managing an environment's scoped variables.

List Scoped Variables

Requires the scoped-variables-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
environmentId
required
string

The ID of the requested Environment.

query Parameters
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of scoped variables.

default

General error response from the platform

get/v1/environments/{environmentId}/scoped-variables
Response samples
application/json
{
  • "data": [
    ]
}

Create Scoped Variable

Requires the scoped-variables-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
environmentId
required
string

The ID of the requested Environment.

Request Body schema: application/json

Parameters for creating a Scoped Variable.

identifier
required
string

An identifier for this Scoped Variable.

required
object (ScopedVariableScope)

Information about the assignment of the scoped variable and how it is invoked.

object (ScopedVariableAccess)

The way the scoped variable is accessed.

required
object

The source or value of the Scoped Variable.

Responses
201

Returns a Scoped Variable.

default

General error response from the platform

post/v1/environments/{environmentId}/scoped-variables
Request samples
application/json
{
  • "identifier": "string",
  • "scope": {
    },
  • "access": {
    },
  • "source": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Get Scoped Variable

Requires the scoped-variables-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
environmentId
required
string

The ID of the requested Environment.

scopedVariableId
required
string

The ID of the requested Scoped Variable.

Responses
200

Returns a Scoped Variable.

default

General error response from the platform

get/v1/environments/{environmentId}/scoped-variables/{scopedVariableId}
Response samples
application/json
{
  • "data": {
    }
}

Update Scoped Variable

Requires the scoped-variables-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
environmentId
required
string

The ID of the requested endpointnvironment.

scopedVariableId
required
string

The ID of the requested Scoped Variable.

Request Body schema: application/json

Parameters for updating a Scoped Variable.

identifier
string

An identifier, similar to a key in an Environment variable. Its used when envoking the Scoped Variable.

object (ScopedVariableScope)

Information about the assignment of the scoped variable and how it is invoked.

object (ScopedVariableAccess)

The way the scoped variable is accessed.

object

The source or value of the Scoped Variable.

Responses
200

Returns a Scoped Variable.

default

General error response from the platform

patch/v1/environments/{environmentId}/scoped-variables/{scopedVariableId}
Request samples
application/json
{
  • "identifier": "string",
  • "scope": {
    },
  • "access": {
    },
  • "source": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Delete Scoped Variable

Requires the scoped-variables-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
environmentId
required
string

The ID of the requested Environment.

scopedVariableId
required
string

The ID of the requested Scoped Variable.

Responses
202

Returns a Job Descriptor.

default

General error response from the platform

delete/v1/environments/{environmentId}/scoped-variables/{scopedVariableId}
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Services/Discovery