REST API task endpoints

The task endpoints under /rhui/api/v1/tasks/ report the status of Pulp tasks. All task endpoints require HTTP Basic authentication or a rhuiSessionId cookie.

Table 1. Task endpoints
Endpoint Description

GET /rhui/api/v1/tasks/running

List running Pulp tasks.

GET /rhui/api/v1/tasks/waiting

List waiting Pulp tasks.

GET /rhui/api/v1/tasks/running

Returns all Pulp tasks in the running state. Each item includes the task name, a derived task type, progress reports, and repository_ids resolved from reserved_resources_record, and from distribution tasks recorded in repository notes, when the task is coupled to Red Hat Update Infrastructure repositories.

Returns 200 with a RunningTasksResponse object (application/json). The 401, 500, and 503 common codes also apply. This endpoint does not return 400.

GET /rhui/api/v1/tasks/waiting

Returns all Pulp tasks in the waiting state, ordered by pulp_created in ascending order, so that the oldest queued task is first. Each item includes the task name, a derived task type, and repository_ids resolved from reserved_resources_record, and from distribution tasks recorded in repository notes, when the task is coupled to Red Hat Update Infrastructure repositories. Progress reports are not included, because the tasks have not started yet.

Returns 200 with a WaitingTasksResponse object (application/json). The 401, 500, and 503 common codes also apply. This endpoint does not return 400.

Table 2. Common response codes
Number Description Response

201

Client configuration RPM created — application/json

ClientRpmResponse

401

Authentication required or invalid credentials — application/json

Error

500

Unexpected internal error — application/json

Error

503

Required session signing configuration is missing or invalid — application/json

Error