|
| 1 | +--- |
| 2 | +id: scan-budget |
| 3 | +title: Scan Budgets Management APIs |
| 4 | +sidebar_label: Scan Budgets |
| 5 | +description: Scan Budgets Management V2 APIs allow you to manage metadata-based scan budgets from HTTP endpoints. |
| 6 | +--- |
| 7 | + |
| 8 | +import useBaseUrl from '@docusaurus/useBaseUrl'; |
| 9 | +import ApiIntro from '../reuse/api-intro.md'; |
| 10 | +import ApiRoles from '../reuse/api-roles.md'; |
| 11 | + |
| 12 | +<img src={useBaseUrl('img/icons/operations/data-volume.png')} alt="Thumbnail icon" width="50"/> |
| 13 | + |
| 14 | +The Ingest Budget Management V2 APIs allow you to manage metadata-based [ingest budgets](/docs/manage/ingestion-volume/ingest-budgets) (with a scope) from HTTP endpoints. |
| 15 | + |
| 16 | +You can use [V1 APIs](/docs/api/ingest-budget-v1) to manage ingest budgets with a Field Value. |
| 17 | + |
| 18 | +:::note |
| 19 | +[V1 budgets](/docs/api/ingest-budget-v1) will be deprecated September 16, 2024. |
| 20 | +::: |
| 21 | + |
| 22 | +## Prerequisites |
| 23 | + |
| 24 | +| Account Type | Account Level | |
| 25 | +|:--------------|:--------------| |
| 26 | +| Credits | Enterprise Suite | |
| 27 | + |
| 28 | +## Documentation |
| 29 | + |
| 30 | +<ApiIntro/> |
| 31 | + |
| 32 | +| Deployment | Documentation URL | |
| 33 | +|:------------|:------------------------------------------------------------------| |
| 34 | +| AU | https://api.au.sumologic.com/docs/#tag/ingestBudgetManagementV2 | |
| 35 | +| CA | https://api.ca.sumologic.com/docs/#tag/ingestBudgetManagementV2 | |
| 36 | +| DE | https://api.de.sumologic.com/docs/#tag/ingestBudgetManagementV2 | |
| 37 | +| EU | https://api.eu.sumologic.com/docs/#tag/ingestBudgetManagementV2 | |
| 38 | +| FED | https://api.fed.sumologic.com/docs/#tag/ingestBudgetManagementV2 | |
| 39 | +| IN | https://api.in.sumologic.com/docs/#tag/ingestBudgetManagementV2 | |
| 40 | +| JP | https://api.jp.sumologic.com/docs/#tag/ingestBudgetManagementV2 | |
| 41 | +| KR | https://api.kr.sumologic.com/docs/#tag/ingestBudgetManagementV2 | |
| 42 | +| US1 | https://api.sumologic.com/docs/#tag/ingestBudgetManagementV2 | |
| 43 | +| US2 | https://api.us2.sumologic.com/docs/#tag/ingestBudgetManagementV2 | |
| 44 | + |
| 45 | +To manage ingest budgets, you must have the **Manage Ingest Budgets** role capability. Enabling this will automatically enable the **Manage Collectors** capability. The Manage Collectors capability on its own permits the re-assignment of budgets to different Collectors, but not creating or deleting them. For more information, see [Ingest Budgets](/docs/manage/manage-subscription/usage-management). |
0 commit comments