KyPanelDocs
/

API reference

Jobs

Background jobs: long operations answer 202 with a job_id.

List background jobs

GET/api/v1/jobs

Who
root
API tokens
admin token area: accounts
Operation
listJobs · ky call listJobs

Responses

  • 200 OK
    Body
    FieldType
    itemsarray of StoreJob
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
  • 500 Internal Server Error: internal

Get a background job and its log

GET/api/v1/jobs/{id}

Who
root, reseller (ACL: list-accts or create-user-session); customer
API tokens
admin token area: accounts; account token area: account
Operation
getJob · ky call getJob

Parameters

NameIn
idpath
log_afterquery

Responses

  • 200 OK
    Body
    FieldType
    jobStoreJob
    logarray of StoreJobLog
    log_cursorinteger
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
  • 404 Not Found: not-found
  • 500 Internal Server Error: internal

Cancel a background job

POST/api/v1/jobs/{id}/cancel

Who
root
API tokens
admin token area: accounts
Operation
cancelJob · ky call cancelJob

Parameters

NameIn
idpath

Responses

  • 204 Done, no content
  • 401 Unauthorized: no session, or an invalid or expired token
  • 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
  • 409 Conflict: not-cancellable
  • 500 Internal Server Error: internal