Destination connections

List destination connections

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

Get detailed info about destination connection

Update the title and/or connection parameters of an existing destination connection.

connection_params is merged at field level: only the fields present in the payload are updated, omitted fields keep their current values. To change a single setting, send just that field — e.g. {"connection_params": {"partition_by": "by_month"}}.

Notes:

• Unknown field names are rejected with 400.
• Secret fields cannot be updated one at a time — if any secret field is present in the payload, all required secret fields must be sent together. For s3 that means aws_access_key_id, aws_secret_access_key and encryption_key always travel as a trio (keep encryption_key: "stub" unless you use a customer-managed KMS key). Omit secret fields entirely to keep the stored values.
• improvado_assume_role_arn and improvado_assume_role_externalid are managed by Improvado and cannot be changed through this endpoint.
• A successful update resets the connection status and triggers a connection re-check.

See the create endpoint for the full list of connection_params fields per destination.

Allows to update create_load_for_new_tables value for destination connection

Starts a manual status check of a destination connection. If a destination connection has invalid or staled connection credentials – the system will mark this destination connection as invalid for future loads.