Ingest Budget management API V2. Ingest Budgets V2 provide you the ability to create and assign budgets to your log data by Fields instead of using a Field Value. For more information, see [Metadata Ingest Budgets](https://help.sumologic.com/?cid=52352).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/sumo-logic-ingestbudgetmanagementv2-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Sumo Logic Ingest Budget Management V2 API
description: '# Getting Started
Welcome to the Sumo Logic API reference.'
version: 1.0.0
x-logo:
url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
description: CA deployment API server
- url: https://api.de.sumologic.com/api/
description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
description: KR deployment API server
- url: https://api.in.sumologic.com/api/
description: IN deployment API server
- url: https://api.sumologic.com/api/
description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: ingestBudgetManagementV2
description: 'Ingest Budget management API V2.
Ingest Budgets V2 provide you the ability to create and assign budgets to your log data by Fields instead of using a Field Value. For more information, see Metadata Ingest Budgets.'
x-displayName: Ingest Budgets V2
paths:
/v2/ingestBudgets:
get:
tags:
- ingestBudgetManagementV2
summary: Get A List Of Ingest Budgets
description: Get a list of all ingest budgets. The response is paginated with a default limit of 100 budgets per page.
operationId: listIngestBudgetsV2
parameters:
- name: limit
in: query
description: Limit the number of budgets returned in the response. The number of budgets returned may be less than the `limit`.
required: false
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
default: 100
- name: token
in: query
description: Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results.
required: false
schema:
type: string
responses:
'200':
description: A paginated list of budgets.
content:
application/json:
schema:
$ref: '#/components/schemas/ListIngestBudgetsResponseV2'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- ingestBudgetManagementV2
summary: Create A New Ingest Budget
description: Create a new ingest budget.
operationId: createIngestBudgetV2
parameters: []
requestBody:
description: Information about the new ingest budget.
content:
application/json:
schema:
$ref: '#/components/schemas/IngestBudgetDefinitionV2'
required: true
responses:
'200':
description: The ingest budget has been created.
content:
application/json:
schema:
$ref: '#/components/schemas/IngestBudgetV2'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/ingestBudgets/{id}:
get:
tags:
- ingestBudgetManagementV2
summary: Get An Ingest Budget
description: Get an ingest budget by the given identifier.
operationId: getIngestBudgetV2
parameters:
- name: id
in: path
description: Identifier of ingest budget to return.
required: true
schema:
type: string
responses:
'200':
description: Ingest budget object that was requested.
content:
application/json:
schema:
$ref: '#/components/schemas/IngestBudgetV2'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- ingestBudgetManagementV2
summary: Update An Ingest Budget
description: Update an existing ingest budget. All properties specified in the request are required.
operationId: updateIngestBudgetV2
parameters:
- name: id
in: path
description: Identifier of the ingest budget to update.
required: true
schema:
type: string
requestBody:
description: Information to update about the ingest budget.
content:
application/json:
schema:
$ref: '#/components/schemas/IngestBudgetDefinitionV2'
required: true
responses:
'200':
description: The ingest budget was successfully modified.
content:
application/json:
schema:
$ref: '#/components/schemas/IngestBudgetV2'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- ingestBudgetManagementV2
summary: Delete An Ingest Budget
description: Delete an ingest budget with the given identifier.
operationId: deleteIngestBudgetV2
parameters:
- name: id
in: path
description: Identifier of the ingest budget to delete.
required: true
schema:
type: string
responses:
'204':
description: The ingest budget was deleted successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/ingestBudgets/{id}/usage/reset:
post:
tags:
- ingestBudgetManagementV2
summary: Reset Usage
description: Reset ingest budget's current usage to 0 before the scheduled reset time. This is only applicable to `dailyVolume` budgetType.
operationId: resetUsageV2
parameters:
- name: id
in: path
description: Identifier of the ingest budget to reset usage.
required: true
schema:
type: string
responses:
'200':
description: Ingest budget's usage was reset successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ErrorResponse:
required:
- errors
- id
type: object
properties:
id:
type: string
description: An identifier for the error; this is unique to the specific API request.
example: IUUQI-DGH5I-TJ045
errors:
type: array
description: A list of one or more causes of the error.
example:
- code: auth:password_too_short
message: Your password was too short.
- code: auth:password_character_classes
message: Your password did not contain any non-alphanumeric characters
items:
$ref: '#/components/schemas/ErrorDescription'
ErrorDescription:
required:
- code
- message
type: object
properties:
code:
type: string
description: An error code describing the type of error.
example: auth:password_too_short
message:
type: string
description: A short English-language description of the error.
example: Your password was too short.
detail:
type: string
description: An optional fuller English-language description of the error.
example: Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.
meta:
type: object
description: An optional list of metadata about the error.
example:
minLength: 12
actualLength: 5
IngestBudgetDefinitionV2:
required:
- action
- capacityBytes
- name
- scope
type: object
properties:
name:
maxLength: 128
minLength: 1
type: string
description: Display name of the ingest budget.
example: Developer Budget
scope:
maxLength: 1024
minLength: 1
type: string
description: 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
example: _sourceCategory=*prod*nginx*
capacityBytes:
minimum: 1
type: integer
description: 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.
format: int64
example: 1000
timezone:
type: string
description: 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).
example: America/Los_Angeles
default: Etc/UTC
resetTime:
maxLength: 5
minLength: 5
type: string
description: Reset time of the ingest budget in HH:MM format.
example: 1410
default: 00:00
description:
maxLength: 1024
minLength: 0
type: string
description: Description of the ingest budget.
action:
pattern: ^(keepCollecting|stopCollecting)$
type: string
description: "Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are:\n * `stopCollecting`\n * `keepCollecting`"
example: stopCollecting
x-pattern-message: must be either `keepCollecting` or `stopCollecting`
auditThreshold:
maximum: 99
minimum: 1
type: integer
description: The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
format: int32
example: 85
IngestBudgetV2:
type: object
allOf:
- $ref: '#/components/schemas/IngestBudgetDefinitionV2'
- required:
- createdAt
- createdBy
- id
- modifiedAt
- modifiedBy
- version
properties:
id:
type: string
description: Unique identifier for the ingest budget.
example: 0000000003343FDD
usageBytes:
type: integer
description: Current usage since the last reset, in bytes.
format: int64
example: 900
usageStatus:
pattern: ^(Normal|Approaching|Exceeded|Unknown)$
type: string
description: Status of the current usage. Can be `Normal`, `Approaching`, `Exceeded`, or `Unknown` (unable to retrieve usage).
example: Approaching
x-pattern-message: must be either `Normal`, `Approaching`, `Exceeded`, or `Unknown`
createdAt:
type: string
description: The creation timestamp in UTC of the Ingest Budget.
format: date-time
example: 2018-10-16 09:10:00+00:00
createdBy:
type: string
description: The identifier of the user who created the Ingest Budget.
example: 0000000006743FDD
modifiedAt:
type: string
description: The modified timestamp in UTC of the Ingest Budget.
format: date-time
example: 2018-10-16 09:10:00+00:00
modifiedBy:
type: string
description: The identifier of the user who modified the Ingest Budget.
example: 0000000001243FDD
budgetVersion:
type: integer
description: The version of the Ingest Budget
format: int32
example: 2
ListIngestBudgetsResponseV2:
required:
- data
type: object
properties:
data:
type: array
description: List of ingest budgets.
items:
$ref: '#/components/schemas/IngestBudgetV2'
next:
type: string
description: Next continuation token.
securitySchemes:
basicAuth:
type: http
scheme: basic
x-tagGroups:
- name: Archive Management
tags:
- archiveManagement
- name: Health Events
tags:
- healthEvents
- name: Infrequent Data Tier
tags:
- logSearchesEstimatedUsage
- name: Ingest Budgets Management V2
tags:
- ingestBudgetManagementV2
- name: Library Management
tags:
- appManagement
- appManagementV2
- contentManagement
- dashboardManagement
- folderManagement
- lookupManagement
- contentPermissions
- logSearchesManagement
- parsersLibraryManagement
- name: Metrics
tags:
- metricsSearchesManagement
- transformationRuleManagement
- metricsQuery
- metricsSearchesManagementV2
- name: Security Management
tags:
- accessKeyManagement
- oauthManagement
- accountManagement
- passwordPolicy
- policiesManagement
- samlConfigurationManagement
- serviceAllowlistManagement
- serviceAccountManagement
- scimUserManagement
- name: Organizations Management
tags:
- orgsManagement
- name: Settings Management
tags:
- connectionManagement
- dynamicParsingRuleManagement
- extractionRuleManagement
- fieldManagementV1
- partitionManagement
- scheduledViewManagement
- logsDataForwardingManagement
- dataDeletionRules
- name: Tokens Management
tags:
- tokensLibraryManagement
- name: Tracing
tags:
- traces
- spanAnalytics
- serviceMap
- name: Users and Roles Management
tags:
- roleManagement
- roleManagementV2
- userManagement
- name: Threat Intel Ingest Management
tags:
- threatIntelIngest
- threatIntelIngestProducer
- name: OpenTelemetry Collector Management
tags:
- otCollectorManagementExternal
- name: Source Template Management
tags:
- sourceTemplateManagementExternal
- name: Schema Base Management
tags:
- schemaBaseManagement
- name: Event Analytics Management
tags:
- eventAnalytics
- name: Budget Management
tags:
- budgetManagement
- name: Macro Management
tags:
- macroManagement
- name: Muting Schedules Management
tags:
- mutingSchedulesLibraryManagement
- name: SLO Management
tags:
- slosLibraryManagement
- name: Monitor Management
tags:
- monitorsLibraryManagement