Delete a Package Management Environment

DELETE /api/v1.2/package/<env ID>/delete_environment

Use this API to delete a Package Management environment. You can only delete an environment when its attached cluster is down/inactive. After the environment is deleted, its attached cluster gets detached automatically.

Required Role

The following users can make this API call:

  • Users who belong to the system-user or system-admin group.

  • Users who belong to a group associated with a role that allows deleting an environment. See Managing Groups and Managing Roles for more information.

Parameters

None

Request API Syntax

curl -X DELETE -H "X-AUTH-TOKEN: <API-TOKEN>" -H "Content-Type: application/json" -H "Accept: application/json" \
"https://api.qubole.com/api/v1.2/package/<env ID>/delete_environment"

Note

The above syntax uses https://api.qubole.com as the endpoint. Qubole provides other endpoints to access QDS that are described in Supported Qubole Endpoints on Different Cloud Providers.

Sample API Request

Here is a sample to delete the environment with 140 as its ID.

curl -X DELETE -H "X-AUTH-TOKEN: <API-TOKEN>" -H "Content-Type: application/json" -H "Accept: application/json" \
"https://api.qubole.com/api/v1.2/package/140/delete_environment"