External S3 Data Warehouse Integration

Validate whether Grepr can access the S3 bucket

Validates whether Grepr can access the S3 bucket. This can be used to test the bucket access before creating the integration.

post/v1/integrations/s3-data-warehouse/test

Request

  • Base URL
    https://docs.grepr.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header GREPR-API-KEY
    • or OpenID Connect (https://grepr-prod.us.auth0.com/.well-known/openid-configuration)

Request body

namestring required

Name of the integration.

teamIdsstring[]

The team IDs that this integration is associated with.

type's3-data-warehouse' required

The type of the integration. This is used to determine the payload type.

versioninteger required

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 request

{
  "name": "my_integration"
}

Response

Bucket access validation completed successfully

accessibleboolean
messagestring
retryableboolean

Changes

No recorded changes to this operation across all 1 revision of this API.