Destination connections

Create a connection

Create a destination connection of a given type.

The set of connection_params fields depends on the destination. For s3:

  • connection_option — authentication method: aws_credentials (default), bucket_policy, or role_chaining
  • aws_access_key_id, aws_secret_access_key — AWS credentials; required only for aws_credentials (secret fields)
  • assume_role_arn — customer IAM role ARN; required only for role_chaining
  • improvado_assume_role_arn, improvado_assume_role_externalid — managed by Improvado and returned read-only; use them to build the trust policy on the customer side for role_chaining
  • aws_default_region — AWS region code, e.g. eu-west-1
  • bucket_name, folder, filename — target location; filename supports templates like {{ filename }}-{{ YYYY }}-{{ MM }}-{{ DD }}
  • file_format (parquet | csv | csv_gzip | csv_gz | json | json_gzip | json_gz | avro), separator, partition_by (by_day | by_month)
  • max_file_size_mb — optional chunking limit (45–100000); requires {{chunk_id}} in filename and file_format: parquet
  • encryption (no_storage_encryption | sse_s3 | sse_kms | sse_kms_with_customer_managed_key), encryption_key — required secret field: the KMS key id when using sse_kms_with_customer_managed_key, the literal placeholder stub for every other encryption option
  • use_load_by_accounts — split delivered files by account
post/api/v3/destinations/{destination_name}/connections

Request

Path parameters

destination_namestring required

Destination name

Request body

titlestring

Connection title

create_load_for_new_tablesboolean

Create load for new tables

destination_namestring

Destination name

connection_paramsobject

Connection params

Response

Create a Connection

Changes

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