Organization Variables
5 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/organizations/{organizationIdOrSlug}/variables | List organization variables |
| POST | /api/v1/organizations/{organizationIdOrSlug}/variables | Create 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
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to List organization variables. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
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
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Create an organization variable version. |
Request body
required — Request body for: Create an organization variable version.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | required | |
| valueKind | "variable" | "secret" | required | |
| value | string | required | |
| description | one of 2 types | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
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
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Retrieve an organization variable. |
| variableId | string | required | Identifies the environment variable being addressed. Applies to Retrieve an organization variable. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
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
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Replace an organization variable version. |
| variableId | string | required | Identifies 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
| Name | Type | Required | Description |
|---|---|---|---|
| value | string | optional | |
| description | one of 2 types | optional | |
| status | "active" | "disabled" | optional |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
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
| Name | Type | Required | Description |
|---|---|---|---|
| organizationIdOrSlug | string | required | Identifies the organization by its stable identifier or slug. Applies to Delete an organization variable. |
| variableId | string | required | Identifies the environment variable being addressed. Applies to Delete an organization variable. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | The request is malformed or cannot be processed. | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|