Metric Collection Job
Cancel a metric collection job
Changed onStops a metric collection job that has not finished. No further conversations are processed and the job ends in CANCELED.
Items the job had not reached are marked SKIPPED. Metric values already produced are kept, and items that were mid-computation when the cancel arrived may still complete. Only the items that completed are billed.
Safe to call more than once: a job that has already finished (COMPLETED, FAILED, or CANCELED) is returned unchanged.
post/v1/metric/collection-jobs/{jobId}/cancel
Request
- Base URLhttps://api.roark.ai
- URLhttps://api.roark.ai/v1/metric/collection-jobs/{jobId}/cancel
- AuthHTTP bearer
Path parameters
jobIdstring uuid required
The ID of the metric collection job to cancel
Response
The canceled job, or the job unchanged if it had already finished
Changes
- info
endpoint added
- info