How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat Ansible Automation Platform Tasks API

The Tasks API from Red Hat Ansible Automation Platform — 11 operation(s) for tasks.

Red Hat Ansible Automation Platform Tasks API is one of 333 APIs that Red Hat Ansible Automation Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Task. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 13 operations across 11 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version v3.

Requests are made against a single base URL, http://automation-hub-backend-cwa.automation-hub-prod.svc.cluster.local:8000/.

13 operations 11 paths 13 schemas 1 DELETE8 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://controller-host/api/v2/
License
Resource Areas
1

Paths & Operations 13

Across 11 paths, the API surfaces 13 operations — 1 DELETE, 8 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Tasks 13
GET
/api/automation-hub/content/{path}/v3/tasks/
List tasks
_api_automation-hub_content_{path}_v3_tasks_tasks_list 44 params → 200
GET
/api/automation-hub/content/{path}/v3/tasks/{pulp_id}/
Inspect a task
_api_automation-hub_content_{path}_v3_tasks_{pulp_id}_tasks_read 4 params → 200
GET
/api/automation-hub/pulp/api/v3/tasks/
List tasks
_api_automation-hub_pulp_api_v3_tasks_tasks_list 43 params → 200
GET
/api/automation-hub/pulp/api/v3/tasks/{pulp_id}/
Inspect a task
_api_automation-hub_pulp_api_v3_tasks_{pulp_id}_tasks_read 3 params → 200
PATCH
/api/automation-hub/pulp/api/v3/tasks/{pulp_id}/
Cancel a task
tasks_cancel 1 param body → 200409
DELETE
/api/automation-hub/pulp/api/v3/tasks/{pulp_id}/
Delete a task
tasks_delete 1 param → 204
POST
/api/automation-hub/pulp/api/v3/tasks/{pulp_id}/add_role/
Add a role
tasks_add_role 1 param body → 201
GET
/api/automation-hub/pulp/api/v3/tasks/{pulp_id}/list_roles/
List roles
tasks_list_roles 3 params → 200
GET
/api/automation-hub/pulp/api/v3/tasks/{pulp_id}/my_permissions/
List user permissions
tasks_my_permissions 3 params → 200
POST
/api/automation-hub/pulp/api/v3/tasks/{pulp_id}/remove_role/
Remove a role
tasks_remove_role 1 param body → 201
POST
/api/automation-hub/pulp/api/v3/tasks/purge/
Purge Completed Tasks
tasks_purge body → 202
GET
/api/automation-hub/v3/tasks/
List tasks
_api_automation-hub_v3_tasks_tasks_list 43 params → 200
GET
/api/automation-hub/v3/tasks/{pulp_id}/
Inspect a task
_api_automation-hub_v3_tasks_{pulp_id}_tasks_read 3 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are TaskResponse (12 properties), ProgressReportResponse (6 properties), TaskSummaryResponse (6 properties), PaginatedTaskResponseList (4 properties). Each schema is shown below with its type and property counts.

ProgressReportResponse
object
Base serializer for use with :class:pulpcore.app.models.Model This ensures that all Serializers provide values for the 'pulphref field. The class provides a de…
6 properties
StatesEnum
string
skipped - skipped completed - completed failed - failed canceled - canceled
MyPermissionsResponse
object
1 property 1 required
NestedRole
object
Serializer to add/remove object roles to/from users/groups. This is used in conjunction with pulpcore.app.viewsets.base.RolesMixin and requires the underlying…
3 properties 1 required
Purge
object
2 properties
AsyncOperationResponse
object
Serializer for asynchronous operations.
1 property 1 required
NestedRoleResponse
object
Serializer to add/remove object roles to/from users/groups. This is used in conjunction with pulpcore.app.viewsets.base.RolesMixin and requires the underlying…
3 properties 1 required
TaskResponse
object
12 properties 8 required
PatchedTaskCancel
object
Base serializer for use with :class:pulpcore.app.models.Model This ensures that all Serializers provide values for the 'pulphref field. The class provides a de…
1 property
PaginatedTaskSummaryResponseList
object
3 properties
ObjectRolesResponse
object
1 property 1 required
PaginatedTaskResponseList
object
4 properties 2 required
TaskSummaryResponse
object
TaskSerializer but without detail fields. For use in /tasks/ / detail views.
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-tasks-api-openapi.yml Raw ↑

Other APIs Red Hat Ansible Automation Platform publishes across the network.

Red Hat Automation Services Catalog API
Red Hat Ansible Automation Platform Access Policies API
Red Hat Ansible Automation Platform Acs: File API
Red Hat Ansible Automation Platform Activation Instances API
Red Hat Ansible Automation Platform Activations API
Red Hat Ansible Automation Platform Activity Stream API
Red Hat Ansible Automation Platform Ad Hoc Command Events API
Red Hat Ansible Automation Platform Ad Hoc Commands API
Red Hat Ansible Automation Platform AI API
Red Hat Ansible Automation Platform Analytics API
Red Hat Ansible Automation Platform Ansible: Collections API
Red Hat Ansible Automation Platform Api: API
Where this information came from

This is an independent, third-party profile of Red Hat Ansible Automation Platform Tasks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.