Quota Management

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:

  1. Short term re-allocation due to an unexpected spike in logs shipping to team-1 while there is under-utilised quota in team-2.
  2. Re-allocation after reviewing the capacity requirements of your teams. 

This tutorial will guide you on how to manage quota for teams under your account.

Getting started:

  1. Install the latest version of the Coralogix CLI
  2. Teams API key (Fetch this from Account -> Settings -> API access)
  3. Team id (Fetch this from Account -> Settings -> send your logs)
  4. User must have admin role (when moving quota should be admin in both teams)

Constraints:

  1. Minimum quota that can be transferred is 0.001 GB
  2. Quota cannot be moved to a trial account. If needed please contact Coralogix support for help.
  3. Quota can only be moved between teams with the same retention period.
  4. Quota cannot be transferred from a team if the remaining daily quota is less than the quota being moved. In this case, transfer will be possible once the daily quota resets at 00:00 UTC
  5. You need to be admin on the teams you are trying to move quota between.

Environment Variables:

Environment variables supported by commands

Environment VariableDescription
CORALOGIX_API_KEYTeams API key

Get quota

This command returns the daily quota (GB) for the teamId being queried.

Command:

cxctl account get-quota

Example:

CommandDescription
./cxctl account get-quota --region eu --id 00001View daily quota for teamId 00001

Options:

FlagsDescriptionMandatory / Optional
--region regionCoralogix cluster hosting your account. Options are* :
- eu
- in
- us
Mandatory
--id idTeam Id Mandatory
--api-key api-key
-k api-key
Teams API keyOptional 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.

Move quota:

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:

CommandDescription
./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:

FlagsDescriptionMandatory / Optional
--region regionCoralogix cluster hosting your account. Options available are *:
- eu
- in
- us
Mandatory
--gb sizeSize of quota to be transferred (GB). 

Minimum is 0.001 GB
Mandatory
--from teamIdSend quota from this Team-Id Mandatory
--to teamIdSend quota to this Team-Id Mandatory
--quietSkip prompt for Y/N confirmation before moving quotaOptional
--api-key api-key
-k api-key
Teams API keyOptional 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.