openapi: 3.2.0 info: title: AWX Inventories API version: v2 description: AWX API Documentation contact: email: ansible-community@redhat.com license: name: Apache License tags: - name: Inventories paths: /api/v2/inventories/: get: operationId: inventories_list parameters: - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryList' description: '' x-ai-description: A list of inventories. summary: Inventories list x-summary-source: derived post: operationId: inventories_create tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/InventoryRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Inventory' description: '' x-ai-description: Create an inventory to define the set of hosts that jobs can target. summary: Inventories create x-summary-source: derived /api/v2/inventories/{id}/: get: operationId: inventories_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/Inventory' description: '' x-ai-description: Retrieve an inventory summary: Inventories retrieve x-summary-source: derived put: operationId: inventories_update parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/InventoryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Inventory' description: '' x-ai-description: Update an inventory summary: Inventories update x-summary-source: derived patch: operationId: inventories_partial_update parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedInventoryRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Inventory' description: '' x-ai-description: Update an inventory summary: Inventories partial update x-summary-source: derived delete: operationId: inventories_destroy parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories responses: '204': description: No response body x-ai-description: Delete an inventory summary: Inventories destroy x-summary-source: derived /api/v2/inventories/{id}/access_list/: get: operationId: inventories_access_list_list parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedResourceAccessListElementList' description: '' x-ai-description: List users who can access the inventory summary: Inventories access list list x-summary-source: derived /api/v2/inventories/{id}/activity_stream/: get: operationId: inventories_activity_stream_list parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedActivityStreamList' description: '' x-ai-description: Get activity stream for an inventory summary: Inventories activity stream list x-summary-source: derived /api/v2/inventories/{id}/ad_hoc_commands/: get: operationId: inventories_ad_hoc_commands_list parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAdHocCommandListList' description: '' x-ai-description: List ad hoc command for an inventory summary: Inventories ad hoc commands list x-summary-source: derived post: operationId: inventories_ad_hoc_commands_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/AdHocCommandListRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/AdHocCommandList' description: '' x-ai-description: Run an ad hoc command against all hosts in an inventory. Executes a single Ansible module without a playbook. summary: Inventories ad hoc commands create x-summary-source: derived /api/v2/inventories/{id}/copy/: get: operationId: inventories_copy_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/Copy' description: '' x-ai-description: Retrieve a copy of an inventory summary: Inventories copy retrieve x-summary-source: derived post: operationId: inventories_copy_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/CopyRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Copy' description: '' x-ai-description: Create a copy of an inventory summary: Inventories copy create x-summary-source: derived /api/v2/inventories/{id}/groups/: get: operationId: inventories_groups_list parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGroupList' description: '' x-ai-description: List groups of an inventory summary: Inventories groups list x-summary-source: derived post: operationId: inventories_groups_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Group' description: '' x-ai-description: Create a group of an inventory summary: Inventories groups create x-summary-source: derived /api/v2/inventories/{id}/hosts/: get: operationId: inventories_hosts_list parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedHostList' description: '' x-ai-description: List hosts of an inventory summary: Inventories hosts list x-summary-source: derived post: operationId: inventories_hosts_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/HostRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Host' description: '' x-ai-description: Create a host of an inventory summary: Inventories hosts create x-summary-source: derived /api/v2/inventories/{id}/input_inventories/: get: operationId: inventories_input_inventories_list description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryList' description: '' x-ai-description: Get or create input inventory inventory summary: Inventories input inventories list x-summary-source: derived post: operationId: inventories_input_inventories_create description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/InventoryRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Inventory' description: '' x-ai-description: Get or create input inventory inventory summary: Inventories input inventories create x-summary-source: derived /api/v2/inventories/{id}/instance_groups/: get: operationId: inventories_instance_groups_list description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInstanceGroupList' description: '' x-ai-description: List instance groups of an inventory summary: Inventories instance groups list x-summary-source: derived post: operationId: inventories_instance_groups_create description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/InstanceGroupRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/InstanceGroup' description: '' x-ai-description: Create an instance group of an inventory summary: Inventories instance groups create x-summary-source: derived /api/v2/inventories/{id}/inventory_sources/: get: operationId: inventories_inventory_sources_list parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventorySourceList' description: '' x-ai-description: List inventory sources summary: Inventories inventory sources list x-summary-source: derived post: operationId: inventories_inventory_sources_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/InventorySourceRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/InventorySource' description: '' x-ai-description: Create an inventory source summary: Inventories inventory sources create x-summary-source: derived /api/v2/inventories/{id}/job_templates/: get: operationId: inventories_job_templates_list parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedJobTemplateList' description: '' x-ai-description: List job templates using an inventory summary: Inventories job templates list x-summary-source: derived /api/v2/inventories/{id}/labels/: get: operationId: inventories_labels_list description: 'For related labels lists like /api/v2/inventories/N/labels/ We want want the last instance to be deleted from the database when the last disassociate happens. Subclasses need to define parent_model' parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedLabelList' description: '' x-ai-description: List labels of an inventory summary: Inventories labels list x-summary-source: derived post: operationId: inventories_labels_create description: 'For related labels lists like /api/v2/inventories/N/labels/ We want want the last instance to be deleted from the database when the last disassociate happens. Subclasses need to define parent_model' parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/LabelRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Label' description: '' x-ai-description: Create or attach a label to a resource summary: Inventories labels create x-summary-source: derived /api/v2/inventories/{id}/object_roles/: get: operationId: inventories_object_roles_list parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRoleList' description: '' x-ai-description: List roles of an inventory summary: Inventories object roles list x-summary-source: derived /api/v2/inventories/{id}/root_groups/: get: operationId: inventories_root_groups_list parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGroupList' description: '' x-ai-description: List root (top-level) groups of an inventory summary: Inventories root groups list x-summary-source: derived post: operationId: inventories_root_groups_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Group' description: '' x-ai-description: List root (top-level) groups of an inventory summary: Inventories root groups create x-summary-source: derived /api/v2/inventories/{id}/script/: get: operationId: inventories_script_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories responses: '200': description: No response body x-ai-description: Generate inventory group and host data as needed for an inventory script summary: Inventories script retrieve x-summary-source: derived /api/v2/inventories/{id}/tree/: get: operationId: inventories_tree_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupTree' description: '' x-ai-description: Create group tree for an inventory summary: Inventories tree retrieve x-summary-source: derived /api/v2/inventories/{id}/update_inventory_sources/: get: operationId: inventories_update_inventory_sources_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventorySourceUpdate' description: '' x-ai-description: Retrieve single source for an inventory summary: Inventories update inventory sources retrieve x-summary-source: derived post: operationId: inventories_update_inventory_sources_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventorySourceUpdate' description: '' x-ai-description: Update inventory sources summary: Inventories update inventory sources create x-summary-source: derived /api/v2/inventories/{id}/variable_data/: get: operationId: inventories_variable_data_retrieve parameters: - in: query name: format schema: type: string enum: - json - yaml - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryVariableData' application/yaml: schema: $ref: '#/components/schemas/InventoryVariableData' description: '' x-ai-description: Retrieve single datum for an inventory summary: Inventories variable data retrieve x-summary-source: derived put: operationId: inventories_variable_data_update parameters: - in: query name: format schema: type: string enum: - json - yaml - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/InventoryVariableDataRequest' application/yaml: schema: $ref: '#/components/schemas/InventoryVariableDataRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryVariableData' application/yaml: schema: $ref: '#/components/schemas/InventoryVariableData' description: '' x-ai-description: Update existing datum for an inventory summary: Inventories variable data update x-summary-source: derived patch: operationId: inventories_variable_data_partial_update parameters: - in: query name: format schema: type: string enum: - json - yaml - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventories requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedInventoryVariableDataRequest' application/yaml: schema: $ref: '#/components/schemas/PatchedInventoryVariableDataRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventoryVariableData' application/yaml: schema: $ref: '#/components/schemas/InventoryVariableData' description: '' x-ai-description: Partially update existing datum for an inventory summary: Inventories variable data partial update x-summary-source: derived components: schemas: CopyRequest: type: object properties: name: type: string minLength: 1 required: - name Group: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true created: type: string readOnly: true modified: type: string readOnly: true name: type: - string - 'null' maxLength: 512 description: type: - string - 'null' default: '' inventory: type: integer variables: type: - string - 'null' default: '' description: Group variables in JSON or YAML format. required: - inventory - name Host: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true created: type: string readOnly: true modified: type: string readOnly: true name: type: - string - 'null' maxLength: 512 description: type: - string - 'null' default: '' inventory: type: integer enabled: type: - boolean - 'null' default: true description: Is this host online and available for running jobs? instance_id: type: - string - 'null' default: '' description: The value used by the remote inventory source to uniquely identify the host maxLength: 1024 variables: type: - string - 'null' default: '' description: Host variables in JSON or YAML format. has_active_failures: type: string readOnly: true has_inventory_sources: type: string readOnly: true last_job: type: - integer - 'null' readOnly: true last_job_host_summary: type: - integer - 'null' readOnly: true ansible_facts_modified: type: - string - 'null' format: date-time readOnly: true description: The date and time ansible_facts was last modified. required: - inventory - name PaginatedResourceAccessListElementList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/ResourceAccessListElement' Inventory: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true created: type: string readOnly: true modified: type: string readOnly: true name: type: - string - 'null' maxLength: 512 description: type: - string - 'null' default: '' organization: type: - integer - 'null' description: Organization containing this inventory. kind: enum: - '' - smart - constructed - null type: - string - 'null' x-spec-enum-id: 2ff9e8df76c2ad0e default: '' description: 'Kind of inventory being represented. * `` - Hosts have a direct link to this inventory. * `smart` - Hosts for inventory generated using the host_filter property. * `constructed` - Parse list of source inventories with the constructed inventory plugin.' host_filter: type: - string - 'null' description: Filter that will be applied to the hosts of this inventory. variables: type: - string - 'null' default: '' description: Inventory variables in JSON or YAML format. has_active_failures: type: boolean readOnly: true description: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. total_hosts: type: integer minimum: 0 readOnly: true description: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. hosts_with_active_failures: type: integer minimum: 0 readOnly: true description: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. total_groups: type: integer minimum: 0 readOnly: true description: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. has_inventory_sources: type: boolean readOnly: true description: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. total_inventory_sources: type: integer minimum: 0 readOnly: true description: Total number of external inventory sources configured within this inventory. inventory_sources_with_failures: type: integer minimum: 0 readOnly: true description: Number of external inventory sources in this inventory with failures. pending_deletion: type: boolean readOnly: true description: Flag indicating the inventory is being deleted. prevent_instance_group_fallback: type: - boolean - 'null' default: false description: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. opa_query_path: type: - string - 'null' description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule. maxLength: 128 required: - name - organization PaginatedInventorySourceList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/InventorySource' JobTemplate: type: object description: Provide recent jobs and survey details in summary_fields properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true created: type: string readOnly: true modified: type: string readOnly: true name: type: - string - 'null' maxLength: 512 description: type: - string - 'null' default: '' job_type: enum: - run - check - null type: - string - 'null' description: '* `run` - Run * `check` - Check' x-spec-enum-id: 726608a431c1f104 default: run inventory: type: - integer - 'null' project: type: - integer - 'null' playbook: type: - string - 'null' default: '' maxLength: 1024 scm_branch: type: - string - 'null' default: '' description: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. maxLength: 1024 forks: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 limit: type: - string - 'null' default: '' verbosity: enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer description: '* `0` - 0 (Normal) * `1` - 1 (Verbose) * `2` - 2 (More Verbose) * `3` - 3 (Debug) * `4` - 4 (Connection Debug) * `5` - 5 (WinRM Debug)' x-spec-enum-id: 8cfb81af905b865a default: 0 minimum: 0 maximum: 9223372036854775807 extra_vars: type: - string - 'null' default: '' job_tags: type: - string - 'null' default: '' force_handlers: type: - boolean - 'null' default: false skip_tags: type: - string - 'null' default: '' start_at_task: type: - string - 'null' default: '' maxLength: 1024 timeout: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 default: 0 description: The amount of time (in seconds) to run before the task is canceled. use_fact_cache: type: - boolean - 'null' default: false description: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. organization: type: - integer - 'null' readOnly: true description: The organization used to determine access to this template. last_job_run: type: - string - 'null' format: date-time readOnly: true last_job_failed: type: boolean readOnly: true next_job_run: type: - string - 'null' format: date-time readOnly: true status: enum: - new - pending - waiting - running - successful - failed - error - canceled - never updated type: string description: '* `new` - New * `pending` - Pending * `waiting` - Waiting * `running` - Running * `successful` - Successful * `failed` - Failed * `error` - Error * `canceled` - Canceled * `never updated` - Never Updated' x-spec-enum-id: 91b42427ee973322 readOnly: true execution_environment: type: - integer - 'null' description: The container image to be used for execution. host_config_key: type: - string - 'null' default: '' maxLength: 1024 ask_scm_branch_on_launch: type: - boolean - 'null' default: false ask_diff_mode_on_launch: type: - boolean - 'null' default: false ask_variables_on_launch: type: - boolean - 'null' default: false ask_limit_on_launch: type: - boolean - 'null' default: false ask_tags_on_launch: type: - boolean - 'null' default: false ask_skip_tags_on_launch: type: - boolean - 'null' default: false ask_job_type_on_launch: type: - boolean - 'null' default: false ask_verbosity_on_launch: type: - boolean - 'null' default: false ask_inventory_on_launch: type: - boolean - 'null' default: false ask_credential_on_launch: type: - boolean - 'null' default: false ask_execution_environment_on_launch: type: - boolean - 'null' default: false ask_labels_on_launch: type: - boolean - 'null' default: false ask_forks_on_launch: type: - boolean - 'null' default: false ask_job_slice_count_on_launch: type: - boolean - 'null' default: false ask_timeout_on_launch: type: - boolean - 'null' default: false ask_instance_groups_on_launch: type: - boolean - 'null' default: false survey_enabled: type: - boolean - 'null' default: false become_enabled: type: - boolean - 'null' default: false diff_mode: type: - boolean - 'null' default: false description: If enabled, textual changes made to any templated files on the host are shown in the standard output allow_simultaneous: type: - boolean - 'null' default: false custom_virtualenv: type: - string - 'null' readOnly: true description: Local absolute file path containing a custom Python virtualenv to use job_slice_count: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 1 description: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. webhook_service: enum: - github - gitlab - bitbucket_dc - '' - null type: - string - 'null' x-spec-enum-id: eee3a42406ba2781 description: 'Service that webhook requests will be accepted from * `github` - GitHub * `gitlab` - GitLab * `bitbucket_dc` - BitBucket DataCenter' webhook_credential: type: - integer - 'null' description: Personal Access Token for posting back the status to the service API prevent_instance_group_fallback: type: - boolean - 'null' default: false description: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. opa_query_path: type: - string - 'null' description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule. maxLength: 128 required: - name InventorySourceUpdate: type: object properties: can_update: type: boolean readOnly: true AdHocCommandListRequest: type: object properties: execution_environment: type: - integer - 'null' description: The container image to be used for execution. job_type: enum: - run - check - null type: - string - 'null' description: '* `run` - Run * `check` - Check' x-spec-enum-id: 726608a431c1f104 default: run inventory: type: - integer - 'null' limit: type: - string - 'null' default: '' credential: type: - integer - 'null' module_name: enum: - command - shell - yum - apt - apt_key - apt_repository - apt_rpm - service - group - user - mount - ping - selinux - setup - win_ping - win_service - win_updates - win_group - win_user type: string description: '* `command` - command * `shell` - shell * `yum` - yum * `apt` - apt * `apt_key` - apt_key * `apt_repository` - apt_repository * `apt_rpm` - apt_rpm * `service` - service * `group` - group * `user` - user * `mount` - mount * `ping` - ping * `selinux` - selinux * `setup` - setup * `win_ping` - win_ping * `win_service` - win_service * `win_updates` - win_updates * `win_group` - win_group * `win_user` - win_user' x-spec-enum-id: 857230cdbb58eda2 default: command module_args: type: - string - 'null' default: '' forks: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 verbosity: enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer description: '* `0` - 0 (Normal) * `1` - 1 (Verbose) * `2` - 2 (More Verbose) * `3` - 3 (Debug) * `4` - 4 (Connection Debug) * `5` - 5 (WinRM Debug)' x-spec-enum-id: 8cfb81af905b865a default: 0 minimum: 0 maximum: 9223372036854775807 extra_vars: type: - string - 'null' default: '' become_enabled: type: - boolean - 'null' default: false diff_mode: type: - boolean - 'null' default: false PatchedInventoryVariableDataRequest: type: object properties: variables: type: - string - 'null' default: '' description: Inventory variables in JSON or YAML format. HostRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' inventory: type: integer enabled: type: - boolean - 'null' default: true description: Is this host online and available for running jobs? instance_id: type: - string - 'null' default: '' description: The value used by the remote inventory source to uniquely identify the host maxLength: 1024 variables: type: - string - 'null' default: '' description: Host variables in JSON or YAML format. required: - inventory - name ActivityStream: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true timestamp: type: string format: date-time readOnly: true operation: enum: - create - update - delete - associate - disassociate - null type: - string - 'null' x-spec-enum-id: d1cf1307b8aa394e description: 'The action taken with respect to the given object(s). * `create` - Entity Created * `update` - Entity Updated * `delete` - Entity Deleted * `associate` - Entity Associated with another Entity * `disassociate` - Entity was Disassociated with another Entity' changes: type: string readOnly: true description: A summary of the new and changed values when an object is created, updated, or deleted object1: type: - string - 'null' description: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2. object2: type: - string - 'null' description: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with. object_association: type: string readOnly: true description: When present, shows the field name of the role or relationship that changed. action_node: type: string readOnly: true description: The cluster node the activity took place on. object_type: type: string readOnly: true description: When present, shows the model on which the role or relationship was defined. required: - object1 - object2 - operation GroupRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' inventory: type: integer variables: type: - string - 'null' default: '' description: Group variables in JSON or YAML format. required: - inventory - name ResourceAccessListElement: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true created: type: string readOnly: true modified: type: string readOnly: true username: type: - string - 'null' description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 first_name: type: - string - 'null' maxLength: 150 last_name: type: - string - 'null' maxLength: 150 email: type: - string - 'null' title: Email address maxLength: 254 is_superuser: type: - boolean - 'null' default: false title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. is_system_auditor: type: boolean default: false password: type: string default: '' description: Field used to change the password. last_login: type: - string - 'null' format: date-time readOnly: true required: - username PaginatedInventoryList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/Inventory' LabelRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 organization: type: integer description: Organization this label belongs to. required: - name - organization Label: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true created: type: string readOnly: true modified: type: string readOnly: true name: type: - string - 'null' maxLength: 512 organization: type: integer description: Organization this label belongs to. required: - name - organization PaginatedInstanceGroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/InstanceGroup' PatchedInventoryRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' organization: type: - integer - 'null' description: Organization containing this inventory. kind: enum: - '' - smart - constructed - null type: - string - 'null' x-spec-enum-id: 2ff9e8df76c2ad0e default: '' description: 'Kind of inventory being represented. * `` - Hosts have a direct link to this inventory. * `smart` - Hosts for inventory generated using the host_filter property. * `constructed` - Parse list of source inventories with the constructed inventory plugin.' host_filter: type: - string - 'null' description: Filter that will be applied to the hosts of this inventory. variables: type: - string - 'null' default: '' description: Inventory variables in JSON or YAML format. prevent_instance_group_fallback: type: - boolean - 'null' default: false description: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. opa_query_path: type: - string - 'null' description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule. maxLength: 128 GroupTree: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true created: type: string readOnly: true modified: type: string readOnly: true name: type: - string - 'null' maxLength: 512 description: type: - string - 'null' default: '' inventory: type: integer variables: type: - string - 'null' default: '' description: Group variables in JSON or YAML format. children: type: string readOnly: true required: - inventory - name PaginatedHostList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/Host' PaginatedGroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/Group' InventorySource: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true created: type: string readOnly: true modified: type: string readOnly: true name: type: - string - 'null' maxLength: 512 description: type: - string - 'null' default: '' source: enum: - azure_rm - controller - ec2 - gce - insights - openshift_virtualization - openstack - rhv - satellite6 - terraform - vmware - scm - constructed type: string description: '* `azure_rm` - Microsoft Azure Resource Manager * `controller` - Red Hat Ansible Automation Platform * `ec2` - Amazon EC2 * `gce` - Google Compute Engine * `insights` - Red Hat Insights * `openshift_virtualization` - OpenShift Virtualization * `openstack` - OpenStack * `rhv` - Red Hat Virtualization * `satellite6` - Red Hat Satellite 6 * `terraform` - Terraform State * `vmware` - VMware vCenter * `scm` - Sourced from a Project * `constructed` - Template additional groups and hostvars at runtime' x-spec-enum-id: 2e54dfe09d4f7d8d source_path: type: - string - 'null' default: '' maxLength: 1024 source_vars: type: - string - 'null' default: '' description: Inventory source variables in YAML or JSON format. scm_branch: type: - string - 'null' default: '' description: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. maxLength: 1024 credential: type: - integer - 'null' minimum: 1 description: Cloud credential to use for inventory updates. enabled_var: type: - string - 'null' default: '' description: 'Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default)' enabled_value: type: - string - 'null' default: '' description: 'Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled' host_filter: type: - string - 'null' default: '' description: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. overwrite: type: - boolean - 'null' default: false description: Overwrite local groups and hosts from remote inventory source. overwrite_vars: type: - boolean - 'null' default: false description: Overwrite local variables from remote inventory source. custom_virtualenv: type: - string - 'null' readOnly: true description: Local absolute file path containing a custom Python virtualenv to use timeout: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 default: 0 description: The amount of time (in seconds) to run before the task is canceled. verbosity: enum: - 0 - 1 - 2 type: integer description: '* `0` - 0 (WARNING) * `1` - 1 (INFO) * `2` - 2 (DEBUG)' x-spec-enum-id: 48197bd695a06691 default: 1 minimum: 0 maximum: 9223372036854775807 limit: type: - string - 'null' default: '' description: Enter host, group or pattern match last_job_run: type: - string - 'null' format: date-time readOnly: true last_job_failed: type: boolean readOnly: true next_job_run: type: - string - 'null' format: date-time readOnly: true status: enum: - new - pending - waiting - running - successful - failed - error - canceled - never updated - none type: string description: '* `new` - New * `pending` - Pending * `waiting` - Waiting * `running` - Running * `successful` - Successful * `failed` - Failed * `error` - Error * `canceled` - Canceled * `never updated` - Never Updated * `none` - No External Source' x-spec-enum-id: 697673f6ed4abf52 readOnly: true execution_environment: type: - integer - 'null' description: The container image to be used for execution. inventory: type: - integer - 'null' update_on_launch: type: - boolean - 'null' default: false update_cache_timeout: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 source_project: type: - integer - 'null' description: Project containing inventory file used as source. last_update_failed: type: boolean readOnly: true last_updated: type: string format: date-time readOnly: true required: - inventory - name - source Copy: type: object properties: name: type: string required: - name AdHocCommandList: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true created: type: string readOnly: true modified: type: string readOnly: true name: type: - string - 'null' readOnly: true launch_type: enum: - manual - relaunch - callback - scheduled - dependency - workflow - webhook - sync - scm type: string description: '* `manual` - Manual * `relaunch` - Relaunch * `callback` - Callback * `scheduled` - Scheduled * `dependency` - Dependency * `workflow` - Workflow * `webhook` - Webhook * `sync` - Sync * `scm` - SCM Update' x-spec-enum-id: e5bed25c2e652da3 readOnly: true status: enum: - new - pending - waiting - running - successful - failed - error - canceled type: string description: '* `new` - New * `pending` - Pending * `waiting` - Waiting * `running` - Running * `successful` - Successful * `failed` - Failed * `error` - Error * `canceled` - Canceled' x-spec-enum-id: 6021859c28387823 readOnly: true execution_environment: type: - integer - 'null' description: The container image to be used for execution. failed: type: boolean readOnly: true started: type: - string - 'null' format: date-time readOnly: true description: The date and time the job was queued for starting. finished: type: - string - 'null' format: date-time readOnly: true description: The date and time the job finished execution. canceled_on: type: - string - 'null' format: date-time readOnly: true description: The date and time when the cancel request was sent. elapsed: type: string format: decimal pattern: ^-?\d{0,9}(?:\.\d{0,3})?$ readOnly: true description: Elapsed time in seconds that the job ran. job_explanation: type: string readOnly: true description: A status field to indicate the state of the job if it wasn't able to run and capture stdout execution_node: type: string readOnly: true description: The node the job executed on. controller_node: type: string readOnly: true description: The instance that managed the execution environment. launched_by: type: string readOnly: true work_unit_id: type: - string - 'null' readOnly: true description: The Receptor work unit ID associated with this job. job_type: enum: - run - check - null type: - string - 'null' description: '* `run` - Run * `check` - Check' x-spec-enum-id: 726608a431c1f104 default: run inventory: type: - integer - 'null' limit: type: - string - 'null' default: '' credential: type: - integer - 'null' module_name: enum: - command - shell - yum - apt - apt_key - apt_repository - apt_rpm - service - group - user - mount - ping - selinux - setup - win_ping - win_service - win_updates - win_group - win_user type: string description: '* `command` - command * `shell` - shell * `yum` - yum * `apt` - apt * `apt_key` - apt_key * `apt_repository` - apt_repository * `apt_rpm` - apt_rpm * `service` - service * `group` - group * `user` - user * `mount` - mount * `ping` - ping * `selinux` - selinux * `setup` - setup * `win_ping` - win_ping * `win_service` - win_service * `win_updates` - win_updates * `win_group` - win_group * `win_user` - win_user' x-spec-enum-id: 857230cdbb58eda2 default: command module_args: type: - string - 'null' default: '' forks: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 verbosity: enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer description: '* `0` - 0 (Normal) * `1` - 1 (Verbose) * `2` - 2 (More Verbose) * `3` - 3 (Debug) * `4` - 4 (Connection Debug) * `5` - 5 (WinRM Debug)' x-spec-enum-id: 8cfb81af905b865a default: 0 minimum: 0 maximum: 9223372036854775807 extra_vars: type: - string - 'null' default: '' become_enabled: type: - boolean - 'null' default: false diff_mode: type: - boolean - 'null' default: false Role: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true summary_fields: type: string readOnly: true name: type: string readOnly: true description: type: string readOnly: true InstanceGroupRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 250 max_concurrent_jobs: type: integer minimum: 0 default: 0 description: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. max_forks: type: integer minimum: 0 default: 0 description: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. is_container_group: type: boolean description: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. credential: type: - integer - 'null' policy_instance_percentage: type: integer maximum: 100 minimum: 0 default: 0 description: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. policy_instance_minimum: type: integer minimum: 0 default: 0 description: Static minimum number of Instances that will be automatically assign to this group when new instances come online. policy_instance_list: type: array items: type: string minLength: 1 description: List of exact-match Instances that will be assigned to this group pod_spec_override: type: - string - 'null' default: '' required: - name PaginatedLabelList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/Label' PaginatedJobTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/JobTemplate' InventorySourceRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' source: enum: - azure_rm - controller - ec2 - gce - insights - openshift_virtualization - openstack - rhv - satellite6 - terraform - vmware - scm - constructed type: string description: '* `azure_rm` - Microsoft Azure Resource Manager * `controller` - Red Hat Ansible Automation Platform * `ec2` - Amazon EC2 * `gce` - Google Compute Engine * `insights` - Red Hat Insights * `openshift_virtualization` - OpenShift Virtualization * `openstack` - OpenStack * `rhv` - Red Hat Virtualization * `satellite6` - Red Hat Satellite 6 * `terraform` - Terraform State * `vmware` - VMware vCenter * `scm` - Sourced from a Project * `constructed` - Template additional groups and hostvars at runtime' x-spec-enum-id: 2e54dfe09d4f7d8d source_path: type: - string - 'null' default: '' maxLength: 1024 source_vars: type: - string - 'null' default: '' description: Inventory source variables in YAML or JSON format. scm_branch: type: - string - 'null' default: '' description: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true. maxLength: 1024 credential: type: - integer - 'null' minimum: 1 description: Cloud credential to use for inventory updates. enabled_var: type: - string - 'null' default: '' description: 'Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default)' enabled_value: type: - string - 'null' default: '' description: 'Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{ "status": { "power_state": "powered_on", "created": "2020-08-04T18:13:04+00:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled' host_filter: type: - string - 'null' default: '' description: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported. overwrite: type: - boolean - 'null' default: false description: Overwrite local groups and hosts from remote inventory source. overwrite_vars: type: - boolean - 'null' default: false description: Overwrite local variables from remote inventory source. timeout: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 default: 0 description: The amount of time (in seconds) to run before the task is canceled. verbosity: enum: - 0 - 1 - 2 type: integer description: '* `0` - 0 (WARNING) * `1` - 1 (INFO) * `2` - 2 (DEBUG)' x-spec-enum-id: 48197bd695a06691 default: 1 minimum: 0 maximum: 9223372036854775807 limit: type: - string - 'null' default: '' description: Enter host, group or pattern match execution_environment: type: - integer - 'null' description: The container image to be used for execution. inventory: type: - integer - 'null' update_on_launch: type: - boolean - 'null' default: false update_cache_timeout: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 source_project: type: - integer - 'null' description: Project containing inventory file used as source. required: - inventory - name - source PaginatedAdHocCommandListList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/AdHocCommandList' InventoryVariableDataRequest: type: object properties: variables: type: - string - 'null' default: '' description: Inventory variables in JSON or YAML format. InventoryVariableData: type: object properties: variables: type: - string - 'null' default: '' description: Inventory variables in JSON or YAML format. InventoryRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' organization: type: - integer - 'null' description: Organization containing this inventory. kind: enum: - '' - smart - constructed - null type: - string - 'null' x-spec-enum-id: 2ff9e8df76c2ad0e default: '' description: 'Kind of inventory being represented. * `` - Hosts have a direct link to this inventory. * `smart` - Hosts for inventory generated using the host_filter property. * `constructed` - Parse list of source inventories with the constructed inventory plugin.' host_filter: type: - string - 'null' description: Filter that will be applied to the hosts of this inventory. variables: type: - string - 'null' default: '' description: Inventory variables in JSON or YAML format. prevent_instance_group_fallback: type: - boolean - 'null' default: false description: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. opa_query_path: type: - string - 'null' description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule. maxLength: 128 required: - name - organization PaginatedRoleList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/Role' InstanceGroup: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true name: type: - string - 'null' maxLength: 250 created: type: string readOnly: true modified: type: string readOnly: true capacity: type: string readOnly: true consumed_capacity: type: string readOnly: true percent_capacity_remaining: type: string readOnly: true jobs_running: type: string readOnly: true max_concurrent_jobs: type: integer minimum: 0 default: 0 description: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. max_forks: type: integer minimum: 0 default: 0 description: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. jobs_total: type: integer readOnly: true description: Count of all jobs that target this instance group instances: type: string readOnly: true is_container_group: type: boolean description: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. credential: type: - integer - 'null' policy_instance_percentage: type: integer maximum: 100 minimum: 0 default: 0 description: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. policy_instance_minimum: type: integer minimum: 0 default: 0 description: Static minimum number of Instances that will be automatically assign to this group when new instances come online. policy_instance_list: type: array items: type: string description: List of exact-match Instances that will be assigned to this group pod_spec_override: type: - string - 'null' default: '' summary_fields: type: string readOnly: true required: - name PaginatedActivityStreamList: type: object required: - count - results properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/ActivityStream'