Collectoh
EN

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

Sign up free
Browse the docs

API reference

Maintenance

Scheduled tasks and the maintenance window (P1-36).

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

GET/maintenance#

Read the scheduled tasks and window

Authorisation
Bearer token or API key · Session cookie
  • 200Success. application/json · MaintenanceStatus
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings:manage, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope
POST/maintenance/tasks/{task}/run#

Run a task now

Authorisation
Bearer token or API key · Session cookie
ParameterInTypeDescription
task requiredpathstring
  • 202Success. application/json · object
  • 401UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope
  • 403FORBIDDEN: the account lacks settings: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