Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat Job Templates API

Operations for managing job templates that define parameterized playbook runs against inventories of managed hosts.

Red Hat Job Templates API is one of 75 APIs that Red Hat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Job Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a changelog, and a GitHub repository.

This API exposes 6 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2.6.

Requests are made against a single base URL, https://ansible-platform.example.com.

6 operations 3 paths 4 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.6
Server
https://ansible-platform.example.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Red Hat Job Templates API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token for authenticating API requests to the automation controller.

Paths & Operations 6

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

Job Templates 6

Operations for managing job templates that define parameterized playbook runs against inventories of managed hosts.

GET
/api/v2/job_templates/
Red Hat List Job Templates
listJobTemplates 4 params → 200401
POST
/api/v2/job_templates/
Red Hat Create a Job Template
createJobTemplate body → 201400401
GET
/api/v2/job_templates/{id}/
Red Hat Get a Job Template
getJobTemplate 1 param → 200401404
PATCH
/api/v2/job_templates/{id}/
Red Hat Update a Job Template
updateJobTemplate 1 param body → 200400401404
DELETE
/api/v2/job_templates/{id}/
Red Hat Delete a Job Template
deleteJobTemplate 1 param → 204401404
POST
/api/v2/job_templates/{id}/launch/
Red Hat Launch a Job Template
launchJobTemplate 1 param body → 201400401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are JobTemplate (17 properties), Job (13 properties), PaginatedJobTemplateList (4 properties), Error (1 property). Each schema is shown below with its type and property counts.

Job
object
A job represents a single execution of a job template, tracking the playbook run status, timing, and output.
13 properties
PaginatedJobTemplateList
object
A paginated list of job templates.
4 properties
JobTemplate
object
A job template defines the parameters for running an Ansible playbook against an inventory of managed hosts.
17 properties
Error
object
An error response from the API.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-job-templates-api-openapi.yml Raw ↑

Other APIs Red Hat publishes across the network.

Red Hat Subscription Management API
Red Hat Advanced Cluster Management API
Red Hat Advanced Cluster Security API
Red Hat 3scale API Management
Red Hat Cost Management API
Red Hat Image Builder API
Red Hat Vulnerability Management API
Red Hat Patch API
Red Hat Compliance API
Red Hat Build of Apicurio Registry API
Red Hat Streams for Apache Kafka Bridge API
Red Hat Ansible Lightspeed API