Skip to main content

Endpoint

Authentication

Requires a Personal API Access Token.

Request

Headers

Path Parameters

Request Body

Same structure as Create Environment Variable. See Create Environment Variable for field descriptions.

Important Notes

  • name in path is the current name (used to find the variable)
  • name in body can be different (to rename the variable)
  • If renaming, new name must be unique
  • All fields can be updated

Response

Same as Create Environment Variable. See Create Environment Variable for response format.

cURL Example

Permissions

  • User must have SECRETS + MANAGE permission in the project

Notes and Warnings

  • Name Change:
    • Variable can be renamed by providing different name in body
    • New name must be unique
  • Variable Must Exist:
    • Variable with specified name must exist
  • Automatic Deployment:
    • Variable is automatically deployed after update