/api/ee/remote-sync

POST /api/ee/remote-sync/current-task/cancel

Changed on

Cancels the current task if one is running

post/api/ee/remote-sync/current-task/cancel

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Response

Successful response

cancelledboolean nullable
conflictsstring[] nullable
ended_atunknown
error_messagestring nullable
idinteger required
initiated_byinteger nullable
last_heartbeat_atunknown
last_progress_report_atunknown
outcomeobject nullable
progressnumber nullable required
started_atunknown required
status'running' | 'successful' | 'errored' | 'cancelled' | 'timed-out' | 'conflict' required
sync_task_type'import' | 'export' required
versionstring nullable

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • info

      api operation id post-api-ee-remote-sync-current-task-cancel was added

    • info

      added the optional property to the response with the status