SIsimilarweb

S3 Integration

This endpoint creates a new S3 integration, and generates an AWS access and secret keys to be used for reading the data written to this integration's folders.

post/v3/batch/s3-connector/setup

Request

  • Base URL
    https://api.similarweb.com/v1/website
  • URL
    https://api.similarweb.com/v1/website/v3/batch/s3-connector/setup
  • Auth
    none required

Response

200

aws_access_keystring
aws_secret_keystring
expiration_datestring
integration_namestring
s3_bucketstring
s3_prefixstring

Example response

{
  "aws_access_key": "S3-ACCESS-KEY",
  "aws_secret_key": "S3-SECRET-KEY",
  "expiration_date": "2025-10-22",
  "integration_name": "s3_default",
  "s3_bucket": "my_bucket",
  "s3_prefix": "account_id/my_new_integration/"
}

Changes

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