Description: Renames an existing environment in the specified project.
Since: 7.53.1
Security: Requires a Project Admin or a user assigned the Administer the Platform role.
Usage: POST ${baseUrl}/v1/projects/{project_key}/environments/{environment_name}/rename
Sample Request:
{ "new_name": "<string>" }
Note
The maximum length of an environment name is 32 characters.
Sample Response (successful):
{ "new_name": "<string>" }
Sample Response (error):
{ "errors": [ { "code": "<string>", "message": "<string>", "detail": "<string>" }, { "code": "<string>", "message": "<string>", "detail": "<string>" } ] }
Status Codes:
Code | Description |
---|---|
200 | Renamed Successfully |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
409 | Conflict |