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 Pipelines API

The Pipelines API from OpenObserve — 10 operation(s) for pipelines.

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

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

This API exposes 15 operations across 10 paths, and defines 26 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.

15 operations 10 paths 26 schemas 2 DELETE6 GET3 POST4 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 Pipelines 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 15

Across 10 paths, the API surfaces 15 operations — 2 DELETE, 6 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Pipelines 15
GET
/api/{org_id}/pipelines
List organization pipelines
listPipelines 1 param → 200
PUT
/api/{org_id}/pipelines
Update pipeline
updatePipeline 1 param body → 200400
POST
/api/{org_id}/pipelines
Create new pipeline
createPipeline 1 param body → 200400
GET
/api/{org_id}/pipelines/backfill
List all backfill jobs for an organization
ListBackfillJobs 1 param → 200500
POST
/api/{org_id}/pipelines/bulk/enable
Enable or disable pipeline in bulk
enablePipelineBulk 2 params body → 200404500
GET
/api/{org_id}/pipelines/history
Get pipeline execution history
GetPipelineHistory 8 params → 200400403500
GET
/api/{org_id}/pipelines/streams
Get streams with pipelines
getStreamsWithPipeline 1 param → 200
GET
/api/{org_id}/pipelines/{pipeline_id}
Get pipeline by ID
getPipeline 2 params → 200404
DELETE
/api/{org_id}/pipelines/{pipeline_id}
Delete pipeline
deletePipeline 2 params → 200404
POST
/api/{org_id}/pipelines/{pipeline_id}/backfill
Create a backfill job
CreateBackfillJob 2 params body → 200400404500
GET
/api/{org_id}/pipelines/{pipeline_id}/backfill/{job_id}
Get backfill job status
GetBackfillJob 3 params → 200404500
PUT
/api/{org_id}/pipelines/{pipeline_id}/backfill/{job_id}
Update an existing backfill job
UpdateBackfillJob 3 params body → 200400404500
DELETE
/api/{org_id}/pipelines/{pipeline_id}/backfill/{job_id}
Delete a backfill job
DeleteBackfillJob 3 params → 200404500
PUT
/api/{org_id}/pipelines/{pipeline_id}/backfill/{job_id}/enable
Enable or disable a backfill job
EnableBackfillJob 4 params → 200400404500
PUT
/api/{org_id}/pipelines/{pipeline_id}/enable
Enable or disable pipeline
enablePipeline 3 params → 200404500

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are BackfillJobStatus (19 properties), PipelineHistoryEntry (16 properties), Pipeline (11 properties), TriggerCondition (10 properties). Each schema is shown below with its type and property counts.

QueryCondition
object
9 properties
DeletionStatus
string
Edge
object
Connection between two nodes in the pipeline
3 properties 3 required
SearchEventType
string
StreamParams
object
3 properties
NodeStyle
object
1 property
Aggregation
object
3 properties 2 required
Condition
object
4 properties 3 required
DerivedStream
object
7 properties
Position
object
2 properties 2 required
PipelineSource
Pipeline source type determines when the pipeline runs. Use "realtime" for processing data as it arrives, "scheduled" for periodic batch processing.
CompareHistoricData
object
1 property 1 required
BackfillJobStatus
object
19 properties 8 required
FrequencyType
string
BackfillResponse
object
2 properties 2 required
Operator
string
Pipeline
object
11 properties 3 required
AggFunction
string
PipelineHistoryResponse
object
4 properties 4 required
TriggerCondition
object
10 properties
Node
object
6 properties 4 required
PipelineHistoryEntry
object
16 properties 9 required
QueryType
string
StreamType
string
BackfillRequest
object
5 properties 2 required
PipelineErrorInfo
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openobserve-pipelines-api-openapi.yml Raw ↑

Other APIs OpenObserve publishes across the network.

OpenObserve Actions API
OpenObserve Alerts 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
Where this information came from

This is an independent, third-party profile of OpenObserve Pipelines 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.