{
  "opencollection": "1.0.0",
  "info": {
    "name": "openobserve Actions Search Jobs API",
    "version": "0.90.0"
  },
  "items": [
    {
      "info": {
        "name": "Search Jobs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List search jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/search_jobs",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves a list of all search jobs for the organization, including their current status, execution details, and metadata. This includes both active and completed jobs, allowing you to monitor the progress of running searches and access historical job information for analysis and debugging purposes."
        },
        {
          "info": {
            "name": "Submit search job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/search_jobs",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Submits a new asynchronous search job for execution. Search jobs are useful for long-running queries that might exceed normal timeout limits or for scheduling queries to run in the background. The job is queued for execution and returns a job ID that can be used to monitor progress and retrieve results later."
        },
        {
          "info": {
            "name": "Get search job status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/search_jobs/:job_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "Search job ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves the current status and metadata for a specific search job. This includes execution state, timing information, error messages if any, and other job details. Use this to monitor job progress and determine when results are ready for retrieval or if the job encountered any issues during execution."
        },
        {
          "info": {
            "name": "Delete search job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/:org_id/search_jobs/:job_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "Search job ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Permanently deletes a search job and its associated results from the system. This action first cancels the job if it's still running, then removes all job data including metadata and stored results. Use this to clean up completed jobs and free up storage space. This operation cannot be undone."
        },
        {
          "info": {
            "name": "Cancel search job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/search_jobs/:job_id/cancel",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "Search job ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Cancels a running or pending search job, stopping its execution and freeing up resources. This is useful for stopping long-running queries that are no longer needed or consuming too many resources. Once cancelled, the job cannot be resumed and no results will be available."
        },
        {
          "info": {
            "name": "Get search job results",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/search_jobs/:job_id/result",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "Search job ID"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Pagination start offset"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Number of results to return"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves the results from a completed search job with optional pagination. The job must have finished successfully before results can be accessed. Results include the matching records, total count, execution timing, and metadata. Use pagination parameters to retrieve large result sets in manageable chunks."
        },
        {
          "info": {
            "name": "Retry search job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/search_jobs/:job_id/retry",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "Search job ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retries a previously failed or cancelled search job by resubmitting it for execution. This is useful for handling transient failures or resource constraints that may have caused the original job to fail. Only cancelled or finished (failed) jobs can be retried. The job will be re-queued with the same original parameters and query."
        }
      ]
    }
  ],
  "bundled": true
}