PATCH/projects/{uuid}/environments/{environment_name_or_uuid}

Update Environment

Update environment by name or UUID within a project.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 2 body fields
uuidstringrequired
Project UUID
environment_name_or_uuidstringrequired
Environment name or UUID

Environment fields to update.

descriptionstringoptional
The description of the environment.
namestringoptional
The name of the environment.

6 status codes
200Environment updated.
descriptionstringoptional
namestringoptional
uuidstringoptional
400Invalid token.
messagestringoptional
401Unauthenticated.
messagestringoptional
404Project or environment not found.
409Environment with this name already exists.
422Validation error.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned: Invalid token. A 401 is returned: Unauthenticated. A 404 is returned: Project or environment not found. A 409 is returned: Environment with this name already exists. A 422 is returned: Validation error.