Delete a Environment

Path

DELETE /api/v1/forward/environments/{id}

Header	Required	Description
`Authorization`	Yes	`Bearer <PAT or SAT>`

Checks Template references before deletion. If unreferenced, the Environment is deleted and no longer appears in default listings.

Parameter	Type	Required	Description
`id`	string	Yes	Environment ID.

Parameter	Type	Required	Description
`identity_id`	string	No	Optional; used only for Identity-owned resources. PAT callers can pass it explicitly; omitting it uses the administrator scope. For SAT, issue an Identity-scoped token and do not explicitly pass this parameter, or the request returns HTTP 400. See Identity ownership.

curl -X DELETE "https://api.qoder.com/api/v1/forward/environments/env_xxx" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

{
  "id": "env_xxx",
  "type": "environment_deleted",
  "deleted": true
}

Field	Type	Description
`id`	string	ID of the deleted resource.
`type`	string	Deletion result type.
`deleted`	boolean	Whether the resource was deleted.

HTTP	Type	Trigger
400	`invalid_request_error`	The request body, path parameters, or pagination parameters are invalid. Also returned if SAT explicitly includes `identity_id`.
401	`authentication_error`	The authentication token is missing or invalid.
403	`permission_error`	Owner mismatch for a PAT without `identity_id` or an Admin SAT, or other insufficient permissions.
404	`not_found_error`	The Environment does not exist, is not registered, or is not visible. `identity_id` is invalid, disabled, or does not belong to the caller, or the target resource does not belong to the current Identity scope.
409	`conflict_error`	The idempotency key conflicts, create recovery requires manual intervention, or the resource is still referenced during deletion.
500/502/503	`api_error`	Forward or a dependent service failed.