putGlobalVariable

PUT

/api/v1/variables/{key}

curl --request PUT \
  --url https://example.com/api/v1/variables/example \
  --header 'Content-Type: application/json' \
  --data '{ "value": "example" }'

Parameters

Path Parameters

key

required

string

/^[A-Za-z_][A-Za-z0-9_]{0,127}$/

Request Body^required

Media typeapplication/json

object

value

required

string

<= 65536 characters

key

additional properties

any

Example^generated

{
  "value": "example"
}

Responses

200

OK

Media typeapplication/json

object

inherited

required

True when a parent namespace or the global scope defines the variable.

boolean

key

required

string

scope

required

Global or the namespace name that defines the variable.

string

updated_at

required

string format: date-time

updated_by

required

string

value

required

string

key

additional properties

any

Example^generated

{
  "inherited": true,
  "key": "example",
  "scope": "example",
  "updated_at": "2026-04-15T12:00:00Z",
  "updated_by": "example",
  "value": "example"
}

default

Error

Media typeapplication/json

object

error

required

object

code

required

string

details

message

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "details": "example",
    "message": "example"
  }
}