Project Environment Variables
5 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/projects/{projectId}/environments/{environmentId}/variables | List environment variables |
| POST | /api/v1/projects/{projectId}/environments/{environmentId}/variables | Create an environment variable |
| GET | /api/v1/projects/{projectId}/environments/{environmentId}/variables/{variableId} | Get an environment variable |
| PATCH | /api/v1/projects/{projectId}/environments/{environmentId}/variables/{variableId} | Update an environment variable |
| DELETE | /api/v1/projects/{projectId}/environments/{environmentId}/variables/{variableId} | Delete an environment variable |
List environment variables
GET/api/v1/projects/{projectId}/environments/{environmentId}/variables
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List environment variables. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to List environment 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 environment variable
POST/api/v1/projects/{projectId}/environments/{environmentId}/variables
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Create an environment variable. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Create an environment variable. |
Request body
required — Request body for: Create an environment variable.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | required | |
| value | string | optional | |
| sourceVariableId | string | optional | |
| sourceVersion | integer | optional | |
| description | one of 2 types | optional | |
| agentId | string | optional | |
| bindingKey | string | 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
|
Get an environment variable
GET/api/v1/projects/{projectId}/environments/{environmentId}/variables/{variableId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Get an environment variable. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Get an environment variable. |
| variableId | string | required | Identifies the environment variable being addressed. Applies to Get an environment 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
|
Update an environment variable
PATCH/api/v1/projects/{projectId}/environments/{environmentId}/variables/{variableId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Update an environment variable. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Update an environment variable. |
| variableId | string | required | Identifies the environment variable being addressed. Applies to Update an environment variable. |
Request body
required — Request body for: Update an environment variable.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
| value | string | optional | |
| sourceVariableId | string | optional | |
| sourceVersion | integer | optional | |
| description | one of 2 types | optional | |
| status | "active" | "disabled" | optional | |
| agentId | string | optional | |
| bindingKey | string | 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 environment variable
DELETE/api/v1/projects/{projectId}/environments/{environmentId}/variables/{variableId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Delete an environment variable. |
| environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Delete an environment variable. |
| variableId | string | required | Identifies the environment variable being addressed. Applies to Delete an environment 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
|
| 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
|