{ "opencollection": "1.0.0", "info": { "name": "Red Hat Ansible Automation Platform Add-Ons Job Templates API", "version": "2.6" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Job Templates", "type": "folder" }, "items": [ { "info": { "name": "Red Hat List Job Templates", "type": "http" }, "http": { "method": "GET", "url": "https://ansible-platform.example.com/api/v2/job_templates/", "params": [ { "name": "page", "value": "", "type": "query", "description": "The page number for paginated results." }, { "name": "page_size", "value": "", "type": "query", "description": "The number of results to return per page." }, { "name": "search", "value": "", "type": "query", "description": "A search term to filter results by name or description." }, { "name": "ordering", "value": "", "type": "query", "description": "The field to use for ordering results. Prefix with a dash for descending order (e.g., -created)." } ] }, "docs": "Retrieves a paginated list of job templates. Job templates define the parameters for running Ansible playbooks against specified inventories, including the project, playbook, credentials, and extra variables." }, { "info": { "name": "Red Hat Create a Job Template", "type": "http" }, "http": { "method": "POST", "url": "https://ansible-platform.example.com/api/v2/job_templates/", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new job template with the specified configuration. Requires at minimum a name, project, playbook, and inventory reference." }, { "info": { "name": "Red Hat Get a Job Template", "type": "http" }, "http": { "method": "GET", "url": "https://ansible-platform.example.com/api/v2/job_templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique numeric identifier of the resource." } ] }, "docs": "Retrieves the details of a specific job template by its identifier." }, { "info": { "name": "Red Hat Update a Job Template", "type": "http" }, "http": { "method": "PATCH", "url": "https://ansible-platform.example.com/api/v2/job_templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique numeric identifier of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing job template. Only the fields provided in the request body will be modified." }, { "info": { "name": "Red Hat Delete a Job Template", "type": "http" }, "http": { "method": "DELETE", "url": "https://ansible-platform.example.com/api/v2/job_templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique numeric identifier of the resource." } ] }, "docs": "Deletes a job template. Associated job runs will not be deleted but will no longer be linked to a template." }, { "info": { "name": "Red Hat Launch a Job Template", "type": "http" }, "http": { "method": "POST", "url": "https://ansible-platform.example.com/api/v2/job_templates/:id/launch/", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique numeric identifier of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Launches a job from the specified job template. Optional extra variables, credentials, and inventory overrides can be provided in the request body. Returns the created job record with its identifier for tracking execution progress." } ] } ], "bundled": true }