Intake budgets - MoleSignal Docs

curl -X POST "http://localhost:5080/api/v1/streams/budgets" \
  -H "authorization: Bearer $MS_TOKEN" \
  -H "content-type: application/json" \
  -d '{"dimension":"stream","source_key":"logs:app","period":"day","limit_size":102400}'

curl -X POST "http://localhost:5080/api/v1/streams/budgets" \
  -H "authorization: Bearer $MS_TOKEN" \
  -H "content-type: application/json" \
  -d '{"dimension":"stream","source_key":"logs:app","period":"day","limit_size":102400}'

A budget only tells people when a source nears or passes it: intake answers and stores the same. See Intake usage and budgets.

List budgets

GET /api/v1/streams/budgets

Returns every budget of the organization with the label of its source and how it stands in the period under way. Requires intake_usage.read, or sys.telemetry.read in the _sys organization. Figures that are not known are null.

Set a budget

POST /api/v1/streams/budgets

Sets the budget of a source. A source has one at most: setting it again changes that one. Requires intake_budgets.manage. The _sys organization cannot set budgets.

Field	Required	Notes
`dimension`	Yes	`credential`, `stream`, or `service`.
`source_key`	Yes	The source, as Intake usage gives it. The platform’s own telemetry, events that name no service, and the services past the limit cannot take a budget.
`period`	Yes	`day` or `month`, by the calendar in UTC.
`limit_size`	Yes	In MiB, from 1 to 1073741824.
`warn_percent`	No	The share of the limit to warn at, from 0 to 99. `0` warns only when it is used up. Default: 80.
`notify_user_ids`	No	Members of the organization to tell, at most 50. Default: the person setting the budget. A service account must name them.

curl -X POST "http://localhost:5080/api/v1/streams/budgets" \
  -H "authorization: Bearer $MS_TOKEN" \
  -H "content-type: application/json" \
  -d '{"dimension":"stream","source_key":"logs:app","period":"day","limit_size":102400}'

Remove a budget

DELETE /api/v1/streams/budgets/{budget_id}

Returns 204. Requires intake_budgets.manage.

Last modified on October 31, 2026