openapi: 3.2.0 info: title: AWX System Job Templates API version: v2 description: AWX API Documentation contact: email: ansible-community@redhat.com license: name: Apache License tags: - name: system_job_templates paths: /api/v2/system_job_templates/: get: operationId: system_job_templates_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: - system_job_templates responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSystemJobTemplateList' description: '' x-ai-description: List system job templates summary: System job templates list x-summary-source: derived /api/v2/system_job_templates/{id}/: get: operationId: system_job_templates_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - system_job_templates responses: '200': content: application/json: schema: $ref: '#/components/schemas/SystemJobTemplate' description: '' x-ai-description: Retrieve a system job template summary: System job templates retrieve x-summary-source: derived /api/v2/system_job_templates/{id}/jobs/: get: operationId: system_job_templates_jobs_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: - system_job_templates responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSystemJobListList' description: '' x-ai-description: List system jobs of a system job template summary: System job templates jobs list x-summary-source: derived /api/v2/system_job_templates/{id}/launch/: get: operationId: system_job_templates_launch_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - system_job_templates responses: '200': description: No response body x-ai-description: Get system job template launch information summary: System job templates launch retrieve x-summary-source: derived post: operationId: system_job_templates_launch_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - system_job_templates responses: '200': description: No response body x-ai-description: Launch a system job summary: System job templates launch create x-summary-source: derived /api/v2/system_job_templates/{id}/notification_templates_error/: get: operationId: system_job_templates_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: - system_job_templates responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List notification templates triggered on system job error summary: System job templates notification templates error list x-summary-source: derived post: operationId: system_job_templates_notification_templates_error_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - system_job_templates 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: Create a notification templates triggered on system job error summary: System job templates notification templates error create x-summary-source: derived /api/v2/system_job_templates/{id}/notification_templates_started/: get: operationId: system_job_templates_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: - system_job_templates responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List notification templates triggered on system job start summary: System job templates notification templates started list x-summary-source: derived post: operationId: system_job_templates_notification_templates_started_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - system_job_templates 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: Create a notification templates triggered on system job start summary: System job templates notification templates started create x-summary-source: derived /api/v2/system_job_templates/{id}/notification_templates_success/: get: operationId: system_job_templates_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: - system_job_templates responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List notification templates triggered on system job success summary: System job templates notification templates success list x-summary-source: derived post: operationId: system_job_templates_notification_templates_success_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - system_job_templates 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: Create a notification templates triggered on system job success summary: System job templates notification templates success create x-summary-source: derived /api/v2/system_job_templates/{id}/schedules/: get: operationId: system_job_templates_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: - system_job_templates responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedScheduleList' description: '' x-ai-description: List schedules of a system job template summary: System job templates schedules list x-summary-source: derived post: operationId: system_job_templates_schedules_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - system_job_templates 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 a system job template summary: System job templates schedules create x-summary-source: derived components: schemas: PaginatedSystemJobListList: 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/SystemJobList' PaginatedSystemJobTemplateList: 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/SystemJobTemplate' SystemJobList: 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. launched_by: type: string readOnly: true work_unit_id: type: - string - 'null' readOnly: true description: The Receptor work unit ID associated with this job. system_job_template: type: - integer - 'null' job_type: enum: - cleanup_jobs - cleanup_activitystream - cleanup_sessions - '' - null type: - string - 'null' description: '* `cleanup_jobs` - Remove jobs older than a certain number of days * `cleanup_activitystream` - Remove activity stream entries older than a certain number of days * `cleanup_sessions` - Removes expired browser sessions from the database' x-spec-enum-id: c3fb7965187f07c2 default: '' extra_vars: type: - string - 'null' default: '' result_stdout: type: string readOnly: true required: - name 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 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' 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 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 SystemJobTemplate: 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: '' 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 - ok - missing - none - updating type: string description: '* `new` - New * `pending` - Pending * `waiting` - Waiting * `running` - Running * `successful` - Successful * `failed` - Failed * `error` - Error * `canceled` - Canceled * `never updated` - Never Updated * `ok` - OK * `missing` - Missing * `none` - No External Source * `updating` - Updating' x-spec-enum-id: b387d72f4f16647d readOnly: true execution_environment: type: - integer - 'null' description: The container image to be used for execution. job_type: enum: - cleanup_jobs - cleanup_activitystream - cleanup_sessions - '' - null type: - string - 'null' description: '* `cleanup_jobs` - Remove jobs older than a certain number of days * `cleanup_activitystream` - Remove activity stream entries older than a certain number of days * `cleanup_sessions` - Removes expired browser sessions from the database' x-spec-enum-id: c3fb7965187f07c2 default: '' required: - name 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