Storage Integration API

Storage Integration is a snowflake object that is created in your snowflake account to allow complete control and ownership of the object.

You can use the Storage Integration API to retrieve the storage bucket details and the AWS role name that can be used to access the storage bucket.
Note: Before creating an account with the user-provided storage integration, you must post this API.

Request

POST {{api_uri}}/{{tenant}}/storageDetails

Response

Returns the storage bucket details and the AWS role name.

Sample Request

POST {{api_uri}}/{{tenant}}/storageDetails
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512

Example

{{api_uri}}: https://dev-analytics-connector.reltio.com/api/v1

Request Body

{
   "tenantId": "{{tenantId}}"
}

Sample Response

{
  "tenantId": "{{tenantId}}",
  "stagePath": "{{s3_integration}}",
  "awsStorageRoleArn": "arn:aws:iam::1234:role/myrole,
  "awsStorageRoleName": "{{storage_role_name}}",
  "sampleSqlStorageIntegration": "create or replace storage integration \{{s3_integration}}\" type = external_storage enabled = true storage_allowed_locations =('s3://my-bucket/mypath/') storage_provider = S3 storage_aws_role_arn = \"arn:aws:iam::1234:role/myrole\""
}
Note: If the existing storage integrations are modified, an error is generated. Instead, delete and recreate the storage integrations across all jobs for a given environment and tenant.

After you retrieve the storage bucket details, use the Storage Integration API to return the details of the storage bucket and the AWS role name, which the tenant can use to access the storage bucket.

Request

GET {{api_uri}}/{{tenant}}/storageDetails

Response

Returns the storage bucket details and AWS access role.

Sample Request

GET {{api_uri}}/{{tenant}}/storageDetails
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512

Example

{{api_uri}}: https://dev-analytics-connector.reltio.com/api/v1

Sample Response

{
  "tenantId": "{{tenantId}}",
  "stagePath": "{{s3_integration}}",
  "awsStorageRoleArn": "arn:aws:iam::1234:role/myrole,
  "awsStorageRoleName": "{{storage_role_name}}",
  "sampleSqlStorageIntegration": "create or replace storage integration \{{s3_integration}}\" type = external_storage enabled = true storage_allowed_locations =('s3://my-bucket/mypath/') storage_provider = S3 storage_aws_role_arn = \"arn:aws:iam::1234:role/myrole\""
}