Skip to main content
POST
/
limits
Create a new limit
curl --request POST \
  --url https://api.eu.bronto.io/limits \
  --header 'Content-Type: application/json' \
  --header 'X-BRONTO-API-KEY: <api-key>' \
  --data '
{
  "category": "INGESTION_LIMITS",
  "value": 1,
  "unit": "BYTES",
  "target": "TEAM",
  "scope": {
    "organisation": {
      "id": "<string>"
    },
    "tag": {
      "team": "team_xxx"
    }
  },
  "time_window": "PER_MONTH",
  "description": "<string>"
}
'
{
  "category": "INGESTION_LIMITS",
  "value": 1,
  "unit": "BYTES",
  "target": "TEAM",
  "scope": {
    "organisation": {
      "id": "<string>"
    },
    "tag": {
      "team": "team_xxx",
      "properties": {
        "key": {
          "type": "string",
          "description": "the key used to identify the tag"
        },
        "value": {
          "type": "string",
          "description": "the value of the tag"
        }
      }
    }
  },
  "type": "SYSTEM",
  "time_window": "PER_MONTH",
  "id": "<string>",
  "org_id": "<string>",
  "metadata": {
    "created_at": 123,
    "created_by": {
      "type": "API_KEY_ID",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "updated_at": 123,
    "updated_by": {
      "type": "API_KEY_ID",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "description": "<string>"
}

Authorizations

X-BRONTO-API-KEY
string
header
required

Body

application/json
category
enum<string>
required

Category of the limit

Available options:
INGESTION_LIMITS
Example:

"INGESTION_LIMITS"

value
integer<int64>
required

Value of the limit

Required range: x >= 0
unit
enum<string>
required

Unit of measurement for the limit

Available options:
BYTES
target
enum<string>
required

Target entity for the limit

Available options:
TEAM,
ORGANISATION
Example:

"TEAM"

scope
object
required

Scope of the limit

time_window
enum<string>
required

Time window for the limit

Available options:
PER_MONTH
description
string

Description of the limit

Response

limit is created successfully

category
enum<string>
required

Category of the limit

Available options:
INGESTION_LIMITS,
SEARCH_LIMITS,
MONITOR_LIMITS,
LBM_LIMITS
value
integer<int64>
required

Value of the limit

Required range: x >= 0
unit
enum<string>
required

Unit of measurement for the limit

Available options:
BYTES,
COUNT,
RATIO
target
enum<string>
required

Target entity for the limit

Available options:
TEAM,
ORGANISATION
Example:

"TEAM"

scope
object
required

Scope of the limit

type
enum<string>
required

Type of the limit indicating whether it is system-defined or user-defined

Available options:
SYSTEM,
USER_DEFINED
time_window
enum<string>
required

Time window for the limit

Available options:
PER_MONTH,
NO_WINDOW
id
string

Unique identifier for the limit

org_id
string

Identifier for the organization

metadata
object

Common metadata attached to all persisted resources.

description
string

Description of the limit