The quota management API allows team admins to view and distribute quota across teams they manage. Team admins occasionally need to distribute quota across teams they manage. The reasons may vary but they commonly include:
This tutorial will guide you on how to manage quota for teams under your account.
Environment variables supported by commands
Environment Variable | Description |
---|---|
CORALOGIX_API_KEY | Teams API key |
This command returns the daily quota (GB) for the teamId being queried.
Command
cxctl account get-quota
Example:
Command | Description |
---|---|
./cxctl account get-quota --region eu --id 00001 | View daily quota for teamId 00001 |
Options:
Flags | Description | Mandatory / Optional |
---|---|---|
--region region | Coralogix cluster hosting your account. Options are* : - eu - in - us | Mandatory |
--id id | Team Id | Mandatory |
--api-key api-key -k api-key | Teams API key | Optional if key is set in the environment variable CORALOGIX_API_KEY |
*Use eu if account top level domain is .com, in, if it is .in, and us if it is .us.
This command moves quota (GB) from one team to another.
Command:
cxctl account move-quota
you can use any Team API Key of the teams you are moving quota between.
Example:
Command | Description |
---|---|
./cxctl account move-quota --region eu --gb 3 --from 00001 --to 00002 --quiet | * Transfer 3GB from teamId 00001 to teamId 00002. * Suppress the confirmation prompt |
Options:
Flags | Description | Mandatory / Optional |
---|---|---|
--region region | Coralogix cluster hosting your account. Options available are *: - eu - in - us | Mandatory |
--gb size | Size of quota to be transferred (GB). Minimum is 0.001 GB | Mandatory |
--from teamId | Send quota from this Team-Id | Mandatory |
--to teamId | Send quota to this Team-Id | Mandatory |
--quiet | Skip prompt for Y/N confirmation before moving quota | Optional |
--api-key api-key -k api-key | Teams API key | Optional if key is set in the environment variable CORALOGIX_API_KEY |
*Use eu if account top level domain is .com, in, if it is .in, and us if it is .us.