imports

Cancel Import

Changed on

Request cancellation of a live import; one that has ended is returned unchanged.

post/v2/imports/{import_id}/cancel

Request

  • Base URL
    https://api.hud.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.hud.ai/v2/imports/{import_id}/cancel
  • Auth
    none declared

Path parameters

import_idstring uuid required

Response

Successful Response

idstring uuid required
format'harbor' required
taskset_idstring uuid required
status'queued' | 'starting' | 'running' | 'cancelling' | 'completed' | 'stopped' | 'failed' | 'cancelled' required

stopped: the importer refused the bundle or stopped partway, and its report says why; failed: the import did not run to an outcome

summarystring nullable

The importer's account of the outcome; set once completed or stopped

metricsobject nullable

Named counts the importer reports, e.g. tasks_imported; set with summary

errorstring nullable

Why a failed import failed

created_atstring date-time required
completed_atstring date-time nullable

Null while the import is live

Changes