OpenObserve Report API

The Report API from OpenObserve — 1 operation(s) for report.

OpenAPI Specification

openobserve-report-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: openobserve Actions Report API
  description: OpenObserve API documents [https://openobserve.ai/docs/](https://openobserve.ai/docs/)
  contact:
    name: OpenObserve
    url: https://openobserve.ai/
    email: hello@zinclabs.io
  license:
    name: AGPL-3.0
    identifier: AGPL-3.0
  version: 0.90.0
tags:
- name: Report
paths:
  /api/{org_id}/reports/{name}/enable:
    put:
      tags:
      - Report
      summary: Enable or disable dashboard report
      description: Enables or disables automated execution of a dashboard report. When disabled, scheduled report deliveries are paused but the configuration is preserved. When re-enabled, report deliveries resume according to the configured schedule. Useful for temporarily stopping report distribution without losing the complete report setup.
      operationId: EnableReport
      parameters:
      - name: org_id
        in: path
        description: Organization name
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: Report name
        required: true
        schema:
          type: string
      - name: value
        in: query
        description: Enable or disable report
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                default: null
        '500':
          description: Failure
          content:
            application/json:
              schema:
                default: null
      security:
      - Authorization: []
components:
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: Authorization
    BasicAuth:
      type: http
      scheme: basic