API Index

These APIs can be used to programmatically interact with OpenObserve.

All APIs must have an authorization header. Authorization header can be created using base64 encoded values of user id and password. For the sake of simplicity it is HTTP basic authentication mechanism.

Header creation mechanism:

Authorization: Basic base64("username:password")

For example:

Authorization: Basic YWRtaW46Q29tcGxleHBhc3MjMTIz

Make sure that you are sending the requests over HTTPS.

API List

1. Stream
   1. List
   2. Schema
   3. Setting
   4. Delete
2. Ingestion
   1. Bulk
   2. JSON
   3. Multi
   4. Loki
   5. OTLP logs
   6. Metrics
   7. Traces
   8. Profiles
3. Search
4. Traces
5. Function
6. User
   1. Create
   2. Update
   3. Add to organization
   4. Remove from organization
   5. List
7. Dashboards
8. Reports
9. Metrics
10. Cluster

Every running instance also serves its OpenAPI specification as Swagger UI at /swagger/ (/docs redirects there; on by default, controlled by ZO_SWAGGER_ENABLED). It covers many routes that are not described on these pages.

Next steps

• Quickstart: get OpenObserve running and grab your credentials.
• Ingestion: start sending logs, metrics, traces, and profiles.
• OpenTelemetry / OTLP: the recommended modern ingestion path.

Need some help?

• Join our Community Slack
• Or Contact support