For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETList Bulk Syncs
      • POSTCreate Bulk Sync
      • GETGet Bulk Sync
      • PUTUpdate Bulk Sync
      • DELDelete Bulk Sync
      • POSTActivate Bulk Sync
      • POSTCancel Bulk Sync
      • POSTStart Bulk Sync Execution
      • GETGet Bulk Sync Status
      • GETGet Bulk Source
      • GETGet Bulk Destination
        • GETList Bulk Sync Execution Status
        • GETList Bulk Sync Executions
        • GETGet Bulk Sync Execution
        • POSTCancel Bulk Sync Execution
        • GETGet Bulk Execution Console Logs
        • GETGet Bulk Sync Execution Logs
        • POSTExport Sync Logs
        • GETGet Bulk Schema Execution Console Logs
Logo
Log inBook a demo
API ReferenceBulk SyncExecutions

Export Sync Logs

POST
https://app.polytomic.com/api/bulk/syncs/:sync_id/executions/:execution_id/logs/export
POST
/api/bulk/syncs/:sync_id/executions/:execution_id/logs/export
$curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions/248df4b7-aa70-47b8-a036-33ac447e668d/logs/export \
>     -H "Authorization: Bearer <token>"
1{
2  "data": {
3    "url": "string"
4  },
5  "job": {
6    "error": "error message",
7    "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
8    "result": null,
9    "status": "created",
10    "type": "createmodel"
11  }
12}
Starts an asynchronous job that packages the log files for a single bulk sync execution into a downloadable archive. > 📘 Log export is asynchronous > > This endpoint starts a background job that packages an execution's log > files into a downloadable archive. The first call typically returns a > `job` descriptor instead of a completed result. Poll > [`GET /api/jobs/exportlogs/{id}`](../../../../../../../../api-reference/jobs/get) > with the returned `job_id` until `status` is `done`; the final response > contains a signed `url` that can be used to download the archive. > > Set `notify=true` to also email the requesting user when the archive is > ready.
Was this page helpful?
Previous

Get Bulk Schema Execution Console Logs

Next

Starts an asynchronous job that packages the log files for a single bulk sync execution into a downloadable archive.

📘 Log export is asynchronous

This endpoint starts a background job that packages an execution’s log files into a downloadable archive. The first call typically returns a job descriptor instead of a completed result. Poll GET /api/jobs/exportlogs/{id} with the returned job_id until status is done; the final response contains a signed url that can be used to download the archive.

Set notify=true to also email the requesting user when the archive is ready.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

sync_idstringRequiredformat: "uuid"
Unique identifier of the bulk sync.
execution_idstringRequiredformat: "uuid"
Unique identifier of the execution whose logs should be exported.

Headers

X-Polytomic-VersionstringOptional

Query parameters

notifybooleanOptional
Send a notification to the user when the logs are ready for download.

Response

OK
dataobject
jobobject

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error