imports

Stop a queued or running import (owner/admin)

Stops the transfer for real: the in-flight INSERT … SELECT FROM s3(…) is KILLed on the engine rather than merely marked cancelled, so it stops consuming resources immediately. killed_statements reports how many were actually stopped (0 is normal if the job was between statements). IDEMPOTENT: cancelling an already-finished import returns 200 with cancelled: false. NOTHING IS ROLLED BACK — an import is not a transaction, so tables it already created still exist and rows it already loaded are still there. The job's final cancelled step names exactly what was created and loaded; TRUNCATE or DROP what you do not want. We deliberately do NOT drop those tables for you: one of them may be a table you already had.

post/v1/projects/{project_id}/imports/{job_id}/cancel

Request

  • Base URL: https://api.wavehouse.cloud
  • URL: https://api.wavehouse.cloud/v1/projects/{project_id}/imports/{job_id}/cancel
  • Auth: one of:
    • API key in cookie whc_session
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

project_idstring required
job_idstring required

Response

OK

cancelledboolean required

false means the job had already finished and nothing was stopped — not an error

kill_errorstring

set when the engine could not be asked to stop the statement; the job is still cancelled and the worker will stop it, just less promptly

killed_statementsinteger required

in-flight ClickHouse statements stopped by this call; 0 is normal (the job may have been between statements)

Changes

No recorded changes to this operation across all 1 revision of this API.