Deleting Jobs via Jobs API

This page guides you through the process of deleting a job using the Jobs API.

❗️

Your pipeline may still receive data after cancellation as any currently executing work will not be cancelled.

Required Parameters

Before using the Jobs API, ensure you have the following:

• Job ID: The ID of the specific job you want to query.
• Pipeline ID: The ID of the pipeline for which you want to list jobs.
• Component ID: The ID of the component within the pipeline.

Cancel Job

Only jobs in ready, scheduled, and running states can be cancelled

To cancel a job

curl --request DELETE --location 'https://api.platform.datastreamer.io/api/pipelines/:PipelineId/components/:ComponentId/jobs/:JobId' \
--header 'apikey: API_KEY'

Example

Here is an example of how the curl command might look after replacing the placeholders:

curl --location 'https://api.platform.datastreamer.io/api/pipelines/12345/components/67890/jobs/job123' \
--header 'apikey: abcdef123456'

The API will an empty success response after a job is deleted.