Documentation menu

Organization Variables

5 operations.

MethodEndpointDescription
GET/api/v1/organizations/{organizationIdOrSlug}/variablesList organization variables
POST/api/v1/organizations/{organizationIdOrSlug}/variablesCreate an organization variable version
GET/api/v1/organizations/{organizationIdOrSlug}/variables/{variableId}Retrieve an organization variable
PATCH/api/v1/organizations/{organizationIdOrSlug}/variables/{variableId}Replace an organization variable version
DELETE/api/v1/organizations/{organizationIdOrSlug}/variables/{variableId}Delete an organization variable

List organization variables

GET /api/v1/organizations/{organizationIdOrSlug}/variables

List organization variable metadata and immutable versions without returning secret values.

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugone of 2 typesrequiredIdentifies the organization by its stable identifier or slug. For a session, an identifier-shaped value is resolved as a stable identifier. Applies to List organization variables.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)

Create an organization variable version

POST /api/v1/organizations/{organizationIdOrSlug}/variables

Create an immutable organization variable version; secret material is write-only and never returned.

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugone of 2 typesrequiredIdentifies the organization by its stable identifier or slug. For a session, an identifier-shaped value is resolved as a stable identifier. Applies to Create an organization variable version.

Request body

Required — Request body for: Create an organization variable version.

application/json

NameTypeRequiredDescription
namestringrequired
valueKind"variable" | "secret"required
valuestringrequired
descriptionstring | nulloptional

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)

Retrieve an organization variable

GET /api/v1/organizations/{organizationIdOrSlug}/variables/{variableId}

Retrieve one organization variable's metadata and pinned version state without exposing secret values.

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugone of 2 typesrequiredIdentifies the organization by its stable identifier or slug. For a session, an identifier-shaped value is resolved as a stable identifier. Applies to Retrieve an organization variable.
variableIdstringrequiredIdentifies the environment variable being addressed. Applies to Retrieve an organization variable.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)

Replace an organization variable version

PATCH /api/v1/organizations/{organizationIdOrSlug}/variables/{variableId}

Create the next immutable version of an organization variable while preserving metadata-only secret responses.

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugone of 2 typesrequiredIdentifies the organization by its stable identifier or slug. For a session, an identifier-shaped value is resolved as a stable identifier. Applies to Replace an organization variable version.
variableIdstringrequiredIdentifies the environment variable being addressed. Applies to Replace an organization variable version.

Request body

Required — Request body for: Replace an organization variable version.

application/json

NameTypeRequiredDescription
valuestringoptional
descriptionstring | nulloptional
status"active" | "disabled"optional

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)

Delete an organization variable

DELETE /api/v1/organizations/{organizationIdOrSlug}/variables/{variableId}

Delete an organization variable after ownership checks; secret values are never exposed.

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugone of 2 typesrequiredIdentifies the organization by its stable identifier or slug. For a session, an identifier-shaped value is resolved as a stable identifier. Applies to Delete an organization variable.
variableIdstringrequiredIdentifies the environment variable being addressed. Applies to Delete an organization variable.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)