Grepr New Relic Integration API

openapi: 3.2.0
info:
  title: Grepr New Relic Integration API
  version: 1.0.0
  description: 'Operations tagged New Relic 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: New Relic Integration
paths:
  /v1/integrations/newrelic:
    get:
      description: Get all NewRelic integrations.
      operationId: listNewRelicIntegrations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemsCollectionReadNewRelic'
          description: Integrations retrieved successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: List all NewRelic integrations
      tags:
      - New Relic Integration
    post:
      description: Creates an integration to connect to NewRelic.
      operationId: createNewRelicIntegration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteNewRelic'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadNewRelic'
          description: Integration created successfully
        '401':
          description: Unauthorized
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadNewRelic'
          description: Integration already exists.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Create a NewRelic integration
      tags:
      - New Relic Integration
  /v1/integrations/newrelic/sites:
    get:
      description: Get all valid NewRelic sites for your organization.
      operationId: listValidNewRelicSites
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
          description: Sites retrieved successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: List all valid NewRelic sites
      tags:
      - New Relic Integration
  /v1/integrations/newrelic/{id}:
    delete:
      description: Deletes an integration to connect to NewRelic. This will delete the associated keys as well. No-op if already deleted.
      operationId: deleteNewRelicIntegration
      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 NewRelic integration
      tags:
      - New Relic Integration
    get:
      description: Get an integration to connect to NewRelic.
      operationId: getNewRelicIntegration
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadNewRelic'
          description: Integration retrieved successfully
        '401':
          description: Unauthorized
        '404':
          description: Integration not found.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Get a NewRelic integration
      tags:
      - New Relic Integration
    put:
      description: Updates an integration to connect to NewRelic. 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: updateNewRelicIntegration
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteNewRelic'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadNewRelic'
          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 NewRelic integration
      tags:
      - New Relic Integration
  /v1/integrations/newrelic/{id}/api-key:
    put:
      description: Creates a NewRelic API key for a NewRelic integration if a key doesn't exist, and updates it otherwise. If the api key is updated while the integration is being used by a pipeline, the new key is used at pipeline restart, rescaling, or an update. This key is used for the NewRelic API to retrieve the dashboards and alerts.
      operationId: upsertNewRelicApiKey
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretApi'
      responses:
        '204':
          description: NewRelic API key upserted successfully.
        '401':
          description: Unauthorized
        '404':
          description: Integration not found.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Creates or updates an API key for integration with New Relic
      tags:
      - New Relic Integration
  /v1/integrations/newrelic/{id}/exceptions:
    get:
      description: Returns a paginated list of vendor imported exceptions for the specified New Relic integration
      operationId: getNewRelicIntegrationExceptions
      parameters:
      - description: Integration ID
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: 'Page size (100-2000, default: 100)'
        in: query
        name: pageSize
        schema:
          default: 100
          format: int32
          maximum: 2000
          minimum: 100
          type: integer
      - description: 'Page number (0-based, default: 0)'
        in: query
        name: page
        schema:
          default: 0
          format: int32
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationExceptionsList'
          description: Successfully retrieved integration exceptions
        '401':
          description: Unauthorized
        '403':
          description: Access denied
        '404':
          description: Integration not found
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Get New Relic integration exceptions
      tags:
      - New Relic Integration
  /v1/integrations/newrelic/{id}/license-key:
    put:
      description: Creates an API key for a NewRelic 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: upsertNewRelicLicenseKey
      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 a NewRelic integration api key
      tags:
      - New Relic Integration
  /v1/integrations/newrelic/{id}/with-exceptions:
    get:
      description: Get an integration to connect to NewRelic with vendor imported exceptions populated.
      operationId: getNewRelicIntegrationWithExceptions
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadNewRelic'
          description: Integration retrieved successfully with exceptions
        '401':
          description: Unauthorized
        '404':
          description: Integration not found.
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Get a NewRelic integration with exceptions
      tags:
      - New Relic Integration
components:
  schemas:
    DatadogQueryPredicate:
      properties:
        query:
          default: ''
          description: The datadog query used by the predicate. See https://docs.datadoghq.com/tracing/trace_explorer/query_syntax
          example: service:grepr-service-1
          type: string
        type:
          description: A predicate that checks if an event matches a datadog query.
          enum:
          - datadog-query
          type: string
      required:
      - query
      - type
      type: object
    IntegrationExceptionsList:
      description: Paginated list of vendor imported exceptions for an integration
      properties:
        exceptions:
          $ref: '#/components/schemas/ItemsCollectionVendorImportedException'
        hasMore:
          description: Whether there are more pages available
          type: boolean
        page:
          description: Current page number (0-based)
          format: int32
          type: integer
        pageSize:
          description: Number of items per page
          format: int32
          type: integer
      type: object
    NewRelicQueryPredicate:
      properties:
        query:
          default: ''
          description: 'The New Relic query used by the predicate. See https://docs.newrelic.com/docs/logs/ui-data/query-syntax-logs/ '
          example: service:grepr-service-1
          type: string
        type:
          description: A predicate that checks if an event matches a New Relic query.
          enum:
          - newrelic-query
          type: string
      required:
      - query
      - type
      type: object
    ItemsCollectionVendorImportedException:
      description: Collection of vendor imported exceptions
      properties:
        items:
          default: []
          items:
            $ref: '#/components/schemas/VendorImportedException'
          type: array
      type: object
    ParseResult:
      properties:
        errorMessage:
          type: string
        parseable:
          type: boolean
      type: object
    VendorImportedException:
      description: Exception that was imported from a vendor integration like Datadog, Splunk etc.
      properties:
        accountGroup:
          description: Account group hash identifying the vendor account
          example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
          readOnly: true
          type: string
        createdAt:
          format: date-time
          type: string
        eventPredicate:
          $ref: '#/components/schemas/EventPredicate'
        eventPredicateHash:
          description: Hash of the event predicate for deduplication
          example: d4c3b2a1f6e5d4c3b2a1f6e5d4c3b2a1
          readOnly: true
          type: string
        exceptionType:
          enum:
          - DATADOG_MONITOR
          - DATADOG_DASHBOARD
          - DATADOG_LOG_BASED_METRICS
          - SPLUNK_MONITOR
          - NEW_RELIC_MONITOR
          - NEW_RELIC_DASHBOARD
          type: string
        integrationId:
          type: string
        parseResult:
          $ref: '#/components/schemas/ParseResult'
        sourceUri:
          type: string
        updatedAt:
          format: date-time
          type: string
        vendorResourceId:
          type: string
        vendorResourceName:
          type: string
      readOnly: true
      required:
      - vendorResourceId
      type: object
    MetricEventPredicate:
      properties:
        filterTags:
          additionalProperties:
            default: {}
            description: The set of tags to query for. If unspecified, all tags are queried.
            example:
              env:
              - prod
              service:
              - my-app
            items:
              default: '{}'
              description: The set of tags to query for. If unspecified, all tags are queried.
              example: '{"service":["my-app"],"env":["prod"]}'
              type: string
            type: array
            uniqueItems: true
          default: {}
          description: The set of tags to query for. If unspecified, all tags are queried.
          example:
            env:
            - prod
            service:
            - my-app
          type: object
        metricNames:
          default: []
          description: The names of the metrics to query. Must not be empty.
          example:
          - cpu.load
          - cpu.utilization
          items:
            description: The names of the metrics to query. Must not be empty.
            example: '["cpu.load","cpu.utilization"]'
            type: string
          maxItems: 2147483647
          minItems: 1
          type: array
        query:
          type: string
        type:
          description: A predicate that checks if an event matches a metrics query.
          enum:
          - metric-predicate
          type: string
      required:
      - metricNames
      - query
      - type
      type: object
    NewRelic:
      description: The payload containing integration data.
      properties:
        accountId:
          description: Account Id for New Relic.
          example: '123456789'
          maxLength: 255
          minLength: 0
          type: string
        apiKey:
          description: Masked API key for New Relic.
          example: '**************ey'
          readOnly: true
          type: string
        dashboardFreshnessWindow:
          default: PT672H
          description: The time window in which a dashboard must have been accessed to be considered active.
          example: PT20.345S
          format: ISO-8601
          type: string
        exceptions:
          additionalProperties:
            $ref: '#/components/schemas/VendorImportedException'
          description: The imported exceptions from NewRelic. This is a map from the vendor resource ID to the exception.
          readOnly: true
          type: object
        licenseKey:
          description: Masked license key for New Relic.
          example: '**************ey'
          readOnly: true
          type: string
        privateLink:
          default: false
          description: Route logs to New Relic over AWS PrivateLink using the private log endpoint.
          type: boolean
        site:
          description: New Relic API endpoint url base
          example: newrelic.com
          maxLength: 255
          minLength: 0
          type: string
      required:
      - site
      type: object
      x-type:
        type: newrelic
    AndEventPredicate:
      properties:
        queries:
          default: []
          description: List of predicates that must all match for this predicate to match.
          items:
            $ref: '#/components/schemas/EventPredicate'
          maxItems: 2147483647
          minItems: 1
          title: Child predicates
          type: array
        type:
          description: A predicate that matches when every child predicate matches.
          enum:
          - and-predicate
          type: string
      required:
      - queries
      - type
      type: object
    ReadNewRelic:
      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/NewRelic'
        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:
          - newrelic
          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
    SecretApi:
      description: Secret wrapper for API responses
      properties:
        secret:
          description: The secret value
          type: string
      required:
      - secret
      type: object
    EventPredicate:
      description: Predicate applied to rows before analytical aggregation.
      discriminator:
        mapping:
          and-predicate: '#/components/schemas/AndEventPredicate'
          datadog-query: '#/components/schemas/DatadogQueryPredicate'
          metric-predicate: '#/components/schemas/MetricEventPredicate'
          newrelic-query: '#/components/schemas/NewRelicQueryPredicate'
          nrql-query: '#/components/schemas/NrqlQueryPredicate'
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/AndEventPredicate'
      - $ref: '#/components/schemas/DatadogQueryPredicate'
      - $ref: '#/components/schemas/MetricEventPredicate'
      - $ref: '#/components/schemas/NewRelicQueryPredicate'
      - $ref: '#/components/schemas/NrqlQueryPredicate'
      properties:
        query:
          type: string
        type:
          type: string
      required:
      - type
      type: object
    ItemsCollectionReadNewRelic:
      properties:
        items:
          default: []
          items:
            $ref: '#/components/schemas/ReadNewRelic'
          type: array
      type: object
    WriteNewRelic:
      properties:
        name:
          description: Name of the integration.
          example: my_integration
          pattern: '[a-zA-Z0-9 _-]{1,128}'
          type: string
        payload:
          $ref: '#/components/schemas/NewRelic'
        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:
          - newrelic
          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
    NrqlQueryPredicate:
      properties:
        query:
          default: ''
          description: The Nrql query used by the predicate. See https://docs.newrelic.com/docs/nrql
          example: SELECT * FROM Log WHERE service = 'grepr-service-1'
          type: string
        strict:
          default: true
          description: Whether the query should be parsed in strict mode.
          type: boolean
        type:
          description: A predicate that checks if an event matches an NRQL query.
          enum:
          - nrql-query
          type: string
      required:
      - query
      - type
      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