Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
ingestBudgetManagementV2

Update an ingest budget.

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

put/v2/ingestBudgets/{id}

Path parameters

idstring required

Identifier of the ingest budget to update.

Request body

namestring required

Display name of the ingest budget.

scopestring 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=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

capacityBytesinteger 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.

timezonestring

Time zone of the reset time for the ingest budget. Follow the format in the IANA Time Zone Database.

resetTimestring

Reset time of the ingest budget in HH:MM format.

descriptionstring

Description of the ingest budget.

actionstring required

Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are:

  • stopCollecting
  • keepCollecting
auditThresholdinteger

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

Example request

{
  "name": "Developer Budget",
  "scope": "_sourceCategory=*prod*nginx*",
  "capacityBytes": 1000,
  "timezone": "America/Los_Angeles",
  "resetTime": "23:30",
  "action": "stopCollecting",
  "auditThreshold": 85
}

Response

The ingest budget was successfully modified.

namestring required

Display name of the ingest budget.

scopestring 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=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

capacityBytesinteger 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.

timezonestring

Time zone of the reset time for the ingest budget. Follow the format in the IANA Time Zone Database.

resetTimestring

Reset time of the ingest budget in HH:MM format.

descriptionstring

Description of the ingest budget.

actionstring required

Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are:

  • stopCollecting
  • keepCollecting
auditThresholdinteger

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

idstring required

Unique identifier for the ingest budget.

usageBytesinteger

Current usage since the last reset, in bytes.

usageStatusstring

Status of the current usage. Can be Normal, Approaching, Exceeded, or Unknown (unable to retrieve usage).

createdAtstring date-time required

The creation timestamp in UTC of the Ingest Budget.

createdBystring required

The identifier of the user who created the Ingest Budget.

modifiedAtstring date-time required

The modified timestamp in UTC of the Ingest Budget.

modifiedBystring required

The identifier of the user who modified the Ingest Budget.

budgetVersioninteger

The version of the Ingest Budget

Example response

{
  "name": "Developer Budget",
  "scope": "_sourceCategory=*prod*nginx*",
  "capacityBytes": 1000,
  "timezone": "America/Los_Angeles",
  "resetTime": "23:30",
  "action": "stopCollecting",
  "auditThreshold": 85,
  "id": "0000000003343FDD",
  "usageBytes": 900,
  "usageStatus": "Approaching",
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000001243FDD",
  "budgetVersion": 2
}