API ReferenceBulk Sync

Create Bulk Sync

Create a new Bulk Sync from a source to a destination (data warehouse, database, or cloud storage bucket like S3).

Bulk Syncs are used for the ELT pattern (Extract, Load, and Transform), where you want to sync un-transformed data to your data warehouses, databases, or cloud storage buckets like S3.

All of the functionality described in the product documentation is configurable via the API.

Sample code examples:

Connection specific configuration

The destination_configuration is integration-specific configuration for the selected bulk sync destination. This includes settings such as the output schema and is required when creating a new sync.

The source_configuration is optional. It allows configuration for how Polytomic reads data from the source connection. This will not be available for integrations that do not support additional configuration.

Consult the connection configurations to see configurations for particular integrations (for example, here is the available source configuration for the PostgreSQL bulk sync source).

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
destination_configurationmap from strings to anyRequired
destination_connection_idstringRequiredformat: "uuid"
modeenumRequired
Either 'replicate' or 'snapshot'.
Allowed values:
namestringRequired
scheduleobjectRequired
source_connection_idstringRequiredformat: "uuid"
activebooleanOptional
automatically_add_new_fieldsenumOptional
Allowed values:
automatically_add_new_objectsenumOptional
Allowed values:
data_cutoff_timestampdatetimeOptional
disable_record_timestampsbooleanOptionalDefaults to false
discoverbooleanOptional

DEPRECATED: Use automatically_add_new_objects/automatically_add_new_fields instead

normalize_namesenumOptional
Allowed values:
organization_idstringOptionalformat: "uuid"
policieslist of stringsOptional
schemaslist of strings or objectsOptional

List of schemas to sync; if omitted, all schemas will be selected for syncing.

source_configurationmap from strings to anyOptional

Response

OK
dataobject or null

Errors