secrets.environments.updateRename an environment, move it in the promotion order or change its colour
Request syntax
PATCH /secrets/api/environments/{id}
{
"name": "string",
"position": "number",
"color": "enum"
}Path parameters
idRequiredstring
Constraints: uuid
Request body
nameOptionalstring
New display name, 1 to 64 characters. Omitted: unchanged. The slug cannot change.
Constraints: 1-64 chars
positionOptionalnumber
New place in the promotion order, 0 to 10000; higher is later. Omitted: unchanged.
Constraints: integer, 0-10000
colorOptionalenum
The dot shown beside the environment: gray, blue, teal, green, amber, red or violet. Null: automatic (from the slug).
One of:
gray,blue,teal,green,amber,red,violetMay be null.
Response
200 with the environment: id, slug, name, position, color, effectiveColor, createdAt.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow secrets:UpdateSecretEnvironment on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud secrets environments update idcurl -X PATCH "https://console.platform-development.deutschecloud.app/secrets/api/environments/id" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_secrets_environments_update.