1. Docs
  2. API Reference
  3. Rename or re-slug an Environment

Rename or re-slug an Environment

PATCH/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}

Updates an Environment's lifecycle fields, identified by :envSlug: name, slug, and the one-way is_production promotion. Omitted fields are left unchanged. Sign-in settings are a separate authority and live on the auth-settings endpoint. Re-slugging to a value already used by another Environment in the Application returns 409, and a missing slug returns 404. Emits an environment.updated audit event.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability applications.manageDeveloper Console

Create, edit, and delete Applications and Environments. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

Request body

application/json

namestring Optional
slugstring Optional
is_productionboolean Optional

Mark this Environment as holding real end users. One-way: `true` promotes it and is permanent; sending `false` for an Environment already marked production is rejected with 400. Demotion is the only change that would expose real people to anyone with Console access.

Responses

application/json

  • dataEnvironmentResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

EnvironmentResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "slug": "string",
    "is_production": false
  }'
Response
{
  "data": {
    "id": "string",
    "application_id": "string",
    "name": "string",
    "slug": "string",
    "is_production": false,
    "settings": {},
    "version": 0,
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList Environments in an Application
POSTCreate a new Environment in an Application
GETGet a single Environment by slug
DELETEDelete an Environment
GETGet an Environment's sign-in settings
PATCHChange an Environment's sign-in settings
GETGet an Environment's branding
PATCHChange an Environment's branding
GETExport an Environment's configuration as JSON
POSTReplace an Environment's configuration from a JSON payload (destructive)
GETGet the Environment's access model
PUTSwitch the Environment's access model
PUTSwitch the Environment's organizations container on or off
GETGet hierarchy schema for the active Environment
PATCHUpdate hierarchy schema for the active Environment
GETList hierarchy node types with existing nodes
POSTRevert this Environment from hierarchy to flat
 Was this page helpful?

Tell us how we can improve this guide.

Canopy