Delete an environment. Production environments need the `env-delete-protected` permission and are purged after a grace period.

DELETE

/api/v1/projects/{project}/environments/{environment}

const url = 'https://example.com/api/v1/projects/example/environments/example';
const options = {method: 'DELETE'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/api/v1/projects/example/environments/example

Parameters

Path Parameters

project

required

string

Project name

environment

required

string

Environment short name

Responses

202

Deletion accepted

403

application/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

404

application/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}