Delete a Group
- DELETE /api/v1.2/groups/<group-id>
This API is used to delete an existing group on QDS.
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 a group. See Managing Groups and Managing Roles for more information.
Parameters
Note
Parameters marked in bold are mandatory. Others are optional and have default values.
Parameter |
Description |
---|---|
<group-id> |
ID/name of the group that needs to be deleted |
Request API Syntax
Here is the request API syntax.
curl -X DELETE -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{}' "https://api.qubole.com/api/v1.2/groups/<group-id>"
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 Request
Here is a sample request.
curl -X DELETE -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{}' "https://api.qubole.com/api/v1.2/groups/2192"
Sample Response
Success
"status":"success"