Org Variables

GET /api/orgs/{org_id}/variables

List Variables

List all user-defined variables for the organization (secrets redacted).

Parameters

Name	In	Type	Required	Description
org_id	path	string (uuid)	yes

Responses

Status	Description	Body
200	Successful Response	OrgVariableResponse[]
422	Validation Error	HTTPValidationError

POST /api/orgs/{org_id}/variables

Create Variable

Create a new user-defined variable.

Parameters

Name	In	Type	Required	Description
org_id	path	string (uuid)	yes

Request body (required)

Field	Type	Required	Description
description	string	no
is_secret	boolean	no
key	string	yes
value	string	no

Responses

Status	Description	Body
201	Successful Response	OrgVariableResponse
422	Validation Error	HTTPValidationError

PUT /api/orgs/{org_id}/variables/{variable_id}

Update Variable

Update the value of a variable.

Parameters

Name	In	Type	Required	Description
org_id	path	string (uuid)	yes
variable_id	path	string (uuid)	yes

Request body (required)

Field	Type	Required	Description
description	string	no
value	string	yes

Responses

Status	Description	Body
200	Successful Response	OrgVariableResponse
422	Validation Error	HTTPValidationError

DELETE /api/orgs/{org_id}/variables/{variable_id}

Delete Variable

Delete a user-defined variable. System variables cannot be deleted.

Parameters

Name	In	Type	Required	Description
org_id	path	string (uuid)	yes
variable_id	path	string (uuid)	yes

Responses

Status	Description	Body
204	Successful Response
422	Validation Error	HTTPValidationError