Create a QDS Account

POST /api/v2/accounts/

Use this API to create a QDS 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 creating an account. See Managing Groups and Managing Roles for more information.



Parameters marked in bold below are mandatory. Others are optional and have default values.

Parameter Description
name Name of the account. Provide a name to the account.

This parameter is set to use the account plan. By default, it is set to false. Possible values are true and false with the following implications:

  • Setting the value to true implies that the new account uses the parent account’s plan.
  • The default value set to false implies that the new account uses Qubole’s free trial-period plan.

After enabling the aggressive downscaling feature on the QDS account, the Cluster Idle Timeout can be configured in seconds. Its minimum configurable value is 300 seconds and the default value would still remain 2 hours (that is 120 minutes or 7200 seconds).


This feature is only available on a request. Contact the account team to enable this feature on the QDS account.

idle_session_timeout If there is no activity on the UI, Qubole logs you out after a specified interval. The default value is 1440 minutes (24 hours). Use this option to configure the time interval in minutes if you do not want the default idle session timeout. The maximum value is 10800 minutes (1 week).

Request API Syntax

curl -i -X POST -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"account": {"name":"new_account"}' \ "

Sample Response

  "account_id": “$AccountId”,
  "authentication_token": "$Auth_token",
  "authentication_token_updated_at": "2019-02-19T10:26:31Z",
  "capabilities": 0,
  "created_at": "2019-02-19T10:26:31Z",
  "disabled": false,
  "disabled_at": null,
  "disabled_by": null,
  "id": 23,
  "is_admin": true,
  "is_default": false,
  "is_token_encrypted": true,
  "setting_id": null,
  "setting_type": null,
  "updated_at": "2019-02-19T10:26:31Z",
  "user_id": 12,
  "user_type": "regular",