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 Jobs API

The jobs API from Red Hat Ansible Automation Platform — 13 operation(s) for jobs.

Red Hat Ansible Automation Platform Jobs 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 Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

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

Requests are made against the base URL https://controller-host/api/v2/.

17 operations 13 paths 20 schemas 1 DELETE13 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 17

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

Jobs 17
GET
/api/v2/jobs/
Jobs list
jobs_list 7 params → 200
GET
/api/v2/jobs/{id}/
Jobs retrieve
jobs_retrieve 1 param → 200
DELETE
/api/v2/jobs/{id}/
Jobs destroy
jobs_destroy 1 param → 204
GET
/api/v2/jobs/{id}/activity_stream/
Jobs activity stream list
jobs_activity_stream_list 8 params → 200
GET
/api/v2/jobs/{id}/cancel/
Jobs cancel retrieve
jobs_cancel_retrieve 1 param → 200
POST
/api/v2/jobs/{id}/cancel/
Jobs cancel create
jobs_cancel_create 1 param → 200
GET
/api/v2/jobs/{id}/create_schedule/
Jobs create schedule retrieve
jobs_create_schedule_retrieve 1 param → 200
POST
/api/v2/jobs/{id}/create_schedule/
Jobs create schedule create
jobs_create_schedule_create 1 param → 200
GET
/api/v2/jobs/{id}/credentials/
Jobs credentials list
jobs_credentials_list 8 params → 200
GET
/api/v2/jobs/{id}/job_events/
Jobs job events list
jobs_job_events_list 8 params → 200
GET
/api/v2/jobs/{id}/job_events/children_summary/
Jobs job events children summary retrieve
jobs_job_events_children_summary_retrieve 1 param → 200
GET
/api/v2/jobs/{id}/job_host_summaries/
Jobs job host summaries list
jobs_job_host_summaries_list 8 params → 200
GET
/api/v2/jobs/{id}/labels/
Jobs labels list
jobs_labels_list 8 params → 200
GET
/api/v2/jobs/{id}/notifications/
Jobs notifications list
jobs_notifications_list 8 params → 200
GET
/api/v2/jobs/{id}/relaunch/
Jobs relaunch retrieve
jobs_relaunch_retrieve 1 param → 200
POST
/api/v2/jobs/{id}/relaunch/
Jobs relaunch create
jobs_relaunch_create 1 param body → 200
GET
/api/v2/jobs/{id}/stdout/
Jobs stdout retrieve
jobs_stdout_retrieve 2 params → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are JobDetail (59 properties), JobList (51 properties), JobEvent (27 properties), JobHostSummary (20 properties). Each schema is shown below with its type and property counts.

JobCreateSchedule
object
2 properties
JobList
object
51 properties 1 required
JobRelaunchRequest
object
3 properties
PaginatedNotificationList
object
4 properties 2 required
JobHostSummary
object
20 properties
ActivityStream
object
13 properties 3 required
Notification
object
15 properties 1 required
JobEvent
object
27 properties 1 required
JobCancel
object
1 property
JobDetail
object
59 properties 1 required
PaginatedLabelList
object
4 properties 2 required
UnifiedJobStdout
object
1 property
Credential
object
16 properties 2 required
JobRelaunch
object
2 properties
PaginatedActivityStreamList
object
4 properties 2 required
PaginatedCredentialList
object
4 properties 2 required
Label
object
9 properties 2 required
PaginatedJobEventList
object
4 properties 2 required
PaginatedJobHostSummaryList
object
4 properties 2 required
PaginatedJobListList
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-ansible-automation-platform-jobs-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 Jobs 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.