Grepr Sumo Logic Integration API

openapi: 3.2.0
info:
  title: Grepr Sumo Logic Integration API
  version: 1.0.0
  description: 'Operations tagged Sumo Logic Integration across 2 of this provider''s published API definitions: grepr-openapi.json, grepr.json. Each path carries the servers of the definition it was published in.'
tags:
- description: ''
  name: Sumo Logic Integration
paths:
  /v1/integrations/sumo:
    get:
      description: Get all SumoLogic integrations.
      operationId: listSumoIntegrations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemsCollectionReadSumo'
          description: Integrations retrieved successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: List all SumoLogic integrations
      tags:
      - Sumo Logic Integration
    post:
      description: Creates an integration to connect to SumoLogic.
      operationId: createSumoIntegration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteSumo'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadSumo'
          description: Integration created successfully
        '401':
          description: Unauthorized
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadSumo'
          description: Integration already exists.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Create a SumoLogic integration
      tags:
      - Sumo Logic Integration
  /v1/integrations/sumo/{id}:
    delete:
      description: Deletes an integration to connect to SumoLogic. This will delete the associated keys as well. No-op if already deleted.
      operationId: deleteSumoIntegration
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Integration deleted successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Delete a SumoLogic integration
      tags:
      - Sumo Logic Integration
    get:
      description: Get an integration to connect to SumoLogic.
      operationId: getSumoIntegration
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadSumo'
          description: Integration retrieved successfully
        '401':
          description: Unauthorized
        '404':
          description: Integration not found.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Get a SumoLogic integration
      tags:
      - Sumo Logic Integration
    put:
      description: Updates an integration to connect to SumoLogic. The version should be increased by one for every new update in order for the write to succeed. Otherwise, a '409 Conflict' will be returned.
      operationId: updateSumoIntegration
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteSumo'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadSumo'
          description: Integration updated successfully
        '401':
          description: Unauthorized
        '404':
          description: Integration not found.
        '409':
          description: Integration was modified or deleted concurrently.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Update a SumoLogic integration
      tags:
      - Sumo Logic Integration
  /v1/integrations/sumo/{id}/endpoint:
    put:
      description: Sets the endpoint for a SumoLogic integration if it doesn't exist and updates it otherwise. If the key is updated while the integration is being used by a pipeline, the new key will be picked at pipeline restart, rescaling or an update. Ingestion supports the previous and the updated key for up to 24 hours of a key update. Make sure to change the key used by the agents to send data within 24 hours of an update for a seamless transition
      operationId: upsertSumoEndpoint
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretApi'
      responses:
        '204':
          description: Api key upserted successfully.
        '401':
          description: Unauthorized
        '404':
          description: Integration not found.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Creates or updates the endpoint for the SumoLogic integration
      tags:
      - Sumo Logic Integration
components:
  schemas:
    SecretApi:
      description: Secret wrapper for API responses
      properties:
        secret:
          description: The secret value
          type: string
      required:
      - secret
      type: object
    ItemsCollectionReadSumo:
      properties:
        items:
          default: []
          items:
            $ref: '#/components/schemas/ReadSumo'
          type: array
      type: object
    ReadSumo:
      properties:
        createdAt:
          description: Timestamp when the integration was created.
          format: date-time
          readOnly: true
          type: string
        id:
          description: The integration id
          type: string
        jobIds:
          description: List of job IDs associated with the integration.
          items:
            description: List of job IDs associated with the integration.
            type: string
          type: array
          uniqueItems: true
        name:
          description: Name of the integration.
          example: my_integration
          pattern: '[a-zA-Z0-9 _-]{1,128}'
          type: string
        organizationId:
          description: Organization ID of the integration.
          type: string
        payload:
          $ref: '#/components/schemas/Sumo'
        teamIds:
          description: The team IDs that this integration is associated with.
          items:
            description: The team IDs that this integration is associated with.
            type: string
          type: array
          uniqueItems: true
        type:
          description: The type of the integration. This is used to determine the payload type.
          enum:
          - sumo
          type: string
        updatedAt:
          description: Timestamp when the integration was last updated.
          format: date-time
          readOnly: true
          type: string
        version:
          description: Version of the integration. Should be increased by one for every new update in order for the write to succeed. Otherwise, a '409 Conflict' will be returned.
          example: 0
          format: int32
          minimum: 0
          type: integer
      required:
      - createdAt
      - id
      - jobIds
      - name
      - organizationId
      - payload
      - type
      - updatedAt
      - version
      type: object
    WriteSumo:
      properties:
        name:
          description: Name of the integration.
          example: my_integration
          pattern: '[a-zA-Z0-9 _-]{1,128}'
          type: string
        payload:
          $ref: '#/components/schemas/Sumo'
        teamIds:
          default: []
          description: The team IDs that this integration is associated with.
          items:
            description: The team IDs that this integration is associated with.
            type: string
          type: array
          uniqueItems: true
        type:
          description: The type of the integration. This is used to determine the payload type.
          enum:
          - sumo
          type: string
        version:
          description: Version of the integration. Should be increased by one for every new update in order for the write to succeed. Otherwise, a '409 Conflict' will be returned.
          example: 0
          format: int32
          minimum: 0
          type: integer
      required:
      - name
      - payload
      - type
      - version
      type: object
    Sumo:
      description: The payload containing integration data.
      properties:
        endpoint:
          description: SumoLogic HTTP / OTLP endpoint url base
          example: '******'
          readOnly: true
          type: string
      type: object
      x-type:
        type: sumo
  securitySchemes:
    grepr-api-key:
      in: header
      name: GREPR-API-KEY
      type: apiKey
    grepr-oidc:
      bearerFormat: JWT
      openIdConnectUrl: https://grepr-prod.us.auth0.com/.well-known/openid-configuration
      type: openIdConnect
x-refined-from:
- grepr-openapi.json
- grepr.json
x-tagGroups:
- name: Integrations
  tags:
  - Grepr-hosted Data Warehouse Integration
  - External S3 Data Warehouse Integration
  - Datadog Integration
  - New Relic Integration
  - Splunk Integration
  - Sumo Logic Integration
  - OpenTelemetry Integration
- name: Pipelines
  tags:
  - Jobs
  - Templates
  - Datasets
  - Status Metrics
  - External Triggers
  - Job Actions
  - Triggers
- name: Pipeline Components
  tags:
  - Operations
  - Transforms
  - Sources
  - Sinks
- name: Administration
  tags:
  - Users
  - Teams
  - Roles
  - Permission
  - Invitations
  - Activity Logs
- name: Organization
  tags:
  - Organizations
  - Access Configuration
  - Grepr API Key
  - Service Accounts
  - Signup
- name: Query & Analysis
  tags:
  - Job Anomalies
  - Grok Parsing
  - Query Parsing
  - Validation
- name: System
  tags:
  - Manifest