{
  "opencollection": "1.0.0",
  "info": {
    "name": "openobserve Actions Pipelines API",
    "version": "0.90.0"
  },
  "items": [
    {
      "info": {
        "name": "Pipelines",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List organization pipelines",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/pipelines",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves all data processing pipelines configured for the organization, including their status and associated triggers"
        },
        {
          "info": {
            "name": "Create new pipeline",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/pipelines",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Creates a new data processing pipeline with specified transformations and routing rules. Pipelines define how incoming data is processed before storage"
        },
        {
          "info": {
            "name": "Update pipeline",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/:org_id/pipelines",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Updates an existing data processing pipeline with new transformation rules, routing configurations, or other settings"
        },
        {
          "info": {
            "name": "List all backfill jobs for an organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/pipelines/backfill",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of all backfill jobs in the specified organization."
        },
        {
          "info": {
            "name": "Enable or disable pipeline in bulk",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/pipelines/bulk/enable",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "value",
                "value": "",
                "type": "query",
                "description": "Enable or disable pipeline"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Enables or disables data processing pipelines in bulk. Disabled pipelines will not process incoming data until re-enabled"
        },
        {
          "info": {
            "name": "Get pipeline execution history",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/pipelines/history",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "query",
                "description": "Filter by specific pipeline id"
              },
              {
                "name": "start_time",
                "value": "",
                "type": "query",
                "description": "Start time in Unix timestamp microseconds"
              },
              {
                "name": "end_time",
                "value": "",
                "type": "query",
                "description": "End time in Unix timestamp microseconds"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Pagination offset (default: 0)"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of results to return (default: 100, max: 1000)"
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Field to sort by: timestamp, pipeline_name, status, is_realtime, is_silenced, start_time, end_time, duration, retries, delay_in_secs, evaluation_took_in_secs, source_node, query_took, is_partial (default: timestamp)"
              },
              {
                "name": "sort_order",
                "value": "",
                "type": "query",
                "description": "Sort order: asc or desc (default: desc)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves the execution history of pipelines for the organization. This endpoint queries the _meta organization's triggers stream to provide details about when pipelines were triggered, their status, and execution details."
        },
        {
          "info": {
            "name": "Get streams with pipelines",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/pipelines/streams",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves a list of streams that have associated data processing pipelines, showing the relationship between streams and their transformation rules"
        },
        {
          "info": {
            "name": "Get pipeline by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/pipelines/:pipeline_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path",
                "description": "Pipeline ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves the details of a specific data processing pipeline by its ID, including its status, trigger info, and any recent errors"
        },
        {
          "info": {
            "name": "Delete pipeline",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/:org_id/pipelines/:pipeline_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path",
                "description": "Pipeline ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Permanently deletes a data processing pipeline. This will stop any ongoing data transformations using this pipeline"
        },
        {
          "info": {
            "name": "Create a backfill job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/pipelines/:pipeline_id/backfill",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path",
                "description": "Pipeline ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Creates a new backfill job to fill gaps in summary streams."
        },
        {
          "info": {
            "name": "Get backfill job status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/pipelines/:pipeline_id/backfill/:job_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path",
                "description": "Pipeline ID"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "Backfill job ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Returns the status of a specific backfill job."
        },
        {
          "info": {
            "name": "Update an existing backfill job",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/:org_id/pipelines/:pipeline_id/backfill/:job_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path",
                "description": "Pipeline ID"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "Backfill job ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Update an existing backfill job"
        },
        {
          "info": {
            "name": "Delete a backfill job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/:org_id/pipelines/:pipeline_id/backfill/:job_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path",
                "description": "Pipeline ID"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "Backfill job ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Deletes a backfill job permanently."
        },
        {
          "info": {
            "name": "Enable or disable a backfill job",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/:org_id/pipelines/:pipeline_id/backfill/:job_id/enable",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path",
                "description": "Pipeline ID"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "Backfill job ID"
              },
              {
                "name": "value",
                "value": "",
                "type": "query",
                "description": "Enable (true) or disable (false) the backfill job"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Enables (resumes) or disables (pauses) a backfill job."
        },
        {
          "info": {
            "name": "Enable or disable pipeline",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/:org_id/pipelines/:pipeline_id/enable",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "pipeline_id",
                "value": "",
                "type": "path",
                "description": "Pipeline ID"
              },
              {
                "name": "value",
                "value": "",
                "type": "query",
                "description": "Enable or disable pipeline"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Enables or disables a data processing pipeline. Disabled pipelines will not process incoming data until re-enabled"
        }
      ]
    }
  ],
  "bundled": true
}