How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenObserve Alerts API

Alerts retrieval & management operations

OpenObserve Alerts API is one of 33 APIs that OpenObserve publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 26 operations across 17 paths, and defines 30 schemas. It is described by OpenAPI 3.1.0, at version 0.90.0.

Requests are made against the base URL https://api.openobserve.ai.

26 operations 17 paths 30 schemas 3 DELETE8 GET4 PATCH8 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.90.0
Base URL
https://api.openobserve.ai
Authentication
API Key, HTTP Basic
License
AGPL-3.0
Resource Areas
1

Authentication & Security 2

OpenObserve Alerts API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (Authorization). It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 26

Across 17 paths, the API surfaces 26 operations — 3 DELETE, 8 GET, 4 PATCH, 8 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Alerts 26

Alerts retrieval & management operations

GET
/api/v2/{org_id}/alerts
List organization alerts
ListAlerts 10 params → 200
POST
/api/v2/{org_id}/alerts
Create new alert
CreateAlert 2 params body → 200400
POST
/api/v2/{org_id}/alerts/bulk/enable
Enable or disable alert in bulk
EnableAlertBulk 2 params body → 200404500
POST
/api/v2/{org_id}/alerts/generate_sql
Generate SQL from alert query parameters
GenerateSql 1 param body → 200400500
PATCH
/api/v2/{org_id}/alerts/move
Move alerts between folders
MoveAlerts 2 params body → 200404500
GET
/api/v2/{org_id}/alerts/{alert_id}
Get alert details
GetAlert 3 params → 200404
PUT
/api/v2/{org_id}/alerts/{alert_id}
Update alert configuration
UpdateAlert 3 params body → 200400
DELETE
/api/v2/{org_id}/alerts/{alert_id}
Delete alert
DeleteAlert 3 params → 200500
POST
/api/v2/{org_id}/alerts/{alert_id}/clone
Clone an alert or anomaly detection config
CloneAlert 2 params body → 200404500
PATCH
/api/v2/{org_id}/alerts/{alert_id}/enable
Enable or disable alert
EnableAlert 3 params → 200404500
POST
/api/v2/{org_id}/alerts/{alert_id}/export
Export alert configuration
ExportAlert 3 params → 200404
PATCH
/api/v2/{org_id}/alerts/{alert_id}/retrain
Trigger retraining for an anomaly detection alert
RetrainAlert 2 params → 200400404500
PATCH
/api/v2/{org_id}/alerts/{alert_id}/trigger
Manually trigger alert
TriggerAlert 3 params → 200404500
GET
/api/{org_id}/alerts/dedup/summary
Get deduplication summary statistics for an organization
GetDedupSummary 1 param → 200
GET
/api/{org_id}/alerts/deduplication/config
Get deduplication configuration for an organization
GetDeduplicationConfig 1 param → 200403404500
POST
/api/{org_id}/alerts/deduplication/config
Set deduplication configuration for an organization
SetDeduplicationConfig 1 param body → 200400403500
DELETE
/api/{org_id}/alerts/deduplication/config
Delete deduplication configuration for an organization
DeleteDeduplicationConfig 1 param → 200403500
GET
/api/{org_id}/alerts/deduplication/semantic-groups
Get semantic field groups for an organization
GetSemanticGroups 1 param → 200500
PUT
/api/{org_id}/alerts/deduplication/semantic-groups
Save semantic field groups for an organization
SaveSemanticGroups 1 param body → 200400500
POST
/api/{org_id}/alerts/deduplication/semantic-groups/preview-diff
Preview diff between imported semantic groups and current DB state
PreviewSemanticGroupsDiff 1 param body → 200400500
GET
/api/{org_id}/alerts/destinations
List alert destinations
ListDestinations 2 params → 200400
POST
/api/{org_id}/alerts/destinations
Create alert or pipeline destination
CreateDestination 2 params body → 200400
GET
/api/{org_id}/alerts/destinations/{destination_name}
Get alert destination
GetDestination 2 params → 200404
PUT
/api/{org_id}/alerts/destinations/{destination_name}
Update alert or pipeline destination
UpdateDestination 3 params body → 200400
DELETE
/api/{org_id}/alerts/destinations/{destination_name}
Delete alert destination
DeleteAlertDestination 2 params → 200404409500
GET
/api/{org_id}/alerts/history
Get alert execution history
GetAlertHistory 8 params → 200400403500

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Alert (23 properties), AlertHistoryEntry (22 properties), UpdateAnomalyAlertFields (17 properties), ListAlertsResponseBodyItem (16 properties). Each schema is shown below with its type and property counts.

AlertTypeFilter
string
Filters the alert list by alert type (scheduled, realtime, anomaly detection, or all).
GroupingConfig
object
Configuration for alert grouping
4 properties
QueryCondition
object
9 properties
ListAlertsResponseBodyItem
object
An item in the list returned by the ListAlerts endpoint. For scheduled and realtime alert types, condition and triggercondition are always present. For anomaly…
16 properties 7 required
SemanticGroupModification
object
2 properties 2 required
Alert
object
23 properties
FieldAlias
object
Field alias group — defines a set of field names that represent the same concept. Used for: - Mapping equivalent field names across logs, traces, and metrics (…
5 properties 3 required
SearchEventType
string
DeduplicationConfig
object
Per-alert deduplication configuration (from main branch) This is stored on each Alert and specifies which fields to use for fingerprinting. This matches the st…
4 properties
AlertHistoryEntry
object
22 properties 9 required
Aggregation
object
3 properties 2 required
Condition
object
4 properties 3 required
DedupSummaryResponse
object
7 properties 7 required
CompareHistoricData
object
1 property 1 required
HTTPOutputFormat
SendStrategy
string
Strategy for sending grouped alert notifications
FrequencyType
string
HTTPType
string
Operator
string
RowTemplateType
string
GlobalDeduplicationConfig
object
Organization-level deduplication configuration (Global settings) This configuration is stored at the organization level and defines: - Whether deduplication is…
5 properties
UpdateAnomalyAlertFields
object
Anomaly-detection-specific fields for UpdateAlertRequestBody (all optional).
17 properties
GenerateSqlMetadata
object
Metadata about the generated SQL query.
3 properties 3 required
AggFunction
string
DestinationType
string
TriggerCondition
object
10 properties
SemanticGroupDiff
object
3 properties 3 required
QueryType
string
StreamType
string
AnomalyAlertFields
object
Anomaly-detection-specific fields for CreateAlertRequestBody.
15 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openobserve-alerts-api-openapi.yml Raw ↑

Other APIs OpenObserve publishes across the network.

OpenObserve Actions API
OpenObserve Clusters API
OpenObserve Dashboards API
OpenObserve Folders API
OpenObserve Functions API
OpenObserve Groups API
OpenObserve Incidents API
OpenObserve Key API
OpenObserve Keys API
OpenObserve KV API
OpenObserve Logs API
OpenObserve MCP API
Where this information came from

This is an independent, third-party profile of OpenObserve Alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.