---
title: "Update an ingest budget."
method: PUT
path: "/v2/ingestBudgets/{id}"
tags: ["ingestBudgetManagementV2"]
---

# Update an ingest budget.

`PUT /v2/ingestBudgets/{id}`

Update an existing ingest budget. All properties specified in the request are required.

## Path parameters

- `id` string, required

## Request body

- IngestBudgetDefinitionV2
  - `name` string, required — Display name of the ingest budget.
  - `scope` string, required — 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=*prod*payment*, 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
  - `capacityBytes` integer, required — 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 `dailyVolume` budgetType the capacity specified is in bytes/day whereas for `minuteVolume` budgetType its bytes/min.
  - `timezone` string — Time zone of the reset time for the ingest budget. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
  - `resetTime` string — Reset time of the ingest budget in HH:MM format.
  - `description` string — Description of the ingest budget.
  - `action` string, required — Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are: * `stopCollecting` * `keepCollecting`
  - `auditThreshold` integer — The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

## Response `200`

The ingest budget was successfully modified.

- IngestBudgetV2
  - `name` string, required — Display name of the ingest budget.
  - `scope` string, required — 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=*prod*payment*, 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
  - `capacityBytes` integer, required — 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 `dailyVolume` budgetType the capacity specified is in bytes/day whereas for `minuteVolume` budgetType its bytes/min.
  - `timezone` string — Time zone of the reset time for the ingest budget. Follow the format in the [IANA Time Zone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
  - `resetTime` string — Reset time of the ingest budget in HH:MM format.
  - `description` string — Description of the ingest budget.
  - `action` string, required — Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are: * `stopCollecting` * `keepCollecting`
  - `auditThreshold` integer — The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
  - `id` string, required — Unique identifier for the ingest budget.
  - `usageBytes` integer — Current usage since the last reset, in bytes.
  - `usageStatus` string — Status of the current usage. Can be `Normal`, `Approaching`, `Exceeded`, or `Unknown` (unable to retrieve usage).
  - `createdAt` string, date-time, required — The creation timestamp in UTC of the Ingest Budget.
  - `createdBy` string, required — The identifier of the user who created the Ingest Budget.
  - `modifiedAt` string, date-time, required — The modified timestamp in UTC of the Ingest Budget.
  - `modifiedBy` string, required — The identifier of the user who modified the Ingest Budget.
  - `budgetVersion` integer — The version of the Ingest Budget

## Other responses

- `default` — Operation failed with an error.

---

[API](https://skmtc.net/sumologic/apis/sumo-logic-api.md) · [All operations](https://skmtc.net/sumologic/apis/sumo-logic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumologic/sumo-logic-api/revisions/e4e4c7554890/schema)