Activate Sync

Sets whether a model sync is active. Only active syncs execute on schedule or in response to a manual trigger. Set `active` to `false` to pause a sync without deleting it. > 📘 Deactivating a sync does not cancel an execution that is already in > progress. Use [`POST /api/syncs/{id}/cancel`](../../../../api-reference/model-sync/cancel) to stop a > running execution.

Sets whether a model sync is active.

Only active syncs execute on schedule or in response to a manual trigger. Set active to false to pause a sync without deleting it.

📘 Deactivating a sync does not cancel an execution that is already in progress. Use POST /api/syncs/{id}/cancel to stop a running execution.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

activebooleanRequired

Response

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Sets whether a model sync is active.

Only active syncs execute on schedule or in response to a manual trigger. Set active to false to pause a sync without deleting it.

📘 Deactivating a sync does not cancel an execution that is already in progress. Use POST /api/syncs/{id}/cancel to stop a running execution.

This is the Polytomic deployment key (on-premises only)

This is the Polytomic API key

This endpoint expects an object.

$	curl -X POST https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate \
>	-H "X-Polytomic-Version: X-Polytomic-Version" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"active": true
>	}'

$	curl -X POST https://app.polytomic.com/api/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/activate \
>	-H "X-Polytomic-Version: X-Polytomic-Version" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{
>	"active": true
>	}'

Activate Sync

Authentication

Path parameters

Headers

Request

Response

Errors

Authentication

Path parameters

Headers

Request

Response

Errors

1	{
2	"data": {
3	"active": true,
4	"id": "248df4b7-aa70-47b8-a036-33ac447e668d"
5	}
6	}