Skip to content

environments.rename

POST
/environments/{environmentId}/rename
curl --request POST \
--url https://example.com/api/environments/example/rename \
--header 'Content-Type: application/json' \
--data '{ "name": "example" }'

Renames one active environment without changing configuration or deployments. Public docs: /docs/environments/model/#environment-lifecycle

environmentId
required
string
>= 1 characters
Media type application/json
object
name
required
string
>= 1 characters
Example generated
{
"name": "example"
}

OK

Media type application/json
object
id
required
string
Example generated
{
"id": "example"
}