Update a workspace variable (admin)

put/workspaces/{workspaceId}/variables/{variableId}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/workspaces/{workspaceId}/variables/{variableId}
  • Auth: HTTP bearer

Path parameters

workspaceIdstring required
variableIdstring required

Request body

keystring required
valuestring required
sensitiveboolean required
category'terraform' | 'env' required
descriptionstring

Response

Updated variable

idstring required
workspace_idstring required
org_idstring required
keystring required
valuestring required
sensitiveboolean required
category'terraform' | 'env' required
descriptionstring required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 14 revisions of this API.