Grepr External S3 Data Warehouse Integration API

openapi: 3.2.0
info:
  title: Grepr External S3 Data Warehouse Integration API
  version: 1.0.0
  description: 'Operations tagged External S3 Data Warehouse 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: External S3 Data Warehouse Integration
paths:
  /v1/integrations/s3-data-warehouse:
    get:
      operationId: listS3DataWarehouseIntegrations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemsCollectionReadS3DataWarehouse'
          description: S3 Data Warehouse integrations retrieved successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: List all S3 Data Warehouse integrations
      tags:
      - External S3 Data Warehouse Integration
    post:
      description: Creates an external S3 Data Warehouse integration
      operationId: createS3DataWarehouseIntegration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteS3DataWarehouse'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadS3DataWarehouse'
          description: S3 Data Warehouse integration created successfully
        '400':
          description: Bucket is not accessible or the role is invalid
        '401':
          description: Unauthorized
        '409':
          description: S3 Data Warehouse integration already exists
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Create a S3 Data Warehouse integration
      tags:
      - External S3 Data Warehouse Integration
  /v1/integrations/s3-data-warehouse/cloudformation-setup-info:
    get:
      description: Gets AWS Cloudformation setup information for an external S3 Data Warehouse integration
      operationId: getCloudFormationSetupInfo
      parameters:
      - in: query
        name: bucketName
        schema:
          maxLength: 63
          minLength: 3
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudFormationSetupInfo'
          description: Cloudformation setup information retrieved successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Get AWS Cloudformation setup information for a S3 Data Warehouse integration
      tags:
      - External S3 Data Warehouse Integration
  /v1/integrations/s3-data-warehouse/console-setup-info:
    get:
      description: Gets AWS console setup information for an external S3 Data Warehouse integration
      operationId: getConsoleSetupInfo
      parameters:
      - in: query
        name: bucketName
        schema:
          maxLength: 63
          minLength: 3
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsoleSetupInfo'
          description: AWS console setup information retrieved successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Get AWS console setup information for a S3 Data Warehouse integration
      tags:
      - External S3 Data Warehouse Integration
  /v1/integrations/s3-data-warehouse/test:
    post:
      description: Validates whether Grepr can access the S3 bucket. This can be used to test the bucket access before creating the integration.
      operationId: test
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteS3DataWarehouse'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketAccessResult'
          description: Bucket access validation completed successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Validate whether Grepr can access the S3 bucket
      tags:
      - External S3 Data Warehouse Integration
  /v1/integrations/s3-data-warehouse/{id}:
    delete:
      description: Deletes an external S3 Data Warehouse integration if it exists. No-op otherwise.
      operationId: deleteS3DataWarehouseIntegration
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: S3 Data Warehouse integration deleted successfully
        '401':
          description: Unauthorized
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Delete a S3 Data Warehouse integration
      tags:
      - External S3 Data Warehouse Integration
    get:
      description: Gets an external S3 Data Warehouse integration
      operationId: getS3DataWarehouseIntegration
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadS3DataWarehouse'
          description: S3 Data Warehouse integration retrieved successfully
        '401':
          description: Unauthorized
        '404':
          description: S3 Data Warehouse integration not found
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Get a S3 Data Warehouse integration
      tags:
      - External S3 Data Warehouse Integration
    put:
      description: Updates an external S3 Data Warehouse integration
      operationId: updateS3DataWarehouseIntegration
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteS3DataWarehouse'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadS3DataWarehouse'
          description: S3 Data Warehouse integration updated successfully
        '400':
          description: Bucket name and ARN cannot be updated
        '401':
          description: Unauthorized
        '404':
          description: S3 Data Warehouse integration not found
        '409':
          description: S3 Data Warehouse integration was updated and modified concurrently
      security:
      - grepr-api-key: []
      - grepr-oidc: []
      summary: Update a S3 Data Warehouse integration
      tags:
      - External S3 Data Warehouse Integration
components:
  schemas:
    WriteS3DataWarehouse:
      properties:
        name:
          description: Name of the integration.
          example: my_integration
          pattern: '[a-zA-Z0-9 _-]{1,128}'
          type: string
        payload:
          $ref: '#/components/schemas/S3DataWarehouse'
        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:
          - s3-data-warehouse
          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
    ItemsCollectionReadS3DataWarehouse:
      properties:
        items:
          default: []
          items:
            $ref: '#/components/schemas/ReadS3DataWarehouse'
          type: array
      type: object
    BucketAccessResult:
      properties:
        accessible:
          type: boolean
        message:
          type: string
        retryable:
          type: boolean
      type: object
    CloudFormationSetupInfo:
      properties:
        awsAccountId:
          description: The AWS account ID
          type: string
        bucketName:
          description: The name of the S3 bucket to use for the data warehouse
          type: string
        orgName:
          description: The organization's name, which names its folder under the bucket's query-results prefix. The stack expires that folder's query results after a day.
          type: string
        region:
          description: The AWS region the bucket must be created in. Matches the region the Grepr deployment is running in.
          type: string
        roleName:
          description: The IAM role name for the data warehouse integration
          type: string
        stackName:
          description: The name of the CloudFormation stack
          type: string
      required:
      - awsAccountId
      - bucketName
      - orgName
      - region
      - roleName
      - stackName
      type: object
    ConsoleSetupInfo:
      properties:
        awsAccountId:
          description: The AWS account ID
          type: string
        bucketName:
          description: The name of the S3 bucket to use for the data warehouse
          type: string
        orgName:
          description: The name of the organization
          type: string
        region:
          description: The AWS region the bucket must be created in. Matches the region the Grepr deployment is running in.
          type: string
        resourcePolicy:
          description: The IAM policy to attach to the assumed role
          type: string
      required:
      - awsAccountId
      - bucketName
      - orgName
      - region
      - resourcePolicy
      type: object
    ReadS3DataWarehouse:
      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/S3DataWarehouse'
        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:
          - s3-data-warehouse
          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
    S3DataWarehouse:
      description: The payload containing integration data.
      properties:
        assumeRoleArn:
          description: The ARN of the role Grepr assumes to access the S3 bucket. Leave it empty to use your organization's role, the only one Grepr's hosted sites accept; the bucket's resource policy must let that role in. It can't be changed after the integration is created.
          pattern: ^(arn:aws:iam::[0-9]{12}:role/.*)?$
          type: string
        bucketName:
          description: The name of the S3 bucket to use for the data warehouse
          pattern: ^[a-z0-9][a-z0-9\-]{1,61}[a-z0-9]$
          type: string
        prefix:
          default: ''
          description: The prefix (folder) within the S3 bucket where data warehouse files will be stored
          type: string
        region:
          default: us-east-1
          description: The region of the S3 bucket
          type: string
      required:
      - bucketName
      type: object
      x-type:
        type: s3-data-warehouse
  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