Update an organisation variable

Partially updates the variable: each of value, description (null clears it) and is_secret is applied only when present, so a description or the secret flag can change without the value. Needs variables.write. Answers 404 when it does not exist and 403 for a platform-owned name.

PUT /api/v1/org/variables/{variable_name}

Update an organisation variable

Python

import requests

url = "https://platform.ankra.app/api/v1/org/variables/{variable_name}"

payload = {
    "description": "<string>",
    "is_secret": True,
    "value": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

200

{
  "variable": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "is_secret": true,
    "name": "<string>",
    "organisation_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "value": "<string>",
    "description": "<string>",
    "project_id": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Path Parameters

variable_name · string · required

Body

application/json

description · string | null

is_secret · boolean | null

value · string

Omit to keep the stored value.

Response

200

application/json

Successful Response

variable · OrganisationVariable · object · required

Show child attributes