Skip to main content
PATCH
/
variables
/
{variableId}
Update Variable
curl --request PATCH \
  --url https://eu-gcp-api.vg-stuff.com/v3/variables/{variableId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variable": {
    "in": "<string>",
    "type": "string",
    "value": "<unknown>",
    "defaultValue": "<unknown>",
    "key": "<string>",
    "description": "<string>",
    "required": true,
    "reusable": true,
    "isEnv": true,
    "isSystem": true,
    "isGlobal": true
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "in": "<string>",
    "type": "string",
    "value": "<unknown>",
    "defaultValue": "<unknown>",
    "key": "<string>",
    "description": "<string>",
    "required": true,
    "reusable": true,
    "isEnv": true,
    "isSystem": true,
    "isGlobal": true,
    "agentId": "<string>",
    "userId": "<string>"
  }
}

​
Example Request

{
  "variable": {
    "value": "John Doe",
    "description": "Updated description"
  }
}
Uses partial updates - only provided fields are changed. The key cannot be modified after creation.
Update value to set a variable’s current value, or defaultValue to change its initial state.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
variableId
string
required

The unique identifier of the variable to update

Body

application/json
​
variable
object
required

Variable fields to update

Response

Successful response

​
success
boolean
required
​
message
string
required
​
data
object
required