Grepr Integrations API

openapi: 3.2.0
info:
  title: Grepr Integrations API
  version: 1.0.0
  description: 'Operations tagged Integrations 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:
- name: Integrations
paths:
  /v1/integrations/{integrationId}/parsed-queries/import:
    get:
      description: Says whether this vendor's parsed queries can be imported, whether the credential the import needs is saved, whether an import is already under way, and which integrations an import covers. Poll this while an import is running; what it imported is reported in the integration's activity log.
      operationId: getParsedQueryImportStatus
      parameters:
      - description: Integration id
        example: 0q841q0j81m2q
        in: path
        name: integrationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParsedQueryImportStatus'
          description: State retrieved
        '401':
          description: Unauthorized
        '404':
          description: Not Found - Integration not found.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Get parsed-query import state
      tags:
      - Integrations
    post:
      description: Reads the integration's alert, monitor and dashboard queries from its vendor without waiting for the hourly import. One fetch is shared by every integration in the organization using the same vendor account, so this updates all of them. If an import is already under way this joins it rather than starting another. The import runs in the background; its result appears in the integration's activity log.
      operationId: importParsedQueries
      parameters:
      - description: Integration id
        example: 0q841q0j81m2q
        in: path
        name: integrationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParsedQueryImportStatus'
          description: Import started, or already under way
        '401':
          description: Unauthorized
        '404':
          description: Not Found - Integration not found.
        '409':
          description: Conflict - This vendor has no parsed queries to import, or the integration has no application key saved.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Import an integration's parsed queries now
      tags:
      - Integrations
components:
  schemas:
    ParsedQueryImportStatus:
      properties:
        coveredIntegrationIds:
          default: []
          description: Every integration an import updates. Integrations that share a vendor account share one fetch, so importing for one imports for all of them.
          items:
            description: Every integration an import updates. Integrations that share a vendor account share one fetch, so importing for one imports for all of them.
            type: string
          type: array
        hasCredential:
          description: Whether the credential the import needs is saved. For Datadog this is the application key.
          example: true
          type: boolean
        importing:
          description: Whether an import covering this integration is already under way.
          example: false
          type: boolean
        supported:
          description: Whether this vendor's parsed queries can be imported at all. False for vendors Grepr cannot read alert queries from.
          example: true
          type: boolean
      required:
      - coveredIntegrationIds
      - hasCredential
      - importing
      - supported
      type: object
  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