Collectoh
EN

This page is in English only for now. The main pages follow your choice.

Sign up free
Browse the docs

API reference

Jobs

Queue status, retry and cancel (job:manage).

Paths are relative to /api/v1 on your server.

GET/jobs#

Queue summaries

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · QueueSummary[]
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks job:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
DELETE/jobs/{queue}/{id}#

Cancel a job

Authorisation
Bearer token or API key · Session cookie
ParameterInTypeDescription
queue requiredpathstring
id requiredpathstring
  • 204Done; no body.
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks job:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
  • 404NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelope
POST/jobs/{queue}/{id}/retry#

Retry a failed job

Authorisation
Bearer token or API key · Session cookie
ParameterInTypeDescription
queue requiredpathstring
id requiredpathstring
  • 204Done; no body.
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks job:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
  • 404NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelope