Cancel Job

Unified endpoint to cancel different types of the jobs.

The cancelled job will immediatelly act in the consistent behaviour for the user, e.g. like “cancelled” job, and don’t block progress/results methods. Under the hood the Watchdog micro-service will gracefully stop the task/container running the job by sending it the SIGTERM signal using ECS API.

Args: job_id (str): ID of the job. user (User): User authenticated with api key.

Returns: BaseModel: The Job pydantic model object.

POST /jobs/{job_id}/cancel

Cancel Job

cURL

curl --request POST \
  --url 'https://api.example.com/jobs/{job_id}/cancel?HAIQU_API_KEY='

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

APIKeyQueryAPIKeyHeader

HAIQU_API_KEY · string · query · required

Path Parameters

job_id · string · required

Response

200

application/json

Successful Response