delete(project: string, environment: string, options?: ProductScope): Promise<DeletedEnvironmentResource>Soft-deletes an environment along with every variable in it, in one transaction, and takes its published versions out of reach with it. There is no guard on a non-empty environment and no undo over the API, so put your own confirmation in front of it.
The response is a tombstone, not the environment shape: id, name, slug, projectId and a deletedVariables count, with no createdAt, exposed or updatedAt. The slot it frees counts back against the per-project environment allowance right away, so a create that was failing with 402 can succeed immediately after.
Example
const deleted = await envless.environments.delete('api', 'staging')
console.log(deleted.id, deleted.projectId, deleted.deletedVariables)Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
project | string | Yes | Project slug or uniqueId that owns the environment. |
environment | string | Yes | Environment slug; ids are not accepted. |
options.product | string | No | Product slug that disambiguates an ambiguous project slug. |
options.signal | AbortSignal | No | Cancels the request. |
Returns
DeletedEnvironmentResource carrying id, name, slug, projectId and deletedVariables.
Worth knowing
deletedVariablescounts live variables only. Version snapshots are not deleted and are not counted, they simply stop resolving once the environment is gone.- Deleting the last environment in a project is allowed; the project itself stays.
- Capture the
slugyou passed before the call if you need it for an audit trail, since the tombstone is all you get back.
Required scopes
environments:write
Underlying endpoint
DELETE /projects/{slug}/environments/{environmentSlug}
Request and response schema, every error code, and a live playground.
In Python
envless.environments.delete()
The same method in envless-sdk, the Python SDK, with the same request, retries and errors.
In Ruby
Envless.environments.delete
The same method in envless-sdk, the Ruby gem, with the same request, retries and errors.
In PHP
$envless->environments->delete()
The same method in envless/sdk, the PHP SDK, with the same request, retries and errors.