Sumo Logic Search Jobs API

openapi: 3.1.0
info:
  title: Sumo Logic REST Collectors Search Jobs API
  description: 'Sumo Logic is a cloud-native log analytics, observability, and security

    platform. The REST API exposes search jobs, dashboards, metrics, monitors and

    alerts, content management, roles, users, collectors, connections, partitions,

    lookup tables, SAML configuration, traces, and Cloud SIEM / Cloud SOAR.


    Sumo Logic operates multiple regional deployments. Each deployment exposes a

    deployment-specific API endpoint; the `servers` section below enumerates them.

    Authentication uses HTTP Basic with the Access ID as username and Access Key as

    password, or service-account credentials.

    '
  version: 1.0.0
  contact:
    name: Sumo Logic Help
    url: https://www.sumologic.com/help/docs/api/
  license:
    name: Proprietary
servers:
- url: https://api.sumologic.com/api
  description: US1 deployment
- url: https://api.us2.sumologic.com/api
  description: US2 deployment
- url: https://api.eu.sumologic.com/api
  description: EU (Dublin) deployment
- url: https://api.au.sumologic.com/api
  description: Australia (Sydney) deployment
- url: https://api.ca.sumologic.com/api
  description: Canada (Montreal) deployment
- url: https://api.de.sumologic.com/api
  description: Germany (Frankfurt) deployment
- url: https://api.jp.sumologic.com/api
  description: Japan (Tokyo) deployment
- url: https://api.in.sumologic.com/api
  description: India (Mumbai) deployment
- url: https://api.kr.sumologic.com/api
  description: South Korea (Seoul) deployment
- url: https://api.fed.sumologic.com/api
  description: US Federal (FedRAMP) deployment
security:
- basicAuth: []
tags:
- name: Search Jobs
paths:
  /v1/search/jobs:
    post:
      tags:
      - Search Jobs
      summary: Create a search job
      operationId: createSearchJob
      responses:
        '202':
          description: Search job accepted
  /v1/search/jobs/{searchJobId}:
    parameters:
    - in: path
      name: searchJobId
      required: true
      schema:
        type: string
    get:
      tags:
      - Search Jobs
      summary: Get search job status
      operationId: getSearchJobStatus
      responses:
        '200':
          description: Current search job status
    delete:
      tags:
      - Search Jobs
      summary: Delete a search job
      operationId: deleteSearchJob
      responses:
        '200':
          description: Search job deleted
  /v1/search/jobs/{searchJobId}/messages:
    parameters:
    - in: path
      name: searchJobId
      required: true
      schema:
        type: string
    - in: query
      name: offset
      schema:
        type: integer
    - in: query
      name: limit
      schema:
        type: integer
    get:
      tags:
      - Search Jobs
      summary: Page through messages produced by a search job
      operationId: getSearchJobMessages
      responses:
        '200':
          description: Page of messages
  /v1/search/jobs/{searchJobId}/records:
    parameters:
    - in: path
      name: searchJobId
      required: true
      schema:
        type: string
    - in: query
      name: offset
      schema:
        type: integer
    - in: query
      name: limit
      schema:
        type: integer
    get:
      tags:
      - Search Jobs
      summary: Page through records produced by a search job
      operationId: getSearchJobRecords
      responses:
        '200':
          description: Page of records
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic Authentication. Use your Sumo Logic Access ID as username and

        the corresponding Access Key as password. Service account tokens may also

        be used. Generate credentials in the Sumo Logic UI under Administration

        > Security > Access Keys.

        '