Scheduling

List the jobs

get/api/v1/scheduling/jobs

Request

  • Base URL
    https://pcp.example.com
  • Auth
    HTTP bearer

Query parameters

offsetinteger

Number of items to skip.

limitinteger

Maximum number of items to return.

resource_type'origin' | 'target'

Which side resource_id matches.

task_status'queued' | 'running' | 'canceled' | 'succeeded' | 'failed'

Only jobs in this state.

task_type'backup' | 'sync' | 'restore' | 'check' | 'prune' | 'rm'

Only jobs of this task type.

task_idstring uuid

Only jobs of this task.

resource_idstring uuid

Only jobs touching this connector.

actorstring

Scheduler to address. default: tasks created through the UI or the API. policy: tasks created by SLA policies, and their jobs. custom: tasks of integrations that drive the scheduler, such as Kubernetes; deprecated in favor of user:<uuid>. user: the caller's personal scheduler; 404 until POST /scheduling/scheduler creates it. user:<uuid>: the personal scheduler of another user; needs view access on schedulers.

organization_idstring uuid

Organization to act on, at or below the caller's. Defaults to the caller's.

Response

OK

totalinteger

Changes

No recorded changes to this operation across all 1 revision of this API.