Managing accounts

Available since 6.3

Accounts are groups of users or other accounts. Accounts can have sub-accounts (accounts with an account as parent)

Creating an account

To create an account go to Users & Permissions > Accounts tab, click the “Add account” button and fill in the details (if any).

Adding a user to an account

To add a user to an account go to Users & Permissions > Users tab > user > Overview tab > Account field.

Account configuration

Each account has a configuration object that controls settings like default limits, billing flags, and custom properties. Use the Accounts > account > Configuration tab to manage these settings.

Managing accounts via the API

Creating an account

curl -X POST "https://<your-server>/api/v2/accounts" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_KEY>" \
  -d '{
    "name": "Acme Corp",
    "label": "acme-corp"
  }'

Listing accounts

curl "https://<your-server>/api/v2/accounts" \
  -H "Authorization: Bearer <API_KEY>"

Getting account details

curl "https://<your-server>/api/v2/accounts/{accountId}" \
  -H "Authorization: Bearer <API_KEY>"

Getting account configuration

curl "https://<your-server>/api/v2/accounts/{accountId}/config" \
  -H "Authorization: Bearer <API_KEY>"

Updating account configuration

curl -X PATCH "https://<your-server>/api/v2/accounts/{accountId}/config" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_KEY>" \
  -d '{
    "isBillable": true
  }'

Getting account limits

curl "https://<your-server>/api/v2/accounts/{accountId}/limits" \
  -H "Authorization: Bearer <API_KEY>"

Changing account limits

curl -X PATCH "https://<your-server>/api/v2/accounts/{accountId}/actions/change-limits" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_KEY>" \
  -d '{
    "maxServers": 50,
    "maxVMs": 100
  }'

Moving a user to a different account

curl -X POST "https://<your-server>/api/v2/users/{userId}/actions/change-account" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_KEY>" \
  -d '{
    "accountId": 2
  }'

Archiving an account

curl -X POST "https://<your-server>/api/v2/accounts/{accountId}/actions/archive" \
  -H "Authorization: Bearer <API_KEY>"