PUT /v2/ingestBudgets/{id}
Update an existing ingest budget. All properties specified in the request are required.
Servers
- https://api.au.sumologic.com/api/
- https://api.ca.sumologic.com/api/
- https://api.de.sumologic.com/api/
- https://api.eu.sumologic.com/api/
- https://api.fed.sumologic.com/api/
- https://api.jp.sumologic.com/api/
- https://api.kr.sumologic.com/api/
- https://api.in.sumologic.com/api/
- https://api.sumologic.com/api/
- https://api.us2.sumologic.com/api/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Identifier of the ingest budget to update. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
capacityBytes |
Integer | Yes |
Capacity of the ingest budget, in bytes. It takes a few minutes for Collectors to stop collecting when capacity is reached. We recommend setting a soft limit that is lower than your needed hard limit. The capacity bytes unit varies based on the budgetType field. For |
timezone |
String | No |
Time zone of the reset time for the ingest budget. Follow the format in the IANA Time Zone Database. Default value: "Etc/UTC" |
resetTime |
String | No |
Reset time of the ingest budget in HH:MM format. Default value: "00:00" |
name |
String | Yes |
Display name of the ingest budget. |
description |
String | No |
Description of the ingest budget. |
action |
String | Yes |
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are:
|
scope |
String | Yes |
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table. Value supports wildcard. e.g. _sourceCategory=prodpayment*, cluster=kafka. If the scope is defined _sourceCategory=nginx in this budget will be applied on messages having fields _sourceCategory=prod/nginx, _sourceCategory=dev/nginx, or _sourceCategory=dev/nginx/error |
auditThreshold |
Integer | No |
The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.