Create a source sync to execute

Beta

POST

https://api-prod.scoutos.com/v2/syncs

POST

/v2/syncs

1 curl -X POST https://api-prod.scoutos.com/v2/syncs \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "sync_config": {
6     "source_settings": {
7       "source_archetype_id": "string",
8       "sitemap_url": "string"
9     },
10     "destination": {
11       "destination_type": "string",
12       "collection_id": "string",
13       "table_id": "string"
14     },
15     "mapping": {}
16   }
17 }'

Try it

200Successful

1 {
2   "data": {
3     "sync_config": {
4       "source_settings": {
5         "source_archetype_id": "string",
6         "sitemap_url": "string",
7         "crawler_settings": {
8           "scraper": {
9             "scraper_type": "http"
10           },
11           "text_extractor": {
12             "text_extractor_type": "readability"
13           },
14           "allow": "string",
15           "deny": "string",
16           "strip": "string",
17           "strip_urls": true,
18           "allowed_domains": "string",
19           "user_agent_header": "string",
20           "max_depth": 20,
21           "max_page_count": 8000,
22           "exclude_before_lastmod_date": "string"
23         },
24         "mode": "merge"
25       },
26       "destination": {
27         "destination_type": "string",
28         "collection_id": "string",
29         "table_id": "string"
30       },
31       "mapping": {
32         "fields": [
33           {}
34         ]
35       },
36       "schedule": {
37         "frequency": "string",
38         "enabled": true
39       }
40     },
41     "sync_id": "string",
42     "last_updated_at": "2024-01-15T09:30:00Z",
43     "created_at": "2024-01-15T09:30:00Z",
44     "created_by": {
45       "type": "user",
46       "details": {
47         "api_key": {}
48       }
49     },
50     "last_updated_by": {
51       "type": "user",
52       "details": {
53         "api_key": {}
54       }
55     },
56     "trigger_id": "string"
57   }
58 }

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

sync_configobjectRequired

Response

Successful Response

dataobject or null

Authentication

Request

Response

Errors