v13

OpenAPI 3.0.32026-07-31359869.4 MB
environment

Remove a custom environment

Remove a custom environment for the project. Must not be named 'Production' or 'Preview'.

delete/v9/projects/{idOrName}/custom-environments/{environmentSlugOrId}

Path parameters

idOrNamestring required

The unique project identifier or the project name

The unique project identifier or the project name

environmentSlugOrIdstring required

The unique custom environment identifier within the project

The unique custom environment identifier within the project

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

deleteUnassignedEnvironmentVariablesboolean

Delete Environment Variables that are not assigned to any environments.

Response

idstring required

Unique identifier for the custom environment (format: env_*)

slugstring required

URL-friendly name of the environment

type'development' | 'preview' | 'production' required

The type of environment (production, preview, or development)

descriptionstring

Optional description of the environment's purpose

currentDeploymentAliasesstring[]

List of aliases for the current deployment

createdAtnumber required

Timestamp when the environment was created

updatedAtnumber required

Timestamp when the environment was last updated