Ansible Playbooks Hosts API

openapi: 3.1.0
info:
  title: Ansible Automation Controller Playbooks Auth Hosts API
  version: '2'
  description: 'REST API for managing and executing Ansible playbooks via the Ansible

    Automation Controller (formerly Ansible Tower / AWX), the enterprise

    automation engine inside the Red Hat Ansible Automation Platform.

    Playbooks live inside projects (SCM-synced from Git, etc.) and are run

    via job templates that bind them to inventories, credentials, and

    extra variables. The API exposes management of inventories, hosts,

    credentials, projects, job templates, workflow job templates,

    schedules, organizations, teams, users, and the launching and

    inspection of jobs.

    '
  contact:
    name: Red Hat Ansible Support
    url: https://access.redhat.com/products/red-hat-ansible-automation-platform/
servers:
- url: https://{controller_host}/api/v2
  description: Self-hosted Ansible Automation Controller deployment
  variables:
    controller_host:
      default: controller.example.com
      description: Hostname of the Automation Controller instance.
security:
- OAuth2Token: []
- BasicAuth: []
tags:
- name: Hosts
paths:
  /hosts/:
    get:
      tags:
      - Hosts
      summary: List hosts
      operationId: listHosts
      responses:
        '200':
          $ref: '#/components/responses/ListResponse'
    post:
      tags:
      - Hosts
      summary: Create a host
      operationId: createHost
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - inventory
              properties:
                name:
                  type: string
                description:
                  type: string
                inventory:
                  type: integer
                enabled:
                  type: boolean
                variables:
                  type: string
                  description: YAML/JSON host variables.
      responses:
        '201':
          description: Created.
components:
  responses:
    ListResponse:
      description: A paginated list response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListResponse'
  schemas:
    ListResponse:
      type: object
      properties:
        count:
          type: integer
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            type: object
            additionalProperties: true
  securitySchemes:
    OAuth2Token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Personal or application OAuth2 access token.
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using local controller credentials.