Environment

Delete environment

Deletes an environment permanently. Provide the environment ID in the path to remove the specified environment.

State requirement: This operation requires the environment to have no attached child resources. Delete or move VMs, volumes, keypairs, firewalls, snapshots, and any other environment-scoped resources first.

delete/core/environments/{id}

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/environments/{id}
  • Auth: API key in header api_key

Path parameters

idinteger required

ID of the environment.

Response

The environment has been successfully deleted.

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

Example response

{
  "status": true,
  "message": "Instance is being deleted."
}

Changes

No recorded changes to this operation across all 1 revision of this API.