REST API
- Introduction
- Models
- Connector Definitions
- Connectors
- Syncs
- Sync Runs
- Sync Records
- Reports
- Roles
- Catalogs
Syncs
Create Sync
POST
/
api
/
v1
/
syncs
curl --request POST \
--url https://api.squared.ai/api/v1/syncs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"sync": {
"source_id": 123,
"destination_id": 123,
"model_id": 123,
"schedule_type": "automated",
"configuration": {},
"stream_name": "<string>",
"sync_mode": "full_refresh",
"sync_interval": 123,
"sync_interval_unit": "minutes",
"cron_expression": "<string>",
"cursor_field": "<string>"
}
}'
{
"id": "<string>",
"type": "syncs",
"attributes": {
"source_id": 123,
"destination_id": 123,
"model_id": 123,
"configuration": {},
"schedule_type": "automated",
"sync_mode": "full_refresh",
"sync_interval": 123,
"sync_interval_unit": "minutes",
"cron_expression": "<string>",
"cursor_field": "<string>",
"stream_name": "<string>",
"status": "<string>"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Available options:
automated
Available options:
full_refresh
Available options:
minutes
Response
200 - application/json
Sync operation created successfully
Available options:
syncs
Available options:
automated
Available options:
full_refresh
Available options:
minutes
Was this page helpful?
curl --request POST \
--url https://api.squared.ai/api/v1/syncs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"sync": {
"source_id": 123,
"destination_id": 123,
"model_id": 123,
"schedule_type": "automated",
"configuration": {},
"stream_name": "<string>",
"sync_mode": "full_refresh",
"sync_interval": 123,
"sync_interval_unit": "minutes",
"cron_expression": "<string>",
"cursor_field": "<string>"
}
}'
{
"id": "<string>",
"type": "syncs",
"attributes": {
"source_id": 123,
"destination_id": 123,
"model_id": 123,
"configuration": {},
"schedule_type": "automated",
"sync_mode": "full_refresh",
"sync_interval": 123,
"sync_interval_unit": "minutes",
"cron_expression": "<string>",
"cursor_field": "<string>",
"stream_name": "<string>",
"status": "<string>"
}
}