Documentation menu
Project Environment Variables

Update an environment variable

PATCH /api/v1/projects/{projectId}/environments/{environmentId}/variables/{variableId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Update an environment variable.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Update an environment variable.
variableIdstringrequiredIdentifies the environment variable being addressed. Applies to Update an environment variable.

Request body

Required — Request body for: Update an environment variable.

application/json

NameTypeRequiredDescription
valuestringoptional
sourceVariableIdstringoptional
sourceVersionintegeroptional
descriptionstring | nulloptional
status"active" | "disabled"optional
agentIdstringoptional
bindingKeystringoptional

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)