Create an organisation variable

Creates an organisation-wide variable with a name, value and optional description and returns it. Answers 409 when a variable with that name already exists.

POST /api/v1/org/variables

Create an organisation variable

Python

import requests

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

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

response = requests.post(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

Body

application/json

name · string · required

value · string · required

description · string | null

is_secret · boolean · default: false

project_id · string<uuid4> | null

The layer the variable is created in. Omitted: the caller's current project (organisation-wide while the organisation has projects off). null: organisation-wide, seen by every project. A project id: that project's own layer, which shadows an organisation-wide variable of the same name for the clusters the project holds.

Response

200

application/json

Successful Response

variable · OrganisationVariable · object · required

Show child attributes