Last Updated: Apr. 04, 2024
Manage team quotas in your Coralogix account using the following tutorial.
Overview
The quota management API allows team administrators to view and distribute quotas across teams they manage. Allocate and move quotas across teams for any period to:
- Contend with unexpected spikes in logs shipping to one team
- Better handle resources when a team is underutilizing its quota
- Meet new or changing capacity requirements of your teams
- Save on cost by more efficiently using quotas
Prerequisites
- The latest version of the Coralogix CLI
- Teams API key (Access this in Account settings > API Access)
- Team ID (Access this in Account settings > Send Your Logs)
- Team administrator (admin) role granted to the person moving quotas between teams (He / she must be team admin in both the team receiving and giving the quota)
Limitations & Constraints
- The minimum quota that can be transferred is 0.001 GB.
- A quota cannot be moved to a trial account.
- Quotas can only be moved between teams with the same retention period.
- Quotas 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
- You need to be admin on the teams you are trying to move quota between.
- Quota allocations will take a maximum of 15 minutes to take effect.
Environment Variables
The following table displays environment variables supported by commands.
| Environment Variable | Description |
| CORALOGIX_API_KEY | Alerts, Rules & Tags API key |
Get Quota
Command
This command returns the daily quota (GB) for the teamId being queried:
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
-r region | Coralogix cluster hosting your account. Options are* :
- eu (EU1)
- se (EU2)
- us1 (US1)
- us2 (US2)
- in (API1)
- sg (AP2) | Mandatory |
| --id id | Team ID | Mandatory |
--api-key api-key
-k api-key | Alerts, Rules & Tags 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.
Move Quota
Command
This command moves quota (GB) from one team to another:
cxctl account move-quota
You may use the Alerts, Rules & Tags API key for any of the teams between whom you are moving quotas.
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 (EU1)
- se (EU2)
- us (US1)
- in (API1)
- sg (AP2) | 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.
Support
Need help?
Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.
Feel free to reach out to us via our in-app chat or by sending us an email at [email protected].
Oh no!We didn’t find anything for “”,
