Suspend and Resume a QDS Account

You can suspend and resume a QDS account through a REST API call.

Suspend a QDS Account

PUT /api/v1.2/accounts/suspend

You can now temporarily suspend an account and block access to non-system-admin users. Only system-admins can work on the suspended account.

Required Role

The following users can make this API call:

  • Users who belong to the system-admin group.
  • Users who belong to a group associated with a role that allows suspending an account. See Managing Groups and Managing Roles for more information.

Request API Syntax

Here is the syntax for an API request.

curl -X PUT -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"id":"<account_id>"}' \ "https://api.qubole.com/api/v1.2/accounts/suspend"

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 to suspend the account with ID 3002.

curl -X PUT -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"id":"3002"}' \ "https://api.qubole.com/api/v1.2/accounts/suspend"

Resume a QDS Account

PUT /api/v1.2/accounts/resume

A system-admin can resume the suspended account and thus restore access to other users.

Required Role

The following users can make this API call:

  • Users who belong to the system-admin group.
  • Users who belong to a group associated with a role that allows resuming a suspended account. See Managing Groups and Managing Roles for more information.

Request API Syntax

Here is the syntax for an API request.

curl -X PUT -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"id":"<account_id>"}' \ "https://api.qubole.com/api/v1.2/accounts/resume"

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 to resume the suspended account with ID 3002.

curl -X PUT -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"id":"3002"}' \ "https://api.qubole.com/api/v1.2/accounts/resume"