Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Bronto Docs home page

Login
Book a demo
Book a demo

Documentation

AI Assisted Observability

API Reference

Trust
Book a Demo
Status

API overview

Introduction

api-keys

GET
Retrieve a list of API keys
POST
Create a new API key
DEL
Delete an API key
PATCH
Update an API key

users

GET
Retrieve a list of users
POST
Create a new user
GET
Retrieve a list of users
GET
Retrieve a user by ID
DEL
Delete a user by ID
PATCH
Update a user
POST
Deactivate a user
POST
Reactivate a user
POST
Resend a user's invitation email
GET
Get user preferences
PATCH
Patch user preferences
GET
List all organizations this user has access to

groups

GET
List all user groups in the organization
POST
Create a new group
GET
Get a specific group
DEL
Delete a group
PATCH
Update a group
GET
List members of a group
POST
Add members to a group
DEL
Remove members from a group
GET
List groups a member belongs to

search

GET
Execute a query
POST
Execute a query

context

GET
Retrieve contextual information for a given sequence and log

live-tail

GET
Poll a live tail job
POST
Initiate a live tail job

logs

GET
Retrieve a list of logs
deprecated
POST
Create a new log
deprecated
GET
Retrieve a list of log views

datasets

GET
Retrieve a list of datasets
POST
Create a new dataset
GET
Get the parser assigned to a dataset
PUT
Assign a parser to a dataset
DEL
Unassign the parser from a dataset

monitors

GET
List monitors associated with a log
GET
Retrieve monitors
POST
Create a new monitor
GET
Retrieve monitor templates
POST
Create a new monitor template
GET
Get a monitor
PUT
Update a monitor
DEL
Delete a monitor
GET
Get a monitor template
PUT
Update a monitor template
DEL
Delete a monitor template
POST
Update monitor status

dashboards

GET
List dashboards associated with a log

collections

GET
Retrieve a list of collections

access

POST
Grant access to a user or group
DEL
Revoke access from a user or group
GET
List all members who have access to this organization
GET
Check if user or group has access to org
POST
Switch active organization for a user

downtimes

GET
Retrieve all monitor downtimes
POST
Create a new monitor downtime
PUT
Update a monitor downtime
DEL
Delete a monitor downtime

forward

GET
Retrieve forward configs
POST
Create a new forward config to archive your logs in another system
POST
Test access to the destination
PUT
Update an existing forward config
DEL
Delete a forward config

top-keys

GET
Retrieve top keys for logs

usage

GET
Retrieve usage metrics over time
GET
Get the usage over a period of time for a log id.
GET
Get the usage over a period of time for a user per log id.

integrations

GET
Get all Slack Integration Resources for an organisation
POST
Create a Slack Integration Resource
PUT
Update a Slack Integration Resource
DEL
Delete a Slack Integration Resource
GET
Get all Slack workspace resources for an organisation
DEL
Delete a Slack workspace resource; note this does not uninstall the bronto.io app from Slack
GET
Get all Webhook Integration Resources for an organisation
POST
Create a Webhook Integration Resource
PUT
Update a webhook Integration Resource
DEL
Delete a webhook Integration Resource

exports

GET
Retrieve a list of exports
POST
Create a new export
GET
Retrieve an export by ID
DEL
Delete an export by ID

customers

GET
Get the customer record for the current organization
PATCH
Update the customer record for the current organization

limits

GET
Retrieve limits
POST
Create a new limit
GET
Get a Limit
DEL
Delete a limit by ID
PATCH
Update a limit

permissions

GET
Retrieve permissions

parsers

GET
Get the parsers usage metrics over a period of time for a log id.
GET
Get the parsers usage metrics over a period of time for a log id.

ai

GET
Ask AI to give hints regarding a particular error
GET
Ask AI to provide a widget based on a prompt request

policies

GET
List policies by resource

encryption-keys

GET
Retrieve a list of encryption keys
POST
Create a new encryption key
GET
Retrieve a specific encryption key
DEL
Delete an encryption key
PATCH
Update an existing encryption key

timeseries

GET
Retrieve the timeseries for a metric definition.
POST
Run an ad-hoc timeseries query

patterns

POST
Get Pattern templates for logs matching search criteria

API Keys

Authenticate Bronto API requests with API keys passed in the X-BRONTO-API-KEY header. Roles assigned to each key control which endpoints are available.

⌘I

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Assistant

Responses are generated using AI and may contain mistakes.

Contact support