openapi: 3.2.0 info: title: AWX Inventory Sources API version: v2 description: AWX API Documentation contact: email: ansible-community@redhat.com license: name: Apache License tags: - name: Inventory Sources paths: /api/v2/inventory_sources/: get: operationId: inventory_sources_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: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventorySourceList' description: '' x-ai-description: List inventory sources summary: Inventory sources list x-summary-source: derived post: operationId: inventory_sources_create tags: - Inventory Sources 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 to sync host data from external systems. summary: Inventory sources create x-summary-source: derived /api/v2/inventory_sources/{id}/: get: operationId: inventory_sources_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventorySource' description: '' x-ai-description: Retrieve an inventory source summary: Inventory sources retrieve x-summary-source: derived put: operationId: inventory_sources_update parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources requestBody: content: application/json: schema: $ref: '#/components/schemas/InventorySourceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventorySource' description: '' x-ai-description: Update an inventory source summary: Inventory sources update x-summary-source: derived patch: operationId: inventory_sources_partial_update parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedInventorySourceRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventorySource' description: '' x-ai-description: Update an inventory source summary: Inventory sources partial update x-summary-source: derived delete: operationId: inventory_sources_destroy parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources responses: '204': description: No response body x-ai-description: Delete an inventory source summary: Inventory sources destroy x-summary-source: derived /api/v2/inventory_sources/{id}/activity_stream/: get: operationId: inventory_sources_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: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedActivityStreamList' description: '' x-ai-description: List activity stream of an inventory source summary: Inventory sources activity stream list x-summary-source: derived /api/v2/inventory_sources/{id}/credentials/: get: operationId: inventory_sources_credentials_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: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCredentialList' description: '' x-ai-description: List credentials of an inventory source summary: Inventory sources credentials list x-summary-source: derived post: operationId: inventory_sources_credentials_create description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources requestBody: content: application/json: schema: $ref: '#/components/schemas/CredentialRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Credential' description: '' x-ai-description: Create a credential of an inventory source summary: Inventory sources credentials create x-summary-source: derived /api/v2/inventory_sources/{id}/groups/: get: operationId: inventory_sources_groups_list description: Concrete view for deleting everything related by `relationship`. 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: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGroupList' description: '' x-ai-description: List groups of an inventory source summary: Inventory sources groups list x-summary-source: derived delete: operationId: inventory_sources_groups_destroy description: Concrete view for deleting everything related by `relationship`. parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources responses: '204': description: No response body x-ai-description: Delete a group of an inventory source summary: Inventory sources groups destroy x-summary-source: derived /api/v2/inventory_sources/{id}/hosts/: get: operationId: inventory_sources_hosts_list description: Concrete view for deleting everything related by `relationship`. 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: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedHostList' description: '' x-ai-description: List hosts of an inventory source summary: Inventory sources hosts list x-summary-source: derived delete: operationId: inventory_sources_hosts_destroy description: Concrete view for deleting everything related by `relationship`. parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources responses: '204': description: No response body x-ai-description: Delete a host of an inventory source summary: Inventory sources hosts destroy x-summary-source: derived /api/v2/inventory_sources/{id}/inventory_updates/: get: operationId: inventory_sources_inventory_updates_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: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryUpdateListList' description: '' x-ai-description: List inventory updates of an inventory source summary: Inventory sources inventory updates list x-summary-source: derived /api/v2/inventory_sources/{id}/notification_templates_error/: get: operationId: inventory_sources_notification_templates_error_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: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List notification templates triggered on inventory source update error summary: Inventory sources notification templates error list x-summary-source: derived post: operationId: inventory_sources_notification_templates_error_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' x-ai-description: Add a notification template to an inventory source summary: Inventory sources notification templates error create x-summary-source: derived /api/v2/inventory_sources/{id}/notification_templates_started/: get: operationId: inventory_sources_notification_templates_started_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: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List notification templates triggered on inventory source update start summary: Inventory sources notification templates started list x-summary-source: derived post: operationId: inventory_sources_notification_templates_started_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' x-ai-description: Add a notification template to an inventory source summary: Inventory sources notification templates started create x-summary-source: derived /api/v2/inventory_sources/{id}/notification_templates_success/: get: operationId: inventory_sources_notification_templates_success_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: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List notification templates triggered on inventory source update success summary: Inventory sources notification templates success list x-summary-source: derived post: operationId: inventory_sources_notification_templates_success_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' x-ai-description: Add a notification template to an inventory source summary: Inventory sources notification templates success create x-summary-source: derived /api/v2/inventory_sources/{id}/schedules/: get: operationId: inventory_sources_schedules_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: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedScheduleList' description: '' x-ai-description: List schedules of an inventory source summary: Inventory sources schedules list x-summary-source: derived post: operationId: inventory_sources_schedules_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Schedule' description: '' x-ai-description: Create a schedule of an inventory source summary: Inventory sources schedules create x-summary-source: derived /api/v2/inventory_sources/{id}/update/: get: operationId: inventory_sources_update_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventorySourceUpdate' description: '' x-ai-description: Retrieve an update for an inventory source summary: Inventory sources update retrieve x-summary-source: derived post: operationId: inventory_sources_update_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Inventory Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/InventorySourceUpdate' description: '' x-ai-description: Trigger a sync of an inventory source by ID. Pulls latest host data from the external source. summary: Inventory sources update create x-summary-source: derived components: schemas: 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' PatchedInventorySourceRequest: 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. NotificationTemplateRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' organization: type: - integer - 'null' notification_type: enum: - awssns - email - grafana - irc - mattermost - pagerduty - rocketchat - slack - twilio - webhook - null type: - string - 'null' description: '* `awssns` - AWS SNS * `email` - Email * `grafana` - Grafana * `irc` - IRC * `mattermost` - Mattermost * `pagerduty` - Pagerduty * `rocketchat` - Rocket.Chat * `slack` - Slack * `twilio` - Twilio * `webhook` - Webhook' x-spec-enum-id: 867d131dea32a033 notification_configuration: default: {} messages: default: started: null success: null error: null workflow_approval: null description: Optional custom messages for notification template. required: - name - notification_type - organization NotificationTemplate: 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' notification_type: enum: - awssns - email - grafana - irc - mattermost - pagerduty - rocketchat - slack - twilio - webhook - null type: - string - 'null' description: '* `awssns` - AWS SNS * `email` - Email * `grafana` - Grafana * `irc` - IRC * `mattermost` - Mattermost * `pagerduty` - Pagerduty * `rocketchat` - Rocket.Chat * `slack` - Slack * `twilio` - Twilio * `webhook` - Webhook' x-spec-enum-id: 867d131dea32a033 notification_configuration: default: {} messages: default: started: null success: null error: null workflow_approval: null description: Optional custom messages for notification template. required: - name - notification_type - organization InventorySourceUpdate: type: object properties: can_update: type: boolean readOnly: true Schedule: type: object properties: rrule: type: - string - 'null' description: A value representing the schedules iCal recurrence rule. 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: '' extra_data: default: {} inventory: type: - integer - 'null' description: Inventory applied as a prompt, assuming job template prompts for inventory scm_branch: type: - string - 'null' job_type: enum: - run - check - '' - null type: - string - 'null' description: '* `run` - Run * `check` - Check' x-spec-enum-id: 726608a431c1f104 job_tags: type: - string - 'null' skip_tags: type: - string - 'null' limit: type: - string - 'null' diff_mode: type: - boolean - 'null' verbosity: enum: - 0 - 1 - 2 - 3 - 4 - 5 - null type: - integer - 'null' 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 execution_environment: type: - integer - 'null' description: The container image to be used for execution. forks: type: - integer - 'null' minimum: 0 job_slice_count: type: - integer - 'null' minimum: 0 timeout: type: - integer - 'null' unified_job_template: type: integer enabled: type: - boolean - 'null' default: true description: Enables processing of this schedule. dtstart: type: - string - 'null' format: date-time readOnly: true description: The first occurrence of the schedule occurs on or after this time. dtend: type: - string - 'null' format: date-time readOnly: true description: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. next_run: type: - string - 'null' format: date-time readOnly: true description: The next time that the scheduled action will run. timezone: type: string readOnly: true description: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. until: type: string readOnly: true description: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned required: - name - rrule - unified_job_template ScheduleRequest: type: object properties: rrule: type: - string - 'null' minLength: 1 description: A value representing the schedules iCal recurrence rule. name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' extra_data: default: {} inventory: type: - integer - 'null' description: Inventory applied as a prompt, assuming job template prompts for inventory scm_branch: type: - string - 'null' job_type: enum: - run - check - '' - null type: - string - 'null' description: '* `run` - Run * `check` - Check' x-spec-enum-id: 726608a431c1f104 job_tags: type: - string - 'null' skip_tags: type: - string - 'null' limit: type: - string - 'null' diff_mode: type: - boolean - 'null' verbosity: enum: - 0 - 1 - 2 - 3 - 4 - 5 - null type: - integer - 'null' 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 execution_environment: type: - integer - 'null' description: The container image to be used for execution. forks: type: - integer - 'null' minimum: 0 job_slice_count: type: - integer - 'null' minimum: 0 timeout: type: - integer - 'null' unified_job_template: type: integer enabled: type: - boolean - 'null' default: true description: Enables processing of this schedule. required: - name - rrule - unified_job_template 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 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' PaginatedInventoryUpdateListList: 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/InventoryUpdateList' 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' CredentialRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' organization: type: - integer - 'null' credential_type: type: integer description: Specify the type of credential you want to create. Refer to the documentation for details on each type. inputs: default: {} description: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. required: - credential_type - 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 InventoryUpdateList: 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: '' unified_job_template: type: - integer - '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. 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' description: Local absolute file path containing a custom Python virtualenv to use readOnly: true 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 inventory: type: - integer - 'null' inventory_source: type: integer readOnly: true license_error: type: boolean readOnly: true org_host_limit_error: type: boolean readOnly: true source_project_update: type: - integer - 'null' description: Inventory files from this Project Update were used for the inventory update. instance_group: type: - integer - 'null' description: The Instance group the job was run under scm_revision: type: string readOnly: true description: The SCM Revision from the Project used for this inventory update. Only applicable to inventories source from scm required: - name - source 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 PaginatedScheduleList: 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/Schedule' PaginatedNotificationTemplateList: 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/NotificationTemplate' 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 PaginatedCredentialList: 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/Credential' 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 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' Credential: 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' credential_type: type: integer description: Specify the type of credential you want to create. Refer to the documentation for details on each type. managed: type: boolean readOnly: true inputs: default: {} description: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. kind: type: string readOnly: true cloud: type: string readOnly: true kubernetes: type: string readOnly: true required: - credential_type - name