Cancel a Pipeline Job

Cancels the running job for the specified job_id. Hevo stops the tasks running in that job. Canceling a historical load or a resync job also cancels the incremental jobs running alongside it. Hevo does not cancel the jobs that are queued behind this one. The Pipeline keeps its schedule, so the next job runs at the configured sync frequency.

Hevo does not cancel the job immediately. The response returns the details of the job at the time Hevo accepted the request. To check whether the job has been canceled, call the Get Details of a Pipeline Job endpoint and read its status value.

Refer to Canceling a Job for more information about canceling a job.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Unique identifier of the Pipeline.

string
required

Unique identifier of the job.

Responses

400

The job could not be canceled. This occurs when:

  • The job has already finished, or a cancellation is already in progress.
  • Hevo is already processing another cancel request or a resync of the Pipeline.
  • The job is an incremental job that runs alongside a historical load or a resync. Cancel the historical load job or the resync job instead.

You can cancel a job with the FAILED status if Hevo is still trying to load its data to the Destination.

403

You do not have the permission to cancel a job. Ask your team administrator for a role that allows it.

404

The Pipeline or the job could not be found. This occurs when:

  • No Pipeline exists with the specified pipeline_id, or you do not have access to it.
  • The Pipeline is deleted, or its deletion is in progress.
  • The Pipeline is in a different region from the base URL that you call.
  • No job exists with the specified job_id in this Pipeline, or the job_id value is not a valid identifier.
500

The job finished between the moment Hevo checked it and the moment the service that runs it received the cancel request. Read the job again to see its final status.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json