{ "openapi": "3.0.3", "info": { "title": "AWX API", "version": "v2", "description": "AWX API Documentation", "contact": { "email": "ansible-community@redhat.com" }, "license": { "name": "Apache License" } }, "paths": { "/api/": { "get": { "operationId": "api_retrieve", "description": "List supported API versions", "tags": [ "api" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "List supported API versions" } }, "/api/v2/": { "get": { "operationId": "root_retrieve", "description": "List top level resources", "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "List top-level API resources" } }, "/api/v2/activity_stream/": { "get": { "operationId": "activity_stream_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": [ "activity_stream" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } }, "x-ai-description": "A list of activity stream entries. An activity stream entry tracks actions or changes that were previously made to the system." } }, "/api/v2/activity_stream/{id}/": { "get": { "operationId": "activity_stream_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "activity_stream" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityStream" } } }, "description": "" } } } }, "/api/v2/ad_hoc_command_events/{id}/": { "get": { "operationId": "ad_hoc_command_events_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "ad_hoc_command_events" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocCommandEvent" } } }, "description": "" } } } }, "/api/v2/ad_hoc_commands/": { "get": { "operationId": "ad_hoc_commands_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": [ "ad_hoc_commands" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAdHocCommandListList" } } }, "description": "" } } }, "post": { "operationId": "ad_hoc_commands_create", "tags": [ "ad_hoc_commands" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocCommandListRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocCommandList" } } }, "description": "" } } } }, "/api/v2/ad_hoc_commands/{id}/": { "get": { "operationId": "ad_hoc_commands_retrieve", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "ad_hoc_commands" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocCommandDetail" } } }, "description": "" } } }, "delete": { "operationId": "ad_hoc_commands_destroy", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "ad_hoc_commands" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/ad_hoc_commands/{id}/activity_stream/": { "get": { "operationId": "ad_hoc_commands_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": [ "ad_hoc_commands" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/ad_hoc_commands/{id}/cancel/": { "get": { "operationId": "ad_hoc_commands_cancel_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "ad_hoc_commands" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocCommandCancel" } } }, "description": "" } }, "x-ai-description": "Cancel an ad hoc command" }, "post": { "operationId": "ad_hoc_commands_cancel_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "ad_hoc_commands" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocCommandCancel" } } }, "description": "" } }, "x-ai-description": "Cancel an ad hoc command" } }, "/api/v2/ad_hoc_commands/{id}/events/": { "get": { "operationId": "ad_hoc_commands_events_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": [ "ad_hoc_commands" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAdHocCommandEventList" } } }, "description": "" } } } }, "/api/v2/ad_hoc_commands/{id}/notifications/": { "get": { "operationId": "ad_hoc_commands_notifications_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": [ "ad_hoc_commands" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationList" } } }, "description": "" } } } }, "/api/v2/ad_hoc_commands/{id}/relaunch/": { "get": { "operationId": "ad_hoc_commands_relaunch_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "ad_hoc_commands" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Return passwords needed to start an ad hoc command" }, "post": { "operationId": "ad_hoc_commands_relaunch_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "ad_hoc_commands" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Relaunch an ad hoc command" } }, "/api/v2/ad_hoc_commands/{id}/stdout/": { "get": { "operationId": "ad_hoc_commands_stdout_retrieve", "parameters": [ { "in": "query", "name": "format", "schema": { "type": "string", "enum": [ "ansi", "ansi_download", "html", "json", "txt", "txt_download" ] } }, { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "ad_hoc_commands" ], "responses": { "200": { "content": { "text/html": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } } }, "description": "" } } } }, "/api/v2/analytics/": { "get": { "operationId": "analytics_retrieve", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "A list of additional API endpoints related to analytics" } }, "/api/v2/analytics/adoption_rate/": { "get": { "operationId": "analytics_adoption_rate_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_adoption_rate_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/adoption_rate_options/": { "get": { "operationId": "analytics_adoption_rate_options_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_adoption_rate_options_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/authorized/": { "get": { "operationId": "analytics_authorized_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get analytics data from Red Hat Insights" }, "post": { "operationId": "analytics_authorized_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/event_explorer/": { "get": { "operationId": "analytics_event_explorer_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_event_explorer_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/event_explorer_options/": { "get": { "operationId": "analytics_event_explorer_options_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_event_explorer_options_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/host_explorer/": { "get": { "operationId": "analytics_host_explorer_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_host_explorer_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/host_explorer_options/": { "get": { "operationId": "analytics_host_explorer_options_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_host_explorer_options_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/job_explorer/": { "get": { "operationId": "analytics_job_explorer_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_job_explorer_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/job_explorer_options/": { "get": { "operationId": "analytics_job_explorer_options_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_job_explorer_options_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/probe_template_for_hosts/": { "get": { "operationId": "analytics_probe_template_for_hosts_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_probe_template_for_hosts_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/probe_template_for_hosts_options/": { "get": { "operationId": "analytics_probe_template_for_hosts_options_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_probe_template_for_hosts_options_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/probe_templates/": { "get": { "operationId": "analytics_probe_templates_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_probe_templates_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/probe_templates_options/": { "get": { "operationId": "analytics_probe_templates_options_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_probe_templates_options_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/report/{slug}/": { "get": { "operationId": "analytics_report_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "parameters": [ { "in": "path", "name": "slug", "schema": { "type": "string", "pattern": "^[\\w-]+$" }, "required": true } ], "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get specific analytics resource from Red Hat Insights" }, "post": { "operationId": "analytics_report_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "parameters": [ { "in": "path", "name": "slug", "schema": { "type": "string", "pattern": "^[\\w-]+$" }, "required": true } ], "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query for specific analytics resource to Red Hat Insights" } }, "/api/v2/analytics/report_options/": { "get": { "operationId": "analytics_report_options_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get analytics data from Red Hat Insights" }, "post": { "operationId": "analytics_report_options_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/reports/": { "get": { "operationId": "analytics_reports_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_reports_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/roi_templates/": { "get": { "operationId": "analytics_roi_templates_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_roi_templates_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/analytics/roi_templates_options/": { "get": { "operationId": "analytics_roi_templates_options_retrieve", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "analytics_roi_templates_options_create", "description": "Example:\n headers = {\n 'Content-Type': 'application/json',\n }\n\n params = {\n 'limit': '20',\n 'offset': '0',\n 'sort_by': 'name:asc',\n }\n\n json_data = {\n 'limit': '20',\n 'offset': '0',\n 'sort_options': 'name',\n 'sort_order': 'asc',\n 'tags': [],\n 'slug': [],\n 'name': [],\n 'description': '',\n }\n\n response = requests.post(f'{AUTOMATION_ANALYTICS_API_URL}/reports/', params=params,\n headers=headers, json=json_data)\n\n return Response(response.json(), status=response.status_code)", "tags": [ "analytics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Post query to Red Hat Insights analytics" } }, "/api/v2/bulk/": { "get": { "operationId": "bulk_retrieve", "description": "List top level resources", "tags": [ "bulk" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Retrieves a list of available bulk actions" } }, "/api/v2/bulk/host_create/": { "get": { "operationId": "bulk_host_create_retrieve", "tags": [ "bulk" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get information about bulk host create endpoint" }, "post": { "operationId": "bulk_host_create_create", "tags": [ "bulk" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkHostCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Bulk create hosts" } }, "/api/v2/bulk/host_delete/": { "get": { "operationId": "bulk_host_delete_retrieve", "tags": [ "bulk" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get information about bulk host delete endpoint" }, "post": { "operationId": "bulk_host_delete_create", "tags": [ "bulk" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkHostDeleteRequest" } } }, "required": true }, "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Bulk delete hosts" } }, "/api/v2/bulk/job_launch/": { "get": { "operationId": "bulk_job_launch_retrieve", "tags": [ "bulk" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get information about bulk job launch endpoint" }, "post": { "operationId": "bulk_job_launch_create", "tags": [ "bulk" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkJobLaunchRequest" } } }, "required": true }, "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Bulk launch job templates" } }, "/api/v2/config/": { "get": { "operationId": "config_retrieve", "description": "Return various sitewide configuration settings", "tags": [ "config" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Return various configuration settings" }, "post": { "operationId": "config_create", "tags": [ "config" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Add or update a subscription manifest license" }, "delete": { "operationId": "config_destroy", "tags": [ "config" ], "responses": { "204": { "description": "No response body" } }, "x-ai-description": "Remove the current subscription" } }, "/api/v2/config/attach/": { "post": { "operationId": "config_attach_create", "tags": [ "config" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Attach a subscription" } }, "/api/v2/config/subscriptions/": { "post": { "operationId": "config_subscriptions_create", "tags": [ "config" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "List valid AAP subscriptions" } }, "/api/v2/constructed_inventories/": { "get": { "operationId": "constructed_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": [ "constructed_inventories" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConstructedInventoryList" } } }, "description": "" } }, "x-ai-description": "A list of inventories." }, "post": { "operationId": "constructed_inventories_create", "tags": [ "constructed_inventories" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConstructedInventoryRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConstructedInventory" } } }, "description": "" } } } }, "/api/v2/constructed_inventories/{id}/": { "get": { "operationId": "constructed_inventories_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "constructed_inventories" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConstructedInventory" } } }, "description": "" } } }, "put": { "operationId": "constructed_inventories_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "constructed_inventories" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConstructedInventoryRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConstructedInventory" } } }, "description": "" } } }, "patch": { "operationId": "constructed_inventories_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "constructed_inventories" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConstructedInventoryRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConstructedInventory" } } }, "description": "" } } }, "delete": { "operationId": "constructed_inventories_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "constructed_inventories" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/credential_input_sources/": { "get": { "operationId": "credential_input_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": [ "credential_input_sources" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialInputSourceList" } } }, "description": "" } } }, "post": { "operationId": "credential_input_sources_create", "tags": [ "credential_input_sources" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialInputSourceRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialInputSource" } } }, "description": "" } } } }, "/api/v2/credential_input_sources/{id}/": { "get": { "operationId": "credential_input_sources_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_input_sources" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialInputSource" } } }, "description": "" } } }, "put": { "operationId": "credential_input_sources_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_input_sources" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialInputSourceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialInputSource" } } }, "description": "" } } }, "patch": { "operationId": "credential_input_sources_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_input_sources" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCredentialInputSourceRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialInputSource" } } }, "description": "" } } }, "delete": { "operationId": "credential_input_sources_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_input_sources" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/credential_types/": { "get": { "operationId": "credential_types_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": [ "credential_types" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialTypeList" } } }, "description": "" } }, "x-ai-description": "A list of credential types" }, "post": { "operationId": "credential_types_create", "tags": [ "credential_types" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialTypeRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialType" } } }, "description": "" } }, "x-ai-description": "Create a new custom credential type" } }, "/api/v2/credential_types/{id}/": { "get": { "operationId": "credential_types_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_types" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialType" } } }, "description": "" } } }, "put": { "operationId": "credential_types_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_types" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialTypeRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialType" } } }, "description": "" } }, "x-ai-description": "Update a custom credential type." }, "patch": { "operationId": "credential_types_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_types" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCredentialTypeRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialType" } } }, "description": "" } }, "x-ai-description": "Update a custom credential type." }, "delete": { "operationId": "credential_types_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_types" ], "responses": { "204": { "description": "No response body" } }, "x-ai-description": "Delete a custom credential type. Cannot delete managed types or types currently in use." } }, "/api/v2/credential_types/{id}/activity_stream/": { "get": { "operationId": "credential_types_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": [ "credential_types" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } }, "x-ai-description": "Get activity stream for credential type" } }, "/api/v2/credential_types/{id}/credentials/": { "get": { "operationId": "credential_types_credentials_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": [ "credential_types" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialList" } } }, "description": "" } } }, "post": { "operationId": "credential_types_credentials_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_types" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credential" } } }, "description": "" } } } }, "/api/v2/credential_types/{id}/test/": { "get": { "operationId": "credential_types_test_retrieve", "description": "Test a complete set of input values for an external credential before\nsaving it.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_types" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "credential_types_test_create", "description": "Test a complete set of input values for an external credential before\nsaving it.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credential_types" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Test a complete set of input values for an external credential" } }, "/api/v2/credentials/": { "get": { "operationId": "credentials_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": [ "credentials" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialSerializerCreateList" } } }, "description": "" } }, "x-ai-description": "A list of credentials" }, "post": { "operationId": "credentials_create", "tags": [ "credentials" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialSerializerCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialSerializerCreate" } } }, "description": "" } }, "x-ai-description": "Create a new credential. The `inputs` field contain type-specific input fields. The required fields depend on related `credential_type`. Use GET /v2/credential_types/{id}/ (tool name: controller.credential_types_retrieve) and inspect `inputs` field for the specific credential type's expected schema. The fields `user` and `team` are deprecated and should not be included in the payload." } }, "/api/v2/credentials/{id}/": { "get": { "operationId": "credentials_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credentials" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credential" } } }, "description": "" } } }, "put": { "operationId": "credentials_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credentials" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credential" } } }, "description": "" } } }, "patch": { "operationId": "credentials_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credentials" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCredentialRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credential" } } }, "description": "" } } }, "delete": { "operationId": "credentials_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credentials" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/credentials/{id}/access_list/": { "get": { "operationId": "credentials_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": [ "credentials" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceAccessListElementList" } } }, "description": "" } }, "x-ai-description": "Get access list for a credential" } }, "/api/v2/credentials/{id}/activity_stream/": { "get": { "operationId": "credentials_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": [ "credentials" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } }, "x-ai-description": "Get activity stream for a credential" } }, "/api/v2/credentials/{id}/copy/": { "get": { "operationId": "credentials_copy_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credentials" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } }, "x-ai-description": "Copy credential" }, "post": { "operationId": "credentials_copy_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credentials" ], "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": "Copy credential" } }, "/api/v2/credentials/{id}/input_sources/": { "get": { "operationId": "credentials_input_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": [ "credentials" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialInputSourceList" } } }, "description": "" } } }, "post": { "operationId": "credentials_input_sources_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credentials" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialInputSourceRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialInputSource" } } }, "description": "" } } } }, "/api/v2/credentials/{id}/object_roles/": { "get": { "operationId": "credentials_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": [ "credentials" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleList" } } }, "description": "" } } } }, "/api/v2/credentials/{id}/owner_teams/": { "get": { "operationId": "credentials_owner_teams_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": [ "credentials" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamList" } } }, "description": "" } } } }, "/api/v2/credentials/{id}/owner_users/": { "get": { "operationId": "credentials_owner_users_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": [ "credentials" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserList" } } }, "description": "" } } } }, "/api/v2/credentials/{id}/test/": { "get": { "operationId": "credentials_test_retrieve", "description": "Test updates to the input values and metadata of an external credential\nbefore saving them.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credentials" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "credentials_test_create", "description": "Test updates to the input values and metadata of an external credential\nbefore saving them.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "credentials" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Test update the input values and metadata of an external credential.\n This endpoint supports testing credentials that connect to external secret management systems\n such as CyberArk AIM, CyberArk Conjur, HashiCorp Vault, AWS Secrets Manager, Azure Key Vault,\n Centrify Vault, Thycotic DevOps Secrets Vault, and GitHub App Installation Access Token Lookup.\n It does not support standard credential types such as Machine, SCM, and Cloud." } }, "/api/v2/dashboard/": { "get": { "operationId": "dashboard_retrieve", "description": "Show Dashboard Details", "tags": [ "dashboard" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get aggregate statistics for Tower" } }, "/api/v2/dashboard/graphs/jobs/": { "get": { "operationId": "dashboard_graphs_jobs_retrieve", "tags": [ "dashboard" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get dasboard data for jobs" } }, "/api/v2/execution_environments/": { "get": { "operationId": "execution_environments_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": [ "execution_environments" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedExecutionEnvironmentList" } } }, "description": "" } }, "x-ai-description": "A list of execution environments." }, "post": { "operationId": "execution_environments_create", "tags": [ "execution_environments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionEnvironmentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionEnvironment" } } }, "description": "" } }, "x-ai-description": "Create a new execution environment. Once associated with JT/org/etc" } }, "/api/v2/execution_environments/{id}/": { "get": { "operationId": "execution_environments_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "execution_environments" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionEnvironment" } } }, "description": "" } } }, "put": { "operationId": "execution_environments_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "execution_environments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionEnvironmentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionEnvironment" } } }, "description": "" } }, "x-ai-description": "Update all fields of an execution environment. All fields must be provided in the request body." }, "patch": { "operationId": "execution_environments_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "execution_environments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedExecutionEnvironmentRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionEnvironment" } } }, "description": "" } }, "x-ai-description": "Update specific fields of an execution environment. Only the fields you provide will be updated." }, "delete": { "operationId": "execution_environments_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "execution_environments" ], "responses": { "204": { "description": "No response body" } }, "x-ai-description": "Delete an execution environment." } }, "/api/v2/execution_environments/{id}/activity_stream/": { "get": { "operationId": "execution_environments_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": [ "execution_environments" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/execution_environments/{id}/copy/": { "get": { "operationId": "execution_environments_copy_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "execution_environments" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } } }, "post": { "operationId": "execution_environments_copy_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "execution_environments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } } } }, "/api/v2/execution_environments/{id}/unified_job_templates/": { "get": { "operationId": "execution_environments_unified_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": [ "execution_environments" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUnifiedJobTemplateList" } } }, "description": "" } } } }, "/api/v2/groups/": { "get": { "operationId": "groups_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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedGroupList" } } }, "description": "" } }, "x-ai-description": "A list of groups." }, "post": { "operationId": "groups_create", "tags": [ "groups" ], "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 new group." } }, "/api/v2/groups/{id}/": { "get": { "operationId": "groups_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "description": "" } } }, "put": { "operationId": "groups_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "description": "" } } }, "patch": { "operationId": "groups_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedGroupRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "description": "" } } }, "delete": { "operationId": "groups_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "groups" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/groups/{id}/activity_stream/": { "get": { "operationId": "groups_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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/groups/{id}/ad_hoc_commands/": { "get": { "operationId": "groups_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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAdHocCommandListList" } } }, "description": "" } } }, "post": { "operationId": "groups_ad_hoc_commands_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocCommandListRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocCommandList" } } }, "description": "" } } } }, "/api/v2/groups/{id}/all_hosts/": { "get": { "operationId": "groups_all_hosts_list", "description": "the list of all hosts below a group, even including subgroups", "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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHostList" } } }, "description": "" } } } }, "/api/v2/groups/{id}/children/": { "get": { "operationId": "groups_children_list", "description": "Useful when you have a self-referring ManyToManyRelationship.\n* Tower uses a shallow (2-deep only) url pattern. For example:\n\nWhen an object hangs off of a parent object you would have the url of the\nform /api/v2/parent_model/34/child_model. If you then wanted a child of the\nchild model you would NOT do /api/v2/parent_model/34/child_model/87/child_child_model\nInstead, you would access the child_child_model via /api/v2/child_child_model/87/\nand you would create child_child_model's off of /api/v2/child_model/87/child_child_model_set\nNow, when creating child_child_model related to child_model you still want to\nlink child_child_model to parent_model. That's what this class is for", "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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedGroupList" } } }, "description": "" } } }, "post": { "operationId": "groups_children_create", "description": "Useful when you have a self-referring ManyToManyRelationship.\n* Tower uses a shallow (2-deep only) url pattern. For example:\n\nWhen an object hangs off of a parent object you would have the url of the\nform /api/v2/parent_model/34/child_model. If you then wanted a child of the\nchild model you would NOT do /api/v2/parent_model/34/child_model/87/child_child_model\nInstead, you would access the child_child_model via /api/v2/child_child_model/87/\nand you would create child_child_model's off of /api/v2/child_model/87/child_child_model_set\nNow, when creating child_child_model related to child_model you still want to\nlink child_child_model to parent_model. That's what this class is for", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "description": "" } } } }, "/api/v2/groups/{id}/hosts/": { "get": { "operationId": "groups_hosts_list", "description": "the list of hosts directly below a group", "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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHostList" } } }, "description": "" } } }, "post": { "operationId": "groups_hosts_create", "description": "the list of hosts directly below a group", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Host" } } }, "description": "" } } } }, "/api/v2/groups/{id}/inventory_sources/": { "get": { "operationId": "groups_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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInventorySourceList" } } }, "description": "" } } } }, "/api/v2/groups/{id}/job_events/": { "get": { "operationId": "groups_job_events_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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobEventList" } } }, "description": "" } } } }, "/api/v2/groups/{id}/job_host_summaries/": { "get": { "operationId": "groups_job_host_summaries_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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobHostSummaryList" } } }, "description": "" } } } }, "/api/v2/groups/{id}/potential_children/": { "get": { "operationId": "groups_potential_children_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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedGroupList" } } }, "description": "" } } } }, "/api/v2/groups/{id}/variable_data/": { "get": { "operationId": "groups_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": [ "groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupVariableData" } }, "application/yaml": { "schema": { "$ref": "#/components/schemas/GroupVariableData" } } }, "description": "" } } }, "put": { "operationId": "groups_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": [ "groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupVariableDataRequest" } }, "application/yaml": { "schema": { "$ref": "#/components/schemas/GroupVariableDataRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupVariableData" } }, "application/yaml": { "schema": { "$ref": "#/components/schemas/GroupVariableData" } } }, "description": "" } } }, "patch": { "operationId": "groups_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": [ "groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedGroupVariableDataRequest" } }, "application/yaml": { "schema": { "$ref": "#/components/schemas/PatchedGroupVariableDataRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupVariableData" } }, "application/yaml": { "schema": { "$ref": "#/components/schemas/GroupVariableData" } } }, "description": "" } } } }, "/api/v2/host_metric_summary_monthly/": { "get": { "operationId": "host_metric_summary_monthly_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": [ "host_metric_summary_monthly" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHostMetricSummaryMonthlyList" } } }, "description": "" } } } }, "/api/v2/host_metrics/": { "get": { "operationId": "host_metrics_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": [ "host_metrics" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHostMetricList" } } }, "description": "" } } } }, "/api/v2/host_metrics/{id}/": { "get": { "operationId": "host_metrics_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "host_metrics" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostMetric" } } }, "description": "" } } }, "delete": { "operationId": "host_metrics_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "host_metrics" ], "responses": { "204": { "description": "No response body" } }, "x-ai-description": "Soft delete a host metric" } }, "/api/v2/hosts/": { "get": { "operationId": "hosts_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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHostList" } } }, "description": "" } }, "x-ai-description": "A list of hosts." }, "post": { "operationId": "hosts_create", "tags": [ "hosts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Host" } } }, "description": "" } } } }, "/api/v2/hosts/{id}/": { "get": { "operationId": "hosts_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Host" } } }, "description": "" } } }, "put": { "operationId": "hosts_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "hosts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Host" } } }, "description": "" } } }, "patch": { "operationId": "hosts_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "hosts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedHostRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Host" } } }, "description": "" } } }, "delete": { "operationId": "hosts_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "hosts" ], "responses": { "204": { "description": "No response body" } }, "x-ai-description": "Delete a host" } }, "/api/v2/hosts/{id}/activity_stream/": { "get": { "operationId": "hosts_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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/hosts/{id}/ad_hoc_command_events/": { "get": { "operationId": "hosts_ad_hoc_command_events_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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAdHocCommandEventList" } } }, "description": "" } } } }, "/api/v2/hosts/{id}/ad_hoc_commands/": { "get": { "operationId": "hosts_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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAdHocCommandListList" } } }, "description": "" } } }, "post": { "operationId": "hosts_ad_hoc_commands_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "hosts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocCommandListRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocCommandList" } } }, "description": "" } } } }, "/api/v2/hosts/{id}/all_groups/": { "get": { "operationId": "hosts_all_groups_list", "description": "the list of all groups of which the host is directly or indirectly a member", "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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedGroupList" } } }, "description": "" } } } }, "/api/v2/hosts/{id}/ansible_facts/": { "get": { "operationId": "hosts_ansible_facts_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnsibleFacts" } } }, "description": "" } }, "x-ai-description": "Get Ansible facts for a host" } }, "/api/v2/hosts/{id}/groups/": { "get": { "operationId": "hosts_groups_list", "description": "the list of groups a host is directly a member of", "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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedGroupList" } } }, "description": "" } } }, "post": { "operationId": "hosts_groups_create", "description": "the list of groups a host is directly a member of", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "hosts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "description": "" } } } }, "/api/v2/hosts/{id}/inventory_sources/": { "get": { "operationId": "hosts_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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInventorySourceList" } } }, "description": "" } } } }, "/api/v2/hosts/{id}/job_events/": { "get": { "operationId": "hosts_job_events_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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobEventList" } } }, "description": "" } } } }, "/api/v2/hosts/{id}/job_host_summaries/": { "get": { "operationId": "hosts_job_host_summaries_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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobHostSummaryList" } } }, "description": "" } } } }, "/api/v2/hosts/{id}/smart_inventories/": { "get": { "operationId": "hosts_smart_inventories_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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInventoryList" } } }, "description": "" } } } }, "/api/v2/hosts/{id}/variable_data/": { "get": { "operationId": "hosts_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": [ "hosts" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostVariableData" } }, "application/yaml": { "schema": { "$ref": "#/components/schemas/HostVariableData" } } }, "description": "" } }, "x-ai-description": "The extra variable configuration for this host." }, "put": { "operationId": "hosts_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": [ "hosts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostVariableDataRequest" } }, "application/yaml": { "schema": { "$ref": "#/components/schemas/HostVariableDataRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostVariableData" } }, "application/yaml": { "schema": { "$ref": "#/components/schemas/HostVariableData" } } }, "description": "" } } }, "patch": { "operationId": "hosts_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": [ "hosts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedHostVariableDataRequest" } }, "application/yaml": { "schema": { "$ref": "#/components/schemas/PatchedHostVariableDataRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostVariableData" } }, "application/yaml": { "schema": { "$ref": "#/components/schemas/HostVariableData" } } }, "description": "" } } } }, "/api/v2/instance_groups/": { "get": { "operationId": "instance_groups_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": [ "instance_groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInstanceGroupList" } } }, "description": "" } }, "x-ai-description": "A list of instance groups." }, "post": { "operationId": "instance_groups_create", "tags": [ "instance_groups" ], "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. Instances in this group determine where a job will be executed" } }, "/api/v2/instance_groups/{id}/": { "get": { "operationId": "instance_groups_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instance_groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroup" } } }, "description": "" } } }, "put": { "operationId": "instance_groups_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instance_groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroupRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroup" } } }, "description": "" } } }, "patch": { "operationId": "instance_groups_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instance_groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedInstanceGroupRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroup" } } }, "description": "" } } }, "delete": { "operationId": "instance_groups_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instance_groups" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/instance_groups/{id}/access_list/": { "get": { "operationId": "instance_groups_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": [ "instance_groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceAccessListElementList" } } }, "description": "" } }, "x-ai-description": "Retrieve access list of an instance group" } }, "/api/v2/instance_groups/{id}/instances/": { "get": { "operationId": "instance_groups_instances_list", "description": "This mixin overloads attach/detach so that it calls InstanceGroup.save(),\ntriggering a background recalculation of policy-based instance group\nmembership.", "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": [ "instance_groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInstanceList" } } }, "description": "" } } }, "post": { "operationId": "instance_groups_instances_create", "description": "This mixin overloads attach/detach so that it calls InstanceGroup.save(),\ntriggering a background recalculation of policy-based instance group\nmembership.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instance_groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } }, "description": "" } } } }, "/api/v2/instance_groups/{id}/jobs/": { "get": { "operationId": "instance_groups_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": [ "instance_groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUnifiedJobListList" } } }, "description": "" } } } }, "/api/v2/instance_groups/{id}/object_roles/": { "get": { "operationId": "instance_groups_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": [ "instance_groups" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleList" } } }, "description": "" } } } }, "/api/v2/instances/": { "get": { "operationId": "instances_list", "description": "Creates an instance if used on a Kubernetes or OpenShift deployment of Ansible Automation Platform.", "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": [ "instances" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInstanceList" } } }, "description": "" } } }, "post": { "operationId": "instances_create", "description": "Creates an instance if used on a Kubernetes or OpenShift deployment of Ansible Automation Platform.", "tags": [ "instances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } }, "description": "" } }, "x-ai-description": "Register an execution or hop node instance. Only available on openshift based AAP deployments. Use the install bundle playbook to further provision the instance" } }, "/api/v2/instances/{id}/": { "get": { "operationId": "instances_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instances" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } }, "description": "" } } }, "put": { "operationId": "instances_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } }, "description": "" } } }, "patch": { "operationId": "instances_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedInstanceRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } }, "description": "" } } } }, "/api/v2/instances/{id}/health_check/": { "get": { "operationId": "instances_health_check_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instances" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceHealthCheck" } } }, "description": "" } }, "x-ai-description": "Get instance health check result" }, "post": { "operationId": "instances_health_check_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instances" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceHealthCheck" } } }, "description": "" } }, "x-ai-description": "Perform instance health check" } }, "/api/v2/instances/{id}/install_bundle/": { "get": { "operationId": "instances_install_bundle_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instances" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } }, "description": "" } }, "x-ai-description": "Generate and download install bundle for an instance" } }, "/api/v2/instances/{id}/instance_groups/": { "get": { "operationId": "instances_instance_groups_list", "description": "This mixin overloads attach/detach so that it calls InstanceGroup.save(),\ntriggering a background recalculation of policy-based instance group\nmembership.", "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": [ "instances" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInstanceGroupList" } } }, "description": "" } } }, "post": { "operationId": "instances_instance_groups_create", "description": "This mixin overloads attach/detach so that it calls InstanceGroup.save(),\ntriggering a background recalculation of policy-based instance group\nmembership.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "instances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroupRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroup" } } }, "description": "" } } } }, "/api/v2/instances/{id}/jobs/": { "get": { "operationId": "instances_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": [ "instances" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUnifiedJobListList" } } }, "description": "" } } } }, "/api/v2/instances/{id}/peers/": { "get": { "operationId": "instances_peers_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": [ "instances" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReceptorAddressList" } } }, "description": "" } } } }, "/api/v2/instances/{id}/receptor_addresses/": { "get": { "operationId": "instances_receptor_addresses_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": [ "instances" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReceptorAddressList" } } }, "description": "" } }, "x-ai-description": "List receptor addresses of instance group" } }, "/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." }, "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": "" } } } }, "/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": "" } } }, "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": "" } } }, "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": "" } } }, "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" } } } }, "/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": "" } } } }, "/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" } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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": "" } } } }, "/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" }, "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" } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } } }, "/api/v2/inventories/{id}/labels/": { "get": { "operationId": "inventories_labels_list", "description": "For related labels lists like /api/v2/inventories/N/labels/\n\nWe want want the last instance to be deleted from the database\nwhen the last disassociate happens.\n\nSubclasses 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": "" } } }, "post": { "operationId": "inventories_labels_create", "description": "For related labels lists like /api/v2/inventories/N/labels/\n\nWe want want the last instance to be deleted from the database\nwhen the last disassociate happens.\n\nSubclasses 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" } }, "/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": "" } } } }, "/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" }, "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" } }, "/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" } }, "/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" } }, "/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": "" } } }, "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" } }, "/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": "" } } }, "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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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": "" } } }, "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": "" } } }, "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" } } } }, "/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": "" } } } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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" } } } }, "/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": "" } } }, "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" } } } }, "/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": "" } } } }, "/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": "" } } }, "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" } }, "/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": "" } } }, "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" } }, "/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": "" } } }, "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" } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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": "Sync the inventory source" } }, "/api/v2/inventory_updates/": { "get": { "operationId": "inventory_updates_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_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInventoryUpdateListList" } } }, "description": "" } } } }, "/api/v2/inventory_updates/{id}/": { "get": { "operationId": "inventory_updates_retrieve", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "inventory_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDetail" } } }, "description": "" } } }, "delete": { "operationId": "inventory_updates_destroy", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "inventory_updates" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/inventory_updates/{id}/cancel/": { "get": { "operationId": "inventory_updates_cancel_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "inventory_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryUpdateCancel" } } }, "description": "" } } }, "post": { "operationId": "inventory_updates_cancel_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "inventory_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryUpdateCancel" } } }, "description": "" } } } }, "/api/v2/inventory_updates/{id}/credentials/": { "get": { "operationId": "inventory_updates_credentials_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_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialList" } } }, "description": "" } } } }, "/api/v2/inventory_updates/{id}/events/": { "get": { "operationId": "inventory_updates_events_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_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInventoryUpdateEventList" } } }, "description": "" } } } }, "/api/v2/inventory_updates/{id}/notifications/": { "get": { "operationId": "inventory_updates_notifications_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_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationList" } } }, "description": "" } } } }, "/api/v2/inventory_updates/{id}/stdout/": { "get": { "operationId": "inventory_updates_stdout_retrieve", "parameters": [ { "in": "query", "name": "format", "schema": { "type": "string", "enum": [ "ansi", "ansi_download", "html", "json", "txt", "txt_download" ] } }, { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "inventory_updates" ], "responses": { "200": { "content": { "text/html": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } } }, "description": "" } } } }, "/api/v2/job_events/{id}/": { "get": { "operationId": "job_events_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_events" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobEvent" } } }, "description": "" } } } }, "/api/v2/job_events/{id}/children/": { "get": { "operationId": "job_events_children_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": [ "job_events" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobEventList" } } }, "description": "" } } } }, "/api/v2/job_host_summaries/{id}/": { "get": { "operationId": "job_host_summaries_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_host_summaries" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobHostSummary" } } }, "description": "" } } } }, "/api/v2/job_templates/": { "get": { "operationId": "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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobTemplateList" } } }, "description": "" } }, "x-ai-description": "A list of job templates." }, "post": { "operationId": "job_templates_create", "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTemplate" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/": { "get": { "operationId": "job_templates_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTemplate" } } }, "description": "" } } }, "put": { "operationId": "job_templates_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTemplateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTemplate" } } }, "description": "" } } }, "patch": { "operationId": "job_templates_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedJobTemplateRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTemplate" } } }, "description": "" } } }, "delete": { "operationId": "job_templates_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/job_templates/{id}/access_list/": { "get": { "operationId": "job_templates_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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceAccessListElementList" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/activity_stream/": { "get": { "operationId": "job_templates_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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/bitbucket_dc/": { "post": { "operationId": "job_templates_bitbucket_dc_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Receive a webhook event and trigger a job" } }, "/api/v2/job_templates/{id}/callback/": { "get": { "operationId": "job_templates_callback_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get job template callback configuration" }, "post": { "operationId": "job_templates_callback_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Trigger job template via provisioning callback" } }, "/api/v2/job_templates/{id}/copy/": { "get": { "operationId": "job_templates_copy_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } } }, "post": { "operationId": "job_templates_copy_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/credentials/": { "get": { "operationId": "job_templates_credentials_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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialList" } } }, "description": "" } } }, "post": { "operationId": "job_templates_credentials_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credential" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/github/": { "post": { "operationId": "job_templates_github_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Receive a webhook event and trigger a job" } }, "/api/v2/job_templates/{id}/gitlab/": { "post": { "operationId": "job_templates_gitlab_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Receive a webhook event and trigger a job" } }, "/api/v2/job_templates/{id}/instance_groups/": { "get": { "operationId": "job_templates_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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInstanceGroupList" } } }, "description": "" } } }, "post": { "operationId": "job_templates_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": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroupRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroup" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/jobs/": { "get": { "operationId": "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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobListList" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/labels/": { "get": { "operationId": "job_templates_labels_list", "description": "For related labels lists like /api/v2/inventories/N/labels/\n\nWe want want the last instance to be deleted from the database\nwhen the last disassociate happens.\n\nSubclasses 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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLabelList" } } }, "description": "" } } }, "post": { "operationId": "job_templates_labels_create", "description": "For related labels lists like /api/v2/inventories/N/labels/\n\nWe want want the last instance to be deleted from the database\nwhen the last disassociate happens.\n\nSubclasses need to define parent_model", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "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" } }, "/api/v2/job_templates/{id}/launch/": { "get": { "operationId": "job_templates_launch_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobLaunch" } } }, "description": "" } } }, "post": { "operationId": "job_templates_launch_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobLaunchRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobLaunch" } } }, "description": "" } }, "x-ai-description": "Launch the job template" } }, "/api/v2/job_templates/{id}/notification_templates_error/": { "get": { "operationId": "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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "job_templates_notification_templates_error_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/notification_templates_started/": { "get": { "operationId": "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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "job_templates_notification_templates_started_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/notification_templates_success/": { "get": { "operationId": "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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "job_templates_notification_templates_success_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/object_roles/": { "get": { "operationId": "job_templates_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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleList" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/schedules/": { "get": { "operationId": "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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedScheduleList" } } }, "description": "" } } }, "post": { "operationId": "job_templates_schedules_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schedule" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/slice_workflow_jobs/": { "get": { "operationId": "job_templates_slice_workflow_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": [ "job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobListList" } } }, "description": "" } } }, "post": { "operationId": "job_templates_slice_workflow_jobs_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobListRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobList" } } }, "description": "" } } } }, "/api/v2/job_templates/{id}/survey_spec/": { "get": { "operationId": "job_templates_survey_spec_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get job template survey specification" }, "post": { "operationId": "job_templates_survey_spec_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Update job template survey specification" }, "delete": { "operationId": "job_templates_survey_spec_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "204": { "description": "No response body" } }, "x-ai-description": "Delete job template survey specification" } }, "/api/v2/job_templates/{id}/webhook_key/": { "get": { "operationId": "job_templates_webhook_key_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get the webhook key for a template" }, "post": { "operationId": "job_templates_webhook_key_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "job_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Rotate the webhook key for a template" } }, "/api/v2/jobs/": { "get": { "operationId": "jobs_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": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobListList" } } }, "description": "" } }, "x-ai-description": "A list of jobs." } }, "/api/v2/jobs/{id}/": { "get": { "operationId": "jobs_retrieve", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDetail" } } }, "description": "" } } }, "delete": { "operationId": "jobs_destroy", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "jobs" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/jobs/{id}/activity_stream/": { "get": { "operationId": "jobs_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": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/jobs/{id}/cancel/": { "get": { "operationId": "jobs_cancel_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCancel" } } }, "description": "" } } }, "post": { "operationId": "jobs_cancel_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCancel" } } }, "description": "" } }, "x-ai-description": "Cancel a running or pending job" } }, "/api/v2/jobs/{id}/create_schedule/": { "get": { "operationId": "jobs_create_schedule_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCreateSchedule" } } }, "description": "" } } }, "post": { "operationId": "jobs_create_schedule_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCreateSchedule" } } }, "description": "" } }, "x-ai-description": "Create a schedule from a job" } }, "/api/v2/jobs/{id}/credentials/": { "get": { "operationId": "jobs_credentials_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": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialList" } } }, "description": "" } } } }, "/api/v2/jobs/{id}/job_events/": { "get": { "operationId": "jobs_job_events_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": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobEventList" } } }, "description": "" } } } }, "/api/v2/jobs/{id}/job_events/children_summary/": { "get": { "operationId": "jobs_job_events_children_summary_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "jobs" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get children summary for job events" } }, "/api/v2/jobs/{id}/job_host_summaries/": { "get": { "operationId": "jobs_job_host_summaries_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": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobHostSummaryList" } } }, "description": "" } } } }, "/api/v2/jobs/{id}/labels/": { "get": { "operationId": "jobs_labels_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": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLabelList" } } }, "description": "" } } } }, "/api/v2/jobs/{id}/notifications/": { "get": { "operationId": "jobs_notifications_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": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationList" } } }, "description": "" } } } }, "/api/v2/jobs/{id}/relaunch/": { "get": { "operationId": "jobs_relaunch_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobRelaunch" } } }, "description": "" } } }, "post": { "operationId": "jobs_relaunch_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "jobs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobRelaunchRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobRelaunch" } } }, "description": "" } }, "x-ai-description": "Relaunch a job" } }, "/api/v2/jobs/{id}/stdout/": { "get": { "operationId": "jobs_stdout_retrieve", "parameters": [ { "in": "query", "name": "format", "schema": { "type": "string", "enum": [ "ansi", "ansi_download", "html", "json", "txt", "txt_download" ] } }, { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "jobs" ], "responses": { "200": { "content": { "text/html": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } } }, "description": "" } }, "x-ai-description": "Get the standard output for the selected job." } }, "/api/v2/labels/": { "get": { "operationId": "labels_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": [ "labels" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLabelList" } } }, "description": "" } } }, "post": { "operationId": "labels_create", "tags": [ "labels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabelRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Label" } } }, "description": "" } } } }, "/api/v2/labels/{id}/": { "get": { "operationId": "labels_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "labels" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Label" } } }, "description": "" } } }, "put": { "operationId": "labels_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "labels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabelRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Label" } } }, "description": "" } } }, "patch": { "operationId": "labels_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "labels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedLabelRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Label" } } }, "description": "" } } } }, "/api/v2/me/": { "get": { "operationId": "me_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": [ "me" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserList" } } }, "description": "" } } } }, "/api/v2/mesh_visualizer/": { "get": { "operationId": "mesh_visualizer_retrieve", "tags": [ "mesh_visualizer" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get mesh network topology visualization data" } }, "/api/v2/metrics/": { "get": { "operationId": "metrics_retrieve", "description": "Show Metrics Details", "parameters": [ { "in": "query", "name": "format", "schema": { "type": "string", "enum": [ "json", "txt" ] } } ], "tags": [ "metrics" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get Prometheus metrics data" } }, "/api/v2/notification_templates/": { "get": { "operationId": "notification_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": [ "notification_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } }, "x-ai-description": "A list of notification templates." }, "post": { "operationId": "notification_templates_create", "tags": [ "notification_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 new notification template." } }, "/api/v2/notification_templates/{id}/": { "get": { "operationId": "notification_templates_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "notification_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } }, "put": { "operationId": "notification_templates_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "notification_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } }, "x-ai-description": "Update a notification template." }, "patch": { "operationId": "notification_templates_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "notification_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedNotificationTemplateRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } }, "x-ai-description": "Update a notification template." }, "delete": { "operationId": "notification_templates_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "notification_templates" ], "responses": { "204": { "description": "No response body" } }, "x-ai-description": "Delete a notification template" } }, "/api/v2/notification_templates/{id}/copy/": { "get": { "operationId": "notification_templates_copy_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "notification_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } } }, "post": { "operationId": "notification_templates_copy_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "notification_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } } } }, "/api/v2/notification_templates/{id}/notifications/": { "get": { "operationId": "notification_templates_notifications_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": [ "notification_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationList" } } }, "description": "" } } } }, "/api/v2/notification_templates/{id}/test/": { "post": { "operationId": "notification_templates_test_create", "description": "Test a Notification Template", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "notification_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Send a test notification from a notification template" } }, "/api/v2/notifications/": { "get": { "operationId": "notifications_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": [ "notifications" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationList" } } }, "description": "" } } } }, "/api/v2/notifications/{id}/": { "get": { "operationId": "notifications_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "notifications" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } }, "description": "" } } } }, "/api/v2/organizations/": { "get": { "operationId": "organizations_retrieve", "tags": [ "organizations" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "organizations_create", "tags": [ "organizations" ], "responses": { "201": { "description": "No response body" } } } }, "/api/v2/organizations/{id}/": { "get": { "operationId": "organizations_retrieve_2", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "description": "" } } }, "put": { "operationId": "organizations_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "description": "" } } }, "patch": { "operationId": "organizations_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedOrganizationRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organization" } } }, "description": "" } } }, "delete": { "operationId": "organizations_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/organizations/{id}/access_list/": { "get": { "operationId": "organizations_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceAccessListElementList" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/activity_stream/": { "get": { "operationId": "organizations_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/admins/": { "get": { "operationId": "organizations_admins_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserList" } } }, "description": "" } } }, "post": { "operationId": "organizations_admins_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/credentials/": { "get": { "operationId": "organizations_credentials_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedOrganizationCredentialSerializerCreateList" } } }, "description": "" } } }, "post": { "operationId": "organizations_credentials_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCredentialSerializerCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCredentialSerializerCreate" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/execution_environments/": { "get": { "operationId": "organizations_execution_environments_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedExecutionEnvironmentList" } } }, "description": "" } } }, "post": { "operationId": "organizations_execution_environments_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionEnvironmentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionEnvironment" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/galaxy_credentials/": { "get": { "operationId": "organizations_galaxy_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialList" } } }, "description": "" } } }, "post": { "operationId": "organizations_galaxy_credentials_create", "description": "Derived version of SubListCreateAttachDetachAPIView that prohibits creation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credential" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/instance_groups/": { "get": { "operationId": "organizations_instance_groups_list", "description": "This mixin overloads attach/detach so that it calls Organization.save(),\nto ensure instance group updates are persisted", "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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInstanceGroupList" } } }, "description": "" } } }, "post": { "operationId": "organizations_instance_groups_create", "description": "This mixin overloads attach/detach so that it calls Organization.save(),\nto ensure instance group updates are persisted", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroupRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroup" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/inventories/": { "get": { "operationId": "organizations_inventories_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInventoryList" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/job_templates/": { "get": { "operationId": "organizations_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJobTemplateList" } } }, "description": "" } } }, "post": { "operationId": "organizations_job_templates_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTemplate" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/notification_templates/": { "get": { "operationId": "organizations_notification_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "organizations_notification_templates_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/notification_templates_approvals/": { "get": { "operationId": "organizations_notification_templates_approvals_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "organizations_notification_templates_approvals_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/notification_templates_error/": { "get": { "operationId": "organizations_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "organizations_notification_templates_error_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/notification_templates_started/": { "get": { "operationId": "organizations_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "organizations_notification_templates_started_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/notification_templates_success/": { "get": { "operationId": "organizations_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "organizations_notification_templates_success_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/object_roles/": { "get": { "operationId": "organizations_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleList" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/projects/": { "get": { "operationId": "organizations_projects_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProjectList" } } }, "description": "" } } }, "post": { "operationId": "organizations_projects_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/teams/": { "get": { "operationId": "organizations_teams_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamList" } } }, "description": "" } } }, "post": { "operationId": "organizations_teams_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/users/": { "get": { "operationId": "organizations_users_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserList" } } }, "description": "" } } }, "post": { "operationId": "organizations_users_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "" } } } }, "/api/v2/organizations/{id}/workflow_job_templates/": { "get": { "operationId": "organizations_workflow_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": [ "organizations" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobTemplateList" } } }, "description": "" } } }, "post": { "operationId": "organizations_workflow_job_templates_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "organizations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplate" } } }, "description": "" } } } }, "/api/v2/ping/": { "get": { "operationId": "ping_retrieve", "description": "Return some basic information about this instance\n\nEverything returned here should be considered public / insecure, as\nthis requires no auth and is intended for use by the installer process.", "tags": [ "ping" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Return basic information about this instance" } }, "/api/v2/project_updates/": { "get": { "operationId": "project_updates_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": [ "project_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProjectUpdateListList" } } }, "description": "" } } } }, "/api/v2/project_updates/{id}/": { "get": { "operationId": "project_updates_retrieve", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "project_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDetail" } } }, "description": "" } } }, "delete": { "operationId": "project_updates_destroy", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "project_updates" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/project_updates/{id}/cancel/": { "get": { "operationId": "project_updates_cancel_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "project_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateCancel" } } }, "description": "" } } }, "post": { "operationId": "project_updates_cancel_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "project_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateCancel" } } }, "description": "" } } } }, "/api/v2/project_updates/{id}/events/": { "get": { "operationId": "project_updates_events_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": [ "project_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProjectUpdateEventList" } } }, "description": "" } } } }, "/api/v2/project_updates/{id}/notifications/": { "get": { "operationId": "project_updates_notifications_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": [ "project_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationList" } } }, "description": "" } } } }, "/api/v2/project_updates/{id}/scm_inventory_updates/": { "get": { "operationId": "project_updates_scm_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": [ "project_updates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInventoryUpdateListList" } } }, "description": "" } } } }, "/api/v2/project_updates/{id}/stdout/": { "get": { "operationId": "project_updates_stdout_retrieve", "parameters": [ { "in": "query", "name": "format", "schema": { "type": "string", "enum": [ "ansi", "ansi_download", "html", "json", "txt", "txt_download" ] } }, { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "project_updates" ], "responses": { "200": { "content": { "text/html": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnifiedJobStdout" } } }, "description": "" } } } }, "/api/v2/projects/": { "get": { "operationId": "projects_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProjectList" } } }, "description": "" } }, "x-ai-description": "A list of projects." }, "post": { "operationId": "projects_create", "tags": [ "projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } } } }, "/api/v2/projects/{id}/": { "get": { "operationId": "projects_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } } }, "put": { "operationId": "projects_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } } }, "patch": { "operationId": "projects_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedProjectRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "" } } }, "delete": { "operationId": "projects_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/projects/{id}/access_list/": { "get": { "operationId": "projects_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceAccessListElementList" } } }, "description": "" } } } }, "/api/v2/projects/{id}/activity_stream/": { "get": { "operationId": "projects_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/projects/{id}/copy/": { "get": { "operationId": "projects_copy_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } } }, "post": { "operationId": "projects_copy_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } } } }, "/api/v2/projects/{id}/inventories/": { "get": { "operationId": "projects_inventories_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectInventories" } } }, "description": "" } } } }, "/api/v2/projects/{id}/notification_templates_error/": { "get": { "operationId": "projects_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "projects_notification_templates_error_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/projects/{id}/notification_templates_started/": { "get": { "operationId": "projects_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "projects_notification_templates_started_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/projects/{id}/notification_templates_success/": { "get": { "operationId": "projects_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "projects_notification_templates_success_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/projects/{id}/object_roles/": { "get": { "operationId": "projects_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleList" } } }, "description": "" } } } }, "/api/v2/projects/{id}/playbooks/": { "get": { "operationId": "projects_playbooks_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectPlaybooks" } } }, "description": "" } } } }, "/api/v2/projects/{id}/project_updates/": { "get": { "operationId": "projects_project_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProjectUpdateListList" } } }, "description": "" } } } }, "/api/v2/projects/{id}/schedules/": { "get": { "operationId": "projects_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedScheduleList" } } }, "description": "" } } }, "post": { "operationId": "projects_schedules_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schedule" } } }, "description": "" } } } }, "/api/v2/projects/{id}/scm_inventory_sources/": { "get": { "operationId": "projects_scm_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInventorySourceList" } } }, "description": "" } } } }, "/api/v2/projects/{id}/teams/": { "get": { "operationId": "projects_teams_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": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamList" } } }, "description": "" } } } }, "/api/v2/projects/{id}/update/": { "get": { "operationId": "projects_update_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateView" } } }, "description": "" } } }, "post": { "operationId": "projects_update_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "projects" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateView" } } }, "description": "" } }, "x-ai-description": "Trigger a project update" } }, "/api/v2/receptor_addresses/": { "get": { "operationId": "receptor_addresses_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": [ "receptor_addresses" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReceptorAddressList" } } }, "description": "" } } } }, "/api/v2/receptor_addresses/{id}/": { "get": { "operationId": "receptor_addresses_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "receptor_addresses" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceptorAddress" } } }, "description": "" } } } }, "/api/v2/roles/": { "get": { "operationId": "roles_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": [ "roles" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleList" } } }, "description": "" } } } }, "/api/v2/roles/{id}/": { "get": { "operationId": "roles_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "roles" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } }, "description": "" } } } }, "/api/v2/roles/{id}/teams/": { "get": { "operationId": "roles_teams_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": [ "roles" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamList" } } }, "description": "" } } }, "post": { "operationId": "roles_teams_create", "description": "Derived version of SubListCreateAttachDetachAPIView that prohibits creation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "roles" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } }, "x-ai-description": "Add a team to a role" } }, "/api/v2/roles/{id}/users/": { "get": { "operationId": "roles_users_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": [ "roles" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserList" } } }, "description": "" } } }, "post": { "operationId": "roles_users_create", "description": "Derived version of SubListCreateAttachDetachAPIView that prohibits creation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "roles" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "" } }, "x-ai-description": "Add a user to a role" } }, "/api/v2/schedules/": { "get": { "operationId": "schedules_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": [ "schedules" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedScheduleList" } } }, "description": "" } } }, "post": { "operationId": "schedules_create", "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schedule" } } }, "description": "" } } } }, "/api/v2/schedules/{id}/": { "get": { "operationId": "schedules_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "schedules" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schedule" } } }, "description": "" } } }, "put": { "operationId": "schedules_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schedule" } } }, "description": "" } } }, "patch": { "operationId": "schedules_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedScheduleRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schedule" } } }, "description": "" } } }, "delete": { "operationId": "schedules_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "schedules" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/schedules/{id}/credentials/": { "get": { "operationId": "schedules_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": [ "schedules" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialList" } } }, "description": "" } } }, "post": { "operationId": "schedules_credentials_create", "description": "Derived version of SubListCreateAttachDetachAPIView that prohibits creation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credential" } } }, "description": "" } } } }, "/api/v2/schedules/{id}/instance_groups/": { "get": { "operationId": "schedules_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": [ "schedules" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInstanceGroupList" } } }, "description": "" } } }, "post": { "operationId": "schedules_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": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroupRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroup" } } }, "description": "" } } } }, "/api/v2/schedules/{id}/jobs/": { "get": { "operationId": "schedules_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": [ "schedules" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUnifiedJobListList" } } }, "description": "" } } } }, "/api/v2/schedules/{id}/labels/": { "get": { "operationId": "schedules_labels_list", "description": "For related labels lists like /api/v2/inventories/N/labels/\n\nWe want want the last instance to be deleted from the database\nwhen the last disassociate happens.\n\nSubclasses 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": [ "schedules" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLabelList" } } }, "description": "" } } }, "post": { "operationId": "schedules_labels_create", "description": "For related labels lists like /api/v2/inventories/N/labels/\n\nWe want want the last instance to be deleted from the database\nwhen the last disassociate happens.\n\nSubclasses need to define parent_model", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "schedules" ], "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" } }, "/api/v2/schedules/preview/": { "post": { "operationId": "schedules_preview_create", "tags": [ "schedules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulePreviewRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulePreview" } } }, "description": "" } }, "x-ai-description": "Preview schedule recurrence rule occurrences" } }, "/api/v2/schedules/zoneinfo/": { "get": { "operationId": "schedules_zoneinfo_retrieve", "tags": [ "schedules" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get timezone information for schedules" } }, "/api/v2/settings/": { "get": { "operationId": "settings_list", "parameters": [ { "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" } } ], "tags": [ "settings" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSettingCategoryList" } } }, "description": "" } }, "x-ai-description": "A list of additional API endpoints related to settings." } }, "/api/v2/settings/{category_slug}/": { "get": { "operationId": "settings_retrieve", "parameters": [ { "in": "path", "name": "category_slug", "schema": { "type": "string", "pattern": "^[a-z0-9-]+$" }, "required": true } ], "tags": [ "settings" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSingleton" } } }, "description": "" } } }, "put": { "operationId": "settings_update", "parameters": [ { "in": "path", "name": "category_slug", "schema": { "type": "string", "pattern": "^[a-z0-9-]+$" }, "required": true } ], "tags": [ "settings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSingletonRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSingleton" } } }, "description": "" } } }, "patch": { "operationId": "settings_partial_update", "parameters": [ { "in": "path", "name": "category_slug", "schema": { "type": "string", "pattern": "^[a-z0-9-]+$" }, "required": true } ], "tags": [ "settings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSettingSingletonRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSingleton" } } }, "description": "" } }, "x-ai-description": "Update system settings." }, "delete": { "operationId": "settings_destroy", "parameters": [ { "in": "path", "name": "category_slug", "schema": { "type": "string", "pattern": "^[a-z0-9-]+$" }, "required": true } ], "tags": [ "settings" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/settings/logging/test/": { "post": { "operationId": "settings_logging_test_create", "tags": [ "settings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSingletonRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingSingleton" } } }, "description": "" } } } }, "/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" } }, "/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": "" } } } }, "/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": "" } } } }, "/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" }, "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" } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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": "" } } } }, "/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": "" } } }, "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": "" } } } }, "/api/v2/system_jobs/": { "get": { "operationId": "system_jobs_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_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSystemJobListList" } } }, "description": "" } }, "x-ai-description": "List system jobs" } }, "/api/v2/system_jobs/{id}/": { "get": { "operationId": "system_jobs_retrieve", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "system_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemJob" } } }, "description": "" } } }, "delete": { "operationId": "system_jobs_destroy", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "system_jobs" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/system_jobs/{id}/cancel/": { "get": { "operationId": "system_jobs_cancel_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "system_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemJobCancel" } } }, "description": "" } } }, "post": { "operationId": "system_jobs_cancel_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "system_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemJobCancel" } } }, "description": "" } } } }, "/api/v2/system_jobs/{id}/events/": { "get": { "operationId": "system_jobs_events_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_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSystemJobEventList" } } }, "description": "" } } } }, "/api/v2/system_jobs/{id}/notifications/": { "get": { "operationId": "system_jobs_notifications_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_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationList" } } }, "description": "" } } } }, "/api/v2/teams/": { "get": { "operationId": "teams_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": [ "teams" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamList" } } }, "description": "" } } }, "post": { "operationId": "teams_create", "tags": [ "teams" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } } } }, "/api/v2/teams/{id}/": { "get": { "operationId": "teams_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "teams" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } } }, "put": { "operationId": "teams_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "teams" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } } }, "patch": { "operationId": "teams_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "teams" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTeamRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } } }, "delete": { "operationId": "teams_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "teams" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/teams/{id}/access_list/": { "get": { "operationId": "teams_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": [ "teams" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceAccessListElementList" } } }, "description": "" } } } }, "/api/v2/teams/{id}/activity_stream/": { "get": { "operationId": "teams_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": [ "teams" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/teams/{id}/credentials/": { "get": { "operationId": "teams_credentials_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": [ "teams" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamCredentialSerializerCreateList" } } }, "description": "" } } }, "post": { "operationId": "teams_credentials_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "teams" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamCredentialSerializerCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamCredentialSerializerCreate" } } }, "description": "" } } } }, "/api/v2/teams/{id}/object_roles/": { "get": { "operationId": "teams_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": [ "teams" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleList" } } }, "description": "" } } } }, "/api/v2/teams/{id}/projects/": { "get": { "operationId": "teams_projects_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": [ "teams" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProjectList" } } }, "description": "" } } } }, "/api/v2/teams/{id}/roles/": { "get": { "operationId": "teams_roles_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": [ "teams" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleSerializerWithParentAccessList" } } }, "description": "" } } }, "post": { "operationId": "teams_roles_create", "description": "Derived version of SubListCreateAttachDetachAPIView that prohibits creation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "teams" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializerWithParentAccess" } } }, "description": "" } }, "x-ai-description": "Add a role to a team" } }, "/api/v2/teams/{id}/users/": { "get": { "operationId": "teams_users_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": [ "teams" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserList" } } }, "description": "" } } }, "post": { "operationId": "teams_users_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "teams" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "" } } } }, "/api/v2/unified_job_templates/": { "get": { "operationId": "unified_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": [ "unified_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUnifiedJobTemplateList" } } }, "description": "" } } } }, "/api/v2/unified_jobs/": { "get": { "operationId": "unified_jobs_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": [ "unified_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUnifiedJobListList" } } }, "description": "" } } } }, "/api/v2/users/": { "get": { "operationId": "users_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": [ "users" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserList" } } }, "description": "" } } }, "post": { "operationId": "users_create", "tags": [ "users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "" } } } }, "/api/v2/users/{id}/": { "get": { "operationId": "users_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "users" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "" } } }, "put": { "operationId": "users_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "" } } }, "patch": { "operationId": "users_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedUserRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "" } } }, "delete": { "operationId": "users_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "users" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/users/{id}/access_list/": { "get": { "operationId": "users_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": [ "users" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceAccessListElementList" } } }, "description": "" } } } }, "/api/v2/users/{id}/activity_stream/": { "get": { "operationId": "users_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": [ "users" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/users/{id}/admin_of_organizations/": { "get": { "operationId": "users_admin_of_organizations_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "users" ], "responses": { "200": { "description": "No response body" } } } }, "/api/v2/users/{id}/credentials/": { "get": { "operationId": "users_credentials_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": [ "users" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserCredentialSerializerCreateList" } } }, "description": "" } } }, "post": { "operationId": "users_credentials_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCredentialSerializerCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCredentialSerializerCreate" } } }, "description": "" } } } }, "/api/v2/users/{id}/organizations/": { "get": { "operationId": "users_organizations_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "users" ], "responses": { "200": { "description": "No response body" } } } }, "/api/v2/users/{id}/projects/": { "get": { "operationId": "users_projects_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": [ "users" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProjectList" } } }, "description": "" } } } }, "/api/v2/users/{id}/roles/": { "get": { "operationId": "users_roles_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": [ "users" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleSerializerWithParentAccessList" } } }, "description": "" } } }, "post": { "operationId": "users_roles_create", "description": "Derived version of SubListCreateAttachDetachAPIView that prohibits creation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "users" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializerWithParentAccess" } } }, "description": "" } }, "x-ai-description": "Add a role to a user" } }, "/api/v2/users/{id}/teams/": { "get": { "operationId": "users_teams_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": [ "users" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamList" } } }, "description": "" } } } }, "/api/v2/workflow_approval_templates/{id}/": { "get": { "operationId": "workflow_approval_templates_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_approval_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowApprovalTemplate" } } }, "description": "" } } }, "put": { "operationId": "workflow_approval_templates_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_approval_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowApprovalTemplateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowApprovalTemplate" } } }, "description": "" } } }, "patch": { "operationId": "workflow_approval_templates_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_approval_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWorkflowApprovalTemplateRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowApprovalTemplate" } } }, "description": "" } } }, "delete": { "operationId": "workflow_approval_templates_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_approval_templates" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/workflow_approval_templates/{id}/approvals/": { "get": { "operationId": "workflow_approval_templates_approvals_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": [ "workflow_approval_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowApprovalListList" } } }, "description": "" } } } }, "/api/v2/workflow_approvals/": { "get": { "operationId": "workflow_approvals_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": [ "workflow_approvals" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowApprovalListList" } } }, "description": "" } }, "x-ai-description": "List workflow approvals" } }, "/api/v2/workflow_approvals/{id}/": { "get": { "operationId": "workflow_approvals_retrieve", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_approvals" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowApproval" } } }, "description": "" } } }, "delete": { "operationId": "workflow_approvals_destroy", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_approvals" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/workflow_approvals/{id}/approve/": { "get": { "operationId": "workflow_approvals_approve_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_approvals" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "workflow_approvals_approve_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_approvals" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Approve a workflow approval" } }, "/api/v2/workflow_approvals/{id}/deny/": { "get": { "operationId": "workflow_approvals_deny_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_approvals" ], "responses": { "200": { "description": "No response body" } } }, "post": { "operationId": "workflow_approvals_deny_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_approvals" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Deny a workflow approval" } }, "/api/v2/workflow_job_nodes/": { "get": { "operationId": "workflow_job_nodes_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": [ "workflow_job_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobNodeListList" } } }, "description": "" } } } }, "/api/v2/workflow_job_nodes/{id}/": { "get": { "operationId": "workflow_job_nodes_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobNodeDetail" } } }, "description": "" } } } }, "/api/v2/workflow_job_nodes/{id}/always_nodes/": { "get": { "operationId": "workflow_job_nodes_always_nodes_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": [ "workflow_job_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobNodeListList" } } }, "description": "" } } } }, "/api/v2/workflow_job_nodes/{id}/credentials/": { "get": { "operationId": "workflow_job_nodes_credentials_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": [ "workflow_job_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialList" } } }, "description": "" } } } }, "/api/v2/workflow_job_nodes/{id}/failure_nodes/": { "get": { "operationId": "workflow_job_nodes_failure_nodes_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": [ "workflow_job_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobNodeListList" } } }, "description": "" } } } }, "/api/v2/workflow_job_nodes/{id}/instance_groups/": { "get": { "operationId": "workflow_job_nodes_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": [ "workflow_job_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInstanceGroupList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_nodes_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": [ "workflow_job_nodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroupRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroup" } } }, "description": "" } } } }, "/api/v2/workflow_job_nodes/{id}/labels/": { "get": { "operationId": "workflow_job_nodes_labels_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": [ "workflow_job_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLabelList" } } }, "description": "" } } } }, "/api/v2/workflow_job_nodes/{id}/success_nodes/": { "get": { "operationId": "workflow_job_nodes_success_nodes_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": [ "workflow_job_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobNodeListList" } } }, "description": "" } } } }, "/api/v2/workflow_job_template_nodes/": { "get": { "operationId": "workflow_job_template_nodes_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": [ "workflow_job_template_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobTemplateNodeList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_template_nodes_create", "tags": [ "workflow_job_template_nodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNode" } } }, "description": "" } } } }, "/api/v2/workflow_job_template_nodes/{id}/": { "get": { "operationId": "workflow_job_template_nodes_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeDetail" } } }, "description": "" } } }, "put": { "operationId": "workflow_job_template_nodes_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeDetailRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeDetail" } } }, "description": "" } } }, "patch": { "operationId": "workflow_job_template_nodes_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWorkflowJobTemplateNodeDetailRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeDetail" } } }, "description": "" } } }, "delete": { "operationId": "workflow_job_template_nodes_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/workflow_job_template_nodes/{id}/always_nodes/": { "get": { "operationId": "workflow_job_template_nodes_always_nodes_list", "description": "Useful when you have a self-referring ManyToManyRelationship.\n* Tower uses a shallow (2-deep only) url pattern. For example:\n\nWhen an object hangs off of a parent object you would have the url of the\nform /api/v2/parent_model/34/child_model. If you then wanted a child of the\nchild model you would NOT do /api/v2/parent_model/34/child_model/87/child_child_model\nInstead, you would access the child_child_model via /api/v2/child_child_model/87/\nand you would create child_child_model's off of /api/v2/child_model/87/child_child_model_set\nNow, when creating child_child_model related to child_model you still want to\nlink child_child_model to parent_model. That's what this class is for", "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": [ "workflow_job_template_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobTemplateNodeList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_template_nodes_always_nodes_create", "description": "Useful when you have a self-referring ManyToManyRelationship.\n* Tower uses a shallow (2-deep only) url pattern. For example:\n\nWhen an object hangs off of a parent object you would have the url of the\nform /api/v2/parent_model/34/child_model. If you then wanted a child of the\nchild model you would NOT do /api/v2/parent_model/34/child_model/87/child_child_model\nInstead, you would access the child_child_model via /api/v2/child_child_model/87/\nand you would create child_child_model's off of /api/v2/child_model/87/child_child_model_set\nNow, when creating child_child_model related to child_model you still want to\nlink child_child_model to parent_model. That's what this class is for", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNode" } } }, "description": "" } } } }, "/api/v2/workflow_job_template_nodes/{id}/create_approval_template/": { "get": { "operationId": "workflow_job_template_nodes_create_approval_template_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeCreateApproval" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_template_nodes_create_approval_template_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeCreateApprovalRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeCreateApproval" } } }, "description": "" } }, "x-ai-description": "Create an approval node for a workflow job template node" } }, "/api/v2/workflow_job_template_nodes/{id}/credentials/": { "get": { "operationId": "workflow_job_template_nodes_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": [ "workflow_job_template_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCredentialList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_template_nodes_credentials_create", "description": "Derived version of SubListCreateAttachDetachAPIView that prohibits creation", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Credential" } } }, "description": "" } } } }, "/api/v2/workflow_job_template_nodes/{id}/failure_nodes/": { "get": { "operationId": "workflow_job_template_nodes_failure_nodes_list", "description": "Useful when you have a self-referring ManyToManyRelationship.\n* Tower uses a shallow (2-deep only) url pattern. For example:\n\nWhen an object hangs off of a parent object you would have the url of the\nform /api/v2/parent_model/34/child_model. If you then wanted a child of the\nchild model you would NOT do /api/v2/parent_model/34/child_model/87/child_child_model\nInstead, you would access the child_child_model via /api/v2/child_child_model/87/\nand you would create child_child_model's off of /api/v2/child_model/87/child_child_model_set\nNow, when creating child_child_model related to child_model you still want to\nlink child_child_model to parent_model. That's what this class is for", "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": [ "workflow_job_template_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobTemplateNodeList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_template_nodes_failure_nodes_create", "description": "Useful when you have a self-referring ManyToManyRelationship.\n* Tower uses a shallow (2-deep only) url pattern. For example:\n\nWhen an object hangs off of a parent object you would have the url of the\nform /api/v2/parent_model/34/child_model. If you then wanted a child of the\nchild model you would NOT do /api/v2/parent_model/34/child_model/87/child_child_model\nInstead, you would access the child_child_model via /api/v2/child_child_model/87/\nand you would create child_child_model's off of /api/v2/child_model/87/child_child_model_set\nNow, when creating child_child_model related to child_model you still want to\nlink child_child_model to parent_model. That's what this class is for", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNode" } } }, "description": "" } } } }, "/api/v2/workflow_job_template_nodes/{id}/instance_groups/": { "get": { "operationId": "workflow_job_template_nodes_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": [ "workflow_job_template_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInstanceGroupList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_template_nodes_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": [ "workflow_job_template_nodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroupRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceGroup" } } }, "description": "" } } } }, "/api/v2/workflow_job_template_nodes/{id}/labels/": { "get": { "operationId": "workflow_job_template_nodes_labels_list", "description": "For related labels lists like /api/v2/inventories/N/labels/\n\nWe want want the last instance to be deleted from the database\nwhen the last disassociate happens.\n\nSubclasses 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": [ "workflow_job_template_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLabelList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_template_nodes_labels_create", "description": "For related labels lists like /api/v2/inventories/N/labels/\n\nWe want want the last instance to be deleted from the database\nwhen the last disassociate happens.\n\nSubclasses need to define parent_model", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "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" } }, "/api/v2/workflow_job_template_nodes/{id}/success_nodes/": { "get": { "operationId": "workflow_job_template_nodes_success_nodes_list", "description": "Useful when you have a self-referring ManyToManyRelationship.\n* Tower uses a shallow (2-deep only) url pattern. For example:\n\nWhen an object hangs off of a parent object you would have the url of the\nform /api/v2/parent_model/34/child_model. If you then wanted a child of the\nchild model you would NOT do /api/v2/parent_model/34/child_model/87/child_child_model\nInstead, you would access the child_child_model via /api/v2/child_child_model/87/\nand you would create child_child_model's off of /api/v2/child_model/87/child_child_model_set\nNow, when creating child_child_model related to child_model you still want to\nlink child_child_model to parent_model. That's what this class is for", "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": [ "workflow_job_template_nodes" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobTemplateNodeList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_template_nodes_success_nodes_create", "description": "Useful when you have a self-referring ManyToManyRelationship.\n* Tower uses a shallow (2-deep only) url pattern. For example:\n\nWhen an object hangs off of a parent object you would have the url of the\nform /api/v2/parent_model/34/child_model. If you then wanted a child of the\nchild model you would NOT do /api/v2/parent_model/34/child_model/87/child_child_model\nInstead, you would access the child_child_model via /api/v2/child_child_model/87/\nand you would create child_child_model's off of /api/v2/child_model/87/child_child_model_set\nNow, when creating child_child_model related to child_model you still want to\nlink child_child_model to parent_model. That's what this class is for", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_template_nodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNode" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/": { "get": { "operationId": "workflow_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobTemplateList" } } }, "description": "" } }, "x-ai-description": "A list of workflow job templates." }, "post": { "operationId": "workflow_job_templates_create", "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplate" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/": { "get": { "operationId": "workflow_job_templates_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplate" } } }, "description": "" } } }, "put": { "operationId": "workflow_job_templates_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplate" } } }, "description": "" } } }, "patch": { "operationId": "workflow_job_templates_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWorkflowJobTemplateRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplate" } } }, "description": "" } } }, "delete": { "operationId": "workflow_job_templates_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/workflow_job_templates/{id}/access_list/": { "get": { "operationId": "workflow_job_templates_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceAccessListElementList" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/activity_stream/": { "get": { "operationId": "workflow_job_templates_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/bitbucket_dc/": { "post": { "operationId": "workflow_job_templates_bitbucket_dc_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Receive a webhook event and trigger a job" } }, "/api/v2/workflow_job_templates/{id}/copy/": { "get": { "operationId": "workflow_job_templates_copy_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } }, "x-ai-description": "Get workflow job template copy status" }, "post": { "operationId": "workflow_job_templates_copy_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Copy" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/github/": { "post": { "operationId": "workflow_job_templates_github_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Receive a webhook event and trigger a job" } }, "/api/v2/workflow_job_templates/{id}/gitlab/": { "post": { "operationId": "workflow_job_templates_gitlab_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Receive a webhook event and trigger a job" } }, "/api/v2/workflow_job_templates/{id}/labels/": { "get": { "operationId": "workflow_job_templates_labels_list", "description": "For related labels lists like /api/v2/inventories/N/labels/\n\nWe want want the last instance to be deleted from the database\nwhen the last disassociate happens.\n\nSubclasses 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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLabelList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_templates_labels_create", "description": "For related labels lists like /api/v2/inventories/N/labels/\n\nWe want want the last instance to be deleted from the database\nwhen the last disassociate happens.\n\nSubclasses need to define parent_model", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "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" } }, "/api/v2/workflow_job_templates/{id}/launch/": { "get": { "operationId": "workflow_job_templates_launch_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobLaunch" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_templates_launch_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobLaunchRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobLaunch" } } }, "description": "" } }, "x-ai-description": "Launch the workflow job template." } }, "/api/v2/workflow_job_templates/{id}/notification_templates_approvals/": { "get": { "operationId": "workflow_job_templates_notification_templates_approvals_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_templates_notification_templates_approvals_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/notification_templates_error/": { "get": { "operationId": "workflow_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_templates_notification_templates_error_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/notification_templates_started/": { "get": { "operationId": "workflow_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_templates_notification_templates_started_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/notification_templates_success/": { "get": { "operationId": "workflow_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTemplateList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_templates_notification_templates_success_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/object_roles/": { "get": { "operationId": "workflow_job_templates_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleList" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/schedules/": { "get": { "operationId": "workflow_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedScheduleList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_templates_schedules_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Schedule" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/survey_spec/": { "get": { "operationId": "workflow_job_templates_survey_spec_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get job template survey specification" }, "post": { "operationId": "workflow_job_templates_survey_spec_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Update job template survey specification" }, "delete": { "operationId": "workflow_job_templates_survey_spec_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "responses": { "204": { "description": "No response body" } }, "x-ai-description": "Delete job template survey specification" } }, "/api/v2/workflow_job_templates/{id}/webhook_key/": { "get": { "operationId": "workflow_job_templates_webhook_key_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get the webhook key for a template" }, "post": { "operationId": "workflow_job_templates_webhook_key_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Rotate the webhook key for a template" } }, "/api/v2/workflow_job_templates/{id}/workflow_jobs/": { "get": { "operationId": "workflow_job_templates_workflow_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobListList" } } }, "description": "" } } } }, "/api/v2/workflow_job_templates/{id}/workflow_nodes/": { "get": { "operationId": "workflow_job_templates_workflow_nodes_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": [ "workflow_job_templates" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobTemplateNodeList" } } }, "description": "" } } }, "post": { "operationId": "workflow_job_templates_workflow_nodes_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_job_templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNodeRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobTemplateNode" } } }, "description": "" } } } }, "/api/v2/workflow_jobs/": { "get": { "operationId": "workflow_jobs_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": [ "workflow_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobListList" } } }, "description": "" } }, "x-ai-description": "A list of workflow jobs." } }, "/api/v2/workflow_jobs/{id}/": { "get": { "operationId": "workflow_jobs_retrieve", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJob" } } }, "description": "" } } }, "delete": { "operationId": "workflow_jobs_destroy", "description": "Special handling when deleting a running unified job object.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_jobs" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/workflow_jobs/{id}/activity_stream/": { "get": { "operationId": "workflow_jobs_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": [ "workflow_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedActivityStreamList" } } }, "description": "" } } } }, "/api/v2/workflow_jobs/{id}/cancel/": { "get": { "operationId": "workflow_jobs_cancel_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobCancel" } } }, "description": "" } } }, "post": { "operationId": "workflow_jobs_cancel_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowJobCancel" } } }, "description": "" } }, "x-ai-description": "Cancel a running or pending workflow job" } }, "/api/v2/workflow_jobs/{id}/labels/": { "get": { "operationId": "workflow_jobs_labels_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": [ "workflow_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLabelList" } } }, "description": "" } } } }, "/api/v2/workflow_jobs/{id}/notifications/": { "get": { "operationId": "workflow_jobs_notifications_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": [ "workflow_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationList" } } }, "description": "" } } } }, "/api/v2/workflow_jobs/{id}/relaunch/": { "get": { "operationId": "workflow_jobs_relaunch_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_jobs" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Get workflow job relaunch information" }, "post": { "operationId": "workflow_jobs_relaunch_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^[0-9]+$" }, "required": true } ], "tags": [ "workflow_jobs" ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Relaunch a workflow job" } }, "/api/v2/workflow_jobs/{id}/workflow_nodes/": { "get": { "operationId": "workflow_jobs_workflow_nodes_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": [ "workflow_jobs" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWorkflowJobNodeListList" } } }, "description": "" } } } }, "/api/debug/": { "get": { "operationId": "api_debug_retrieve", "description": "List of available debug urls", "tags": [ "api" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "List available debug endpoints" } }, "/api/debug/dependency_manager/": { "get": { "operationId": "api_debug_dependency_manager_retrieve", "tags": [ "api" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Trigger dependency manager scheduling" } }, "/api/debug/task_manager/": { "get": { "operationId": "api_debug_task_manager_retrieve", "tags": [ "api" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Trigger task manager scheduling" } }, "/api/debug/workflow_manager/": { "get": { "operationId": "api_debug_workflow_manager_retrieve", "tags": [ "api" ], "security": [ {} ], "responses": { "200": { "description": "No response body" } }, "x-ai-description": "Trigger workflow manager scheduling" } }, "/api/v2/feature_flags/states/": { "get": { "operationId": "feature_flags_states_list", "description": "A view class for displaying feature flags states.\nTo add/update/remove a feature flag, see the instructions in\n`docs/apps/feature_flags.md`", "parameters": [ { "in": "query", "name": "condition", "schema": { "type": "string" }, "description": "Filter by condition (exact match)" }, { "in": "query", "name": "condition__icontains", "schema": { "type": "string" }, "description": "Filter by condition (case-insensitive partial match)" }, { "in": "query", "name": "created", "schema": { "type": "string" }, "description": "Filter by created (exact match)" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Filter by created (gt)" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Filter by created (gte)" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Filter by created (lt)" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Filter by created (lte)" }, { "in": "query", "name": "created_by", "schema": { "type": "string" }, "description": "Filter by created_by (exact match)" }, { "in": "query", "name": "description", "schema": { "type": "string" }, "description": "Filter by description (exact match)" }, { "in": "query", "name": "description__icontains", "schema": { "type": "string" }, "description": "Filter by description (case-insensitive partial match)" }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "Filter by id (exact match)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Filter by id (gt)" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Filter by id (gte)" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Filter by id (lt)" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Filter by id (lte)" }, { "in": "query", "name": "labels", "schema": { "type": "string" }, "description": "Filter by labels (exact match)" }, { "in": "query", "name": "modified", "schema": { "type": "string" }, "description": "Filter by modified (exact match)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Filter by modified (gt)" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Filter by modified (gte)" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Filter by modified (lt)" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Filter by modified (lte)" }, { "in": "query", "name": "modified_by", "schema": { "type": "string" }, "description": "Filter by modified_by (exact match)" }, { "in": "query", "name": "name", "schema": { "type": "string" }, "description": "Filter by name (exact match)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Filter by name (case-insensitive partial match)" }, { "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": "required", "schema": { "type": "string" }, "description": "Filter by required (exact match)" }, { "in": "query", "name": "resource", "schema": { "type": "string" }, "description": "Filter by resource (exact match)" }, { "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": "support_level", "schema": { "type": "string" }, "description": "Filter by support_level (exact match)" }, { "in": "query", "name": "support_level__icontains", "schema": { "type": "string" }, "description": "Filter by support_level (case-insensitive partial match)" }, { "in": "query", "name": "support_url", "schema": { "type": "string" }, "description": "Filter by support_url (exact match)" }, { "in": "query", "name": "support_url__icontains", "schema": { "type": "string" }, "description": "Filter by support_url (case-insensitive partial match)" }, { "in": "query", "name": "toggle_type", "schema": { "type": "string" }, "description": "Filter by toggle_type (exact match)" }, { "in": "query", "name": "toggle_type__icontains", "schema": { "type": "string" }, "description": "Filter by toggle_type (case-insensitive partial match)" }, { "in": "query", "name": "type", "schema": { "type": "string" }, "description": "Filter by object type. Supports comma-separated values for multiple types." }, { "in": "query", "name": "ui_name", "schema": { "type": "string" }, "description": "Filter by ui_name (exact match)" }, { "in": "query", "name": "ui_name__icontains", "schema": { "type": "string" }, "description": "Filter by ui_name (case-insensitive partial match)" }, { "in": "query", "name": "value", "schema": { "type": "string" }, "description": "Filter by value (exact match)" }, { "in": "query", "name": "value__icontains", "schema": { "type": "string" }, "description": "Filter by value (case-insensitive partial match)" }, { "in": "query", "name": "visibility", "schema": { "type": "string" }, "description": "Filter by visibility (exact match)" } ], "tags": [ "feature_flags" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedFeatureFlagStatesList" } } }, "description": "" } } } }, "/api/v2/feature_flags/states/{id}/": { "get": { "operationId": "feature_flags_states_retrieve", "description": "A view class for displaying feature flags states.\nTo add/update/remove a feature flag, see the instructions in\n`docs/apps/feature_flags.md`", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this aap flag.", "required": true } ], "tags": [ "feature_flags" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureFlagStates" } } }, "description": "" } } } }, "/api/v2/feature_flags_state/": { "get": { "operationId": "feature_flags_state_retrieve", "description": "A view class for displaying feature flags", "tags": [ "feature_flags_state" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} }, "examples": { "Featureflags": { "value": { "FLAG1": true, "FLAG2": false }, "summary": "featureflags" } } } }, "description": "" } } } }, "/api/v2/role_definitions/": { "get": { "operationId": "role_definitions_list", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [ { "in": "query", "name": "content_type", "schema": { "type": "string" }, "description": "Filter by content_type (exact match)" }, { "in": "query", "name": "created", "schema": { "type": "string" }, "description": "Filter by created (exact match)" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Filter by created (gt)" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Filter by created (gte)" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Filter by created (lt)" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Filter by created (lte)" }, { "in": "query", "name": "created_by", "schema": { "type": "string" }, "description": "Filter by created_by (exact match)" }, { "in": "query", "name": "description", "schema": { "type": "string" }, "description": "Filter by description (exact match)" }, { "in": "query", "name": "description__icontains", "schema": { "type": "string" }, "description": "Filter by description (case-insensitive partial match)" }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "Filter by id (exact match)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Filter by id (gt)" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Filter by id (gte)" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Filter by id (lt)" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Filter by id (lte)" }, { "in": "query", "name": "managed", "schema": { "type": "string" }, "description": "Filter by managed (exact match)" }, { "in": "query", "name": "modified", "schema": { "type": "string" }, "description": "Filter by modified (exact match)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Filter by modified (gt)" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Filter by modified (gte)" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Filter by modified (lt)" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Filter by modified (lte)" }, { "in": "query", "name": "modified_by", "schema": { "type": "string" }, "description": "Filter by modified_by (exact match)" }, { "in": "query", "name": "name", "schema": { "type": "string" }, "description": "Filter by name (exact match)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Filter by name (case-insensitive partial match)" }, { "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": "resource", "schema": { "type": "string" }, "description": "Filter by resource (exact match)" }, { "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": [ "role_definitions" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleDefinitionList" } } }, "description": "" } } }, "post": { "operationId": "role_definitions_create", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "tags": [ "role_definitions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDefinitionRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDefinition" } } }, "description": "" } } } }, "/api/v2/role_definitions/{id}/": { "get": { "operationId": "role_definitions_retrieve", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this role definition.", "required": true } ], "tags": [ "role_definitions" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDefinition" } } }, "description": "" } } }, "put": { "operationId": "role_definitions_update", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this role definition.", "required": true } ], "tags": [ "role_definitions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDefinitionDetailRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDefinitionDetail" } } }, "description": "" } } }, "patch": { "operationId": "role_definitions_partial_update", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this role definition.", "required": true } ], "tags": [ "role_definitions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedRoleDefinitionRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDefinition" } } }, "description": "" } } }, "delete": { "operationId": "role_definitions_destroy", "description": "Role Definitions (roles) contain a list of permissions and can be used to\nassign those permissions to a user or team through the respective\nassignment endpoints.\n\nCustom roles can be created, modified, and deleted through this endpoint.\nSystem-managed roles are shown here, which cannot be edited or deleted,\nbut can be assigned to users.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this role definition.", "required": true } ], "tags": [ "role_definitions" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/role_definitions/{id}/team_assignments/": { "get": { "operationId": "role_definitions_team_assignments_list", "description": "Manage Role Team Assignment objects in the 'team_assignments' relationship of this particular Role Definition.\n\nStarting from the detail URL:\n\nGET /:id/team_assignments/ to show role team assignments currently in the 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": [ "role_definitions" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleTeamAssignmentList" } } }, "description": "" } } } }, "/api/v2/role_definitions/{id}/user_assignments/": { "get": { "operationId": "role_definitions_user_assignments_list", "description": "Manage Role User Assignment objects in the 'user_assignments' relationship of this particular Role Definition.\n\nStarting from the detail URL:\n\nGET /:id/user_assignments/ to show role user assignments currently in the 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": [ "role_definitions" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleUserAssignmentList" } } }, "description": "" } } } }, "/api/v2/role_metadata/": { "get": { "operationId": "role_metadata_retrieve", "description": "General data about models and permissions tracked by django-ansible-base RBAC\n\nInformation from this endpoint should be static given a server version.\nThis reflects model definitions, registrations with the permission registry,\nand enablement of RBAC features in settings.\n\nallowed_permissions: Valid permissions for a role of a given content_type", "tags": [ "role_metadata" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleMetadata" } } }, "description": "" } } } }, "/api/v2/role_team_access/{model_name}/{id}/": { "get": { "operationId": "role_team_access_list", "description": "Use this endpoint to get a list of users who have access to a resource.\nThis is a list-only view that provides a list of users, plus extra data.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$" }, "required": true }, { "in": "path", "name": "model_name", "schema": { "type": "string" }, "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": [ "role_team_access" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamAccessViewSet_Team_List" } } }, "description": "" } } } }, "/api/v2/role_team_access/{model_name}/{id}/{actor_id}/": { "get": { "operationId": "role_team_access_list_2", "description": "This gives drill-down information about the means of inheritance\nfor all the permissions show in the higher-level view of the access list", "parameters": [ { "in": "path", "name": "actor_id", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$" }, "required": true }, { "in": "path", "name": "model_name", "schema": { "type": "string" }, "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": [ "role_team_access" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamAccessAssignmentList" } } }, "description": "" } } } }, "/api/v2/role_team_assignments/": { "get": { "operationId": "role_team_assignments_list", "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "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": [ "role_team_assignments" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleTeamAssignmentList" } } }, "description": "" } } }, "post": { "operationId": "role_team_assignments_create", "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "tags": [ "role_team_assignments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleTeamAssignmentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleTeamAssignment" } } }, "description": "" } } } }, "/api/v2/role_team_assignments/{id}/": { "get": { "operationId": "role_team_assignments_retrieve", "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this role team assignment.", "required": true } ], "tags": [ "role_team_assignments" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleTeamAssignment" } } }, "description": "" } } }, "delete": { "operationId": "role_team_assignments_destroy", "description": "Use this endpoint to give a team permission to a resource or an organization.\nThe needed data is the team, the role definition, and the object id.\nThe object must be of the type specified in the role definition.\nThe type given in the role definition and the provided object_id are used\nto look up the resource.\n\nAfter creation, the assignment cannot be edited, but can be deleted to\nremove those permissions.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this role team assignment.", "required": true } ], "tags": [ "role_team_assignments" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/role_user_access/{model_name}/{id}/": { "get": { "operationId": "role_user_access_list", "description": "Use this endpoint to get a list of users who have access to a resource.\nThis is a list-only view that provides a list of users, plus extra data.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$" }, "required": true }, { "in": "path", "name": "model_name", "schema": { "type": "string" }, "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": [ "role_user_access" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserAccessViewSet_User_List" } } }, "description": "" } } } }, "/api/v2/role_user_access/{model_name}/{id}/{actor_id}/": { "get": { "operationId": "role_user_access_list_2", "description": "This gives drill-down information about the means of inheritance\nfor all the permissions show in the higher-level view of the access list", "parameters": [ { "in": "path", "name": "actor_id", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "id", "schema": { "type": "string", "pattern": "^([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$" }, "required": true }, { "in": "path", "name": "model_name", "schema": { "type": "string" }, "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": [ "role_user_access" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserAccessAssignmentList" } } }, "description": "" } } } }, "/api/v2/role_user_assignments/": { "get": { "operationId": "role_user_assignments_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": [ "role_user_assignments" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRoleUserAssignmentList" } } }, "description": "" } } }, "post": { "operationId": "role_user_assignments_create", "description": "Give a user permission to a resource, an organization, or globally (when allowed). Must specify 'role_definition' and exactly one of 'user' or 'user_ansible_id'. Can specify at most one of 'object_id' or 'object_ansible_id' (omit both for global roles). The content_type of the role definition and the provided object_id are used to look up the resource. After creation, the assignment cannot be edited, but can be deleted to remove those permissions.", "tags": [ "role_user_assignments" ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RoleUserAssignment" }, { "description": "Must provide exactly one of: user (integer ID) or user_ansible_id (UUID). Mutual exclusivity enforced by server validation.", "properties": { "user": { "type": "integer", "nullable": true, "description": "ID of the user to assign the role to. Mutually exclusive with user_ansible_id." }, "user_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Ansible ID of the user to assign the role to. Mutually exclusive with user." } } }, { "description": "Can provide at most one of: object_id or object_ansible_id. Omit both for global role assignments. Mutual exclusivity enforced by server validation.", "properties": { "object_id": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "uuid" } ], "nullable": true, "description": "ID of the resource object. Mutually exclusive with object_ansible_id." }, "object_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Ansible ID of the resource object. Mutually exclusive with object_id." } } } ] } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUserAssignment" } } }, "description": "" } } } }, "/api/v2/role_user_assignments/{id}/": { "get": { "operationId": "role_user_assignments_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this role user assignment.", "required": true } ], "tags": [ "role_user_assignments" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUserAssignment" } } }, "description": "" } } }, "delete": { "operationId": "role_user_assignments_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this role user assignment.", "required": true } ], "tags": [ "role_user_assignments" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/service-index/": { "get": { "operationId": "service_index_retrieve", "description": "Link other resource registry endpoints", "tags": [ "service-index" ], "responses": { "200": { "description": "No response body" } } } }, "/api/v2/service-index/metadata/": { "get": { "operationId": "service_index_metadata_retrieve", "tags": [ "service-index" ], "responses": { "200": { "description": "No response body" } } } }, "/api/v2/service-index/object-delete/": { "post": { "operationId": "service_index_object_delete_create", "description": "Delete all role assignments (user and team) for a specific resource.\n\nExpected request data:\n{\n \"resource_type\": \"main.inventory\",\n \"resource_pk\": \"4\"\n}", "tags": [ "service-index" ], "responses": { "201": { "description": "No response body" } }, "x-ai-description": "Remove all role assignments for a resource indexed from connected AAP services" } }, "/api/v2/service-index/resource-types/": { "get": { "operationId": "service_index_resource_types_list", "description": "Index of the resource types that are configured in the system.", "parameters": [ { "in": "query", "name": "content_type", "schema": { "type": "string" }, "description": "Filter by content_type (exact match)" }, { "in": "query", "name": "externally_managed", "schema": { "type": "string" }, "description": "Filter by externally_managed (exact match)" }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "Filter by id (exact match)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Filter by id (gt)" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Filter by id (gte)" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Filter by id (lt)" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Filter by id (lte)" }, { "in": "query", "name": "name", "schema": { "type": "string" }, "description": "Filter by name (exact match)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Filter by name (case-insensitive partial match)" }, { "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" } }, { "in": "query", "name": "role_level", "schema": { "type": "string" }, "description": "Filter by role level for RBAC" }, { "in": "query", "name": "type", "schema": { "type": "string" }, "description": "Filter by object type. Supports comma-separated values for multiple types." } ], "tags": [ "service-index" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceTypeList" } } }, "description": "" } } } }, "/api/v2/service-index/resource-types/{name}/": { "get": { "operationId": "service_index_resource_types_retrieve", "description": "Index of the resource types that are configured in the system.", "parameters": [ { "in": "path", "name": "name", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "service-index" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceType" } } }, "description": "" } } } }, "/api/v2/service-index/resource-types/{name}/manifest/": { "get": { "operationId": "service_index_resource_types_manifest_retrieve", "description": "Returns the as a stream the csv of resource_id,hash for a given resource type.", "parameters": [ { "in": "path", "name": "name", "schema": { "type": "string", "pattern": "^[^/]+$" }, "required": true } ], "tags": [ "service-index" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceType" } } }, "description": "" } } } }, "/api/v2/service-index/resources/": { "get": { "operationId": "service_index_resources_list", "description": "Index of all the resources in the system.", "parameters": [ { "in": "query", "name": "ansible_id", "schema": { "type": "string" }, "description": "Filter by ansible_id (exact match)" }, { "in": "query", "name": "content_object", "schema": { "type": "string" }, "description": "Filter by content_object (exact match)" }, { "in": "query", "name": "content_type", "schema": { "type": "string" }, "description": "Filter by content_type (exact match)" }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "Filter by id (exact match)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Filter by id (gt)" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Filter by id (gte)" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Filter by id (lt)" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Filter by id (lte)" }, { "in": "query", "name": "is_partially_migrated", "schema": { "type": "string" }, "description": "Filter by is_partially_migrated (exact match)" }, { "in": "query", "name": "name", "schema": { "type": "string" }, "description": "Filter by name (exact match)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Filter by name (case-insensitive partial match)" }, { "in": "query", "name": "object_id", "schema": { "type": "string" }, "description": "Filter by object_id (exact match)" }, { "in": "query", "name": "object_id__icontains", "schema": { "type": "string" }, "description": "Filter by object_id (case-insensitive partial match)" }, { "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" } }, { "in": "query", "name": "role_level", "schema": { "type": "string" }, "description": "Filter by role level for RBAC" }, { "in": "query", "name": "service_id", "schema": { "type": "string" }, "description": "Filter by service_id (exact match)" }, { "in": "query", "name": "type", "schema": { "type": "string" }, "description": "Filter by object type. Supports comma-separated values for multiple types." } ], "tags": [ "service-index" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceListList" } } }, "description": "" } } }, "post": { "operationId": "service_index_resources_create", "description": "Index of all the resources in the system.", "tags": [ "service-index" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource" } } }, "description": "" } } } }, "/api/v2/service-index/resources/{ansible_id}/": { "get": { "operationId": "service_index_resources_retrieve", "description": "Index of all the resources in the system.", "parameters": [ { "in": "path", "name": "ansible_id", "schema": { "type": "string", "format": "uuid", "description": "A unique ID identifying this resource by the resource server." }, "required": true } ], "tags": [ "service-index" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource" } } }, "description": "" } } }, "put": { "operationId": "service_index_resources_update", "description": "Index of all the resources in the system.", "parameters": [ { "in": "path", "name": "ansible_id", "schema": { "type": "string", "format": "uuid", "description": "A unique ID identifying this resource by the resource server." }, "required": true } ], "tags": [ "service-index" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource" } } }, "description": "" } } }, "patch": { "operationId": "service_index_resources_partial_update", "description": "Index of all the resources in the system.", "parameters": [ { "in": "path", "name": "ansible_id", "schema": { "type": "string", "format": "uuid", "description": "A unique ID identifying this resource by the resource server." }, "required": true } ], "tags": [ "service-index" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedResourceRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource" } } }, "description": "" } } }, "delete": { "operationId": "service_index_resources_destroy", "description": "Index of all the resources in the system.", "parameters": [ { "in": "path", "name": "ansible_id", "schema": { "type": "string", "format": "uuid", "description": "A unique ID identifying this resource by the resource server." }, "required": true } ], "tags": [ "service-index" ], "responses": { "204": { "description": "No response body" } } } }, "/api/v2/service-index/role-permissions/": { "get": { "operationId": "service_index_role_permissions_list", "description": "List of permissions managed with the RBAC system", "parameters": [ { "in": "query", "name": "api_slug", "schema": { "type": "string" }, "description": "Filter by api_slug (exact match)" }, { "in": "query", "name": "api_slug__icontains", "schema": { "type": "string" }, "description": "Filter by api_slug (case-insensitive partial match)" }, { "in": "query", "name": "codename", "schema": { "type": "string" }, "description": "Filter by codename (exact match)" }, { "in": "query", "name": "codename__icontains", "schema": { "type": "string" }, "description": "Filter by codename (case-insensitive partial match)" }, { "in": "query", "name": "content_type", "schema": { "type": "string" }, "description": "Filter by content_type (exact match)" }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "Filter by id (exact match)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Filter by id (gt)" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Filter by id (gte)" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Filter by id (lt)" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Filter by id (lte)" }, { "in": "query", "name": "name", "schema": { "type": "string" }, "description": "Filter by name (exact match)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Filter by name (case-insensitive partial match)" }, { "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": [ "service-index" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDABPermissionList" } } }, "description": "" } } } }, "/api/v2/service-index/role-team-assignments/": { "get": { "operationId": "service_index_role_team_assignments_list", "description": "List of team role assignments for cross-service communication", "parameters": [ { "in": "query", "name": "content_object", "schema": { "type": "string" }, "description": "Filter by content_object (exact match)" }, { "in": "query", "name": "content_type", "schema": { "type": "string" }, "description": "Filter by content_type (exact match)" }, { "in": "query", "name": "created", "schema": { "type": "string" }, "description": "Filter by created (exact match)" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Filter by created (gt)" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Filter by created (gte)" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Filter by created (lt)" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Filter by created (lte)" }, { "in": "query", "name": "created_by", "schema": { "type": "string" }, "description": "Filter by created_by (exact match)" }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "Filter by id (exact match)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Filter by id (gt)" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Filter by id (gte)" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Filter by id (lt)" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Filter by id (lte)" }, { "in": "query", "name": "object_id", "schema": { "type": "string" }, "description": "Filter by object_id (exact match)" }, { "in": "query", "name": "object_id__icontains", "schema": { "type": "string" }, "description": "Filter by object_id (case-insensitive partial match)" }, { "in": "query", "name": "object_role", "schema": { "type": "string" }, "description": "Filter by object_role (exact match)" }, { "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_definition", "schema": { "type": "string" }, "description": "Filter by role_definition (exact match)" }, { "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": "team", "schema": { "type": "string" }, "description": "Filter by team (exact match)" }, { "in": "query", "name": "type", "schema": { "type": "string" }, "description": "Filter by object type. Supports comma-separated values for multiple types." } ], "tags": [ "service-index" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedServiceRoleTeamAssignmentList" } } }, "description": "" } } } }, "/api/v2/service-index/role-team-assignments/assign/": { "post": { "operationId": "service_index_role_team_assignments_assign_create", "description": "List of team role assignments for cross-service communication", "tags": [ "service-index" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRoleTeamAssignmentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRoleTeamAssignment" } } }, "description": "" } } } }, "/api/v2/service-index/role-team-assignments/unassign/": { "post": { "operationId": "service_index_role_team_assignments_unassign_create", "description": "List of team role assignments for cross-service communication", "tags": [ "service-index" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRoleTeamAssignmentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRoleTeamAssignment" } } }, "description": "" } } } }, "/api/v2/service-index/role-types/": { "get": { "operationId": "service_index_role_types_list", "description": "List of types registered with the RBAC system, or loaded in from external system", "parameters": [ { "in": "query", "name": "api_slug", "schema": { "type": "string" }, "description": "Filter by api_slug (exact match)" }, { "in": "query", "name": "api_slug__icontains", "schema": { "type": "string" }, "description": "Filter by api_slug (case-insensitive partial match)" }, { "in": "query", "name": "app_label", "schema": { "type": "string" }, "description": "Filter by app_label (exact match)" }, { "in": "query", "name": "app_label__icontains", "schema": { "type": "string" }, "description": "Filter by app_label (case-insensitive partial match)" }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "Filter by id (exact match)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Filter by id (gt)" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Filter by id (gte)" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Filter by id (lt)" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Filter by id (lte)" }, { "in": "query", "name": "model", "schema": { "type": "string" }, "description": "Filter by model (exact match)" }, { "in": "query", "name": "model__icontains", "schema": { "type": "string" }, "description": "Filter by model (case-insensitive partial match)" }, { "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": "parent_content_type", "schema": { "type": "string" }, "description": "Filter by parent_content_type (exact match)" }, { "in": "query", "name": "pk_field_type", "schema": { "type": "string" }, "description": "Filter by pk_field_type (exact match)" }, { "in": "query", "name": "pk_field_type__icontains", "schema": { "type": "string" }, "description": "Filter by pk_field_type (case-insensitive partial match)" }, { "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": "service", "schema": { "type": "string" }, "description": "Filter by service (exact match)" }, { "in": "query", "name": "service__icontains", "schema": { "type": "string" }, "description": "Filter by service (case-insensitive partial match)" }, { "in": "query", "name": "type", "schema": { "type": "string" }, "description": "Filter by object type. Supports comma-separated values for multiple types." } ], "tags": [ "service-index" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDABContentTypeList" } } }, "description": "" } } } }, "/api/v2/service-index/role-user-assignments/": { "get": { "operationId": "service_index_role_user_assignments_list", "description": "List of user assignments for cross-service communication", "parameters": [ { "in": "query", "name": "content_object", "schema": { "type": "string" }, "description": "Filter by content_object (exact match)" }, { "in": "query", "name": "content_type", "schema": { "type": "string" }, "description": "Filter by content_type (exact match)" }, { "in": "query", "name": "created", "schema": { "type": "string" }, "description": "Filter by created (exact match)" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Filter by created (gt)" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Filter by created (gte)" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Filter by created (lt)" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Filter by created (lte)" }, { "in": "query", "name": "created_by", "schema": { "type": "string" }, "description": "Filter by created_by (exact match)" }, { "in": "query", "name": "id", "schema": { "type": "string" }, "description": "Filter by id (exact match)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Filter by id (gt)" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Filter by id (gte)" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Filter by id (lt)" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Filter by id (lte)" }, { "in": "query", "name": "object_id", "schema": { "type": "string" }, "description": "Filter by object_id (exact match)" }, { "in": "query", "name": "object_id__icontains", "schema": { "type": "string" }, "description": "Filter by object_id (case-insensitive partial match)" }, { "in": "query", "name": "object_role", "schema": { "type": "string" }, "description": "Filter by object_role (exact match)" }, { "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_definition", "schema": { "type": "string" }, "description": "Filter by role_definition (exact match)" }, { "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." }, { "in": "query", "name": "user", "schema": { "type": "string" }, "description": "Filter by user (exact match)" } ], "tags": [ "service-index" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedServiceRoleUserAssignmentList" } } }, "description": "" } } } }, "/api/v2/service-index/role-user-assignments/assign/": { "post": { "operationId": "service_index_role_user_assignments_assign_create", "description": "List of user assignments for cross-service communication", "tags": [ "service-index" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRoleUserAssignmentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRoleUserAssignment" } } }, "description": "" } } } }, "/api/v2/service-index/role-user-assignments/unassign/": { "post": { "operationId": "service_index_role_user_assignments_unassign_create", "description": "List of user assignments for cross-service communication", "tags": [ "service-index" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRoleUserAssignmentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceRoleUserAssignment" } } }, "description": "" } } } } }, "components": { "schemas": { "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", "x-spec-enum-id": "d1cf1307b8aa394e", "nullable": true, "description": "The action taken with respect to the given object(s).\n\n* `create` - Entity Created\n* `update` - Entity Updated\n* `delete` - Entity Deleted\n* `associate` - Entity Associated with another Entity\n* `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", "nullable": true, "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", "nullable": true, "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" ] }, "AdHocCommandCancel": { "type": "object", "properties": { "can_cancel": { "type": "boolean", "readOnly": true } } }, "AdHocCommandDetail": { "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", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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_args": { "type": "string", "readOnly": true }, "job_cwd": { "type": "string", "readOnly": true }, "job_env": { "readOnly": true }, "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." }, "result_traceback": { "type": "string", "readOnly": true }, "event_processing_finished": { "type": "boolean", "readOnly": true, "description": "Indicates whether all of the events generated by this unified job have been saved to the database." }, "launched_by": { "type": "string", "readOnly": true }, "work_unit_id": { "type": "string", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "job_type": { "enum": [ "run", "check", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true, "default": "run" }, "inventory": { "type": "integer", "nullable": true }, "limit": { "type": "string", "nullable": true, "default": "" }, "credential": { "type": "integer", "nullable": true }, "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\n* `shell` - shell\n* `yum` - yum\n* `apt` - apt\n* `apt_key` - apt_key\n* `apt_repository` - apt_repository\n* `apt_rpm` - apt_rpm\n* `service` - service\n* `group` - group\n* `user` - user\n* `mount` - mount\n* `ping` - ping\n* `selinux` - selinux\n* `setup` - setup\n* `win_ping` - win_ping\n* `win_service` - win_service\n* `win_updates` - win_updates\n* `win_group` - win_group\n* `win_user` - win_user", "x-spec-enum-id": "857230cdbb58eda2", "default": "command" }, "module_args": { "type": "string", "nullable": true, "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)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "default": 0, "minimum": 0, "maximum": 9223372036854775807 }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "become_enabled": { "type": "boolean", "nullable": true, "default": false }, "diff_mode": { "type": "boolean", "nullable": true, "default": false }, "host_status_counts": { "readOnly": true, "nullable": true, "description": "Playbook stats from the Ansible playbook_on_stats event." } } }, "AdHocCommandEvent": { "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 }, "ad_hoc_command": { "type": "integer", "readOnly": true }, "event": { "enum": [ "runner_on_failed", "runner_on_ok", "runner_on_unreachable", "runner_on_skipped", "debug", "verbose", "deprecated", "warning", "system_warning", "error", null ], "type": "string", "description": "* `runner_on_failed` - Host Failed\n* `runner_on_ok` - Host OK\n* `runner_on_unreachable` - Host Unreachable\n* `runner_on_skipped` - Host Skipped\n* `debug` - Debug\n* `verbose` - Verbose\n* `deprecated` - Deprecated\n* `warning` - Warning\n* `system_warning` - System Warning\n* `error` - Error", "x-spec-enum-id": "3c8188cd2c554d8a", "nullable": true }, "counter": { "type": "integer", "minimum": 0, "readOnly": true }, "event_display": { "type": "string", "readOnly": true }, "event_data": { "default": {} }, "failed": { "type": "boolean", "readOnly": true }, "changed": { "type": "boolean", "readOnly": true }, "uuid": { "type": "string", "readOnly": true }, "host": { "type": "integer", "readOnly": true, "nullable": true }, "host_name": { "type": "string", "readOnly": true }, "stdout": { "type": "string", "readOnly": true }, "start_line": { "type": "integer", "minimum": 0, "readOnly": true }, "end_line": { "type": "integer", "minimum": 0, "readOnly": true }, "verbosity": { "type": "integer", "minimum": 0, "readOnly": true } }, "required": [ "event" ] }, "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", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "job_type": { "enum": [ "run", "check", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true, "default": "run" }, "inventory": { "type": "integer", "nullable": true }, "limit": { "type": "string", "nullable": true, "default": "" }, "credential": { "type": "integer", "nullable": true }, "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\n* `shell` - shell\n* `yum` - yum\n* `apt` - apt\n* `apt_key` - apt_key\n* `apt_repository` - apt_repository\n* `apt_rpm` - apt_rpm\n* `service` - service\n* `group` - group\n* `user` - user\n* `mount` - mount\n* `ping` - ping\n* `selinux` - selinux\n* `setup` - setup\n* `win_ping` - win_ping\n* `win_service` - win_service\n* `win_updates` - win_updates\n* `win_group` - win_group\n* `win_user` - win_user", "x-spec-enum-id": "857230cdbb58eda2", "default": "command" }, "module_args": { "type": "string", "nullable": true, "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)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "default": 0, "minimum": 0, "maximum": 9223372036854775807 }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "become_enabled": { "type": "boolean", "nullable": true, "default": false }, "diff_mode": { "type": "boolean", "nullable": true, "default": false } } }, "AdHocCommandListRequest": { "type": "object", "properties": { "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "job_type": { "enum": [ "run", "check", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true, "default": "run" }, "inventory": { "type": "integer", "nullable": true }, "limit": { "type": "string", "nullable": true, "default": "" }, "credential": { "type": "integer", "nullable": true }, "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\n* `shell` - shell\n* `yum` - yum\n* `apt` - apt\n* `apt_key` - apt_key\n* `apt_repository` - apt_repository\n* `apt_rpm` - apt_rpm\n* `service` - service\n* `group` - group\n* `user` - user\n* `mount` - mount\n* `ping` - ping\n* `selinux` - selinux\n* `setup` - setup\n* `win_ping` - win_ping\n* `win_service` - win_service\n* `win_updates` - win_updates\n* `win_group` - win_group\n* `win_user` - win_user", "x-spec-enum-id": "857230cdbb58eda2", "default": "command" }, "module_args": { "type": "string", "nullable": true, "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)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "default": 0, "minimum": 0, "maximum": 9223372036854775807 }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "become_enabled": { "type": "boolean", "nullable": true, "default": false }, "diff_mode": { "type": "boolean", "nullable": true, "default": false } } }, "AnsibleFacts": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" } }, "required": [ "name" ] }, "BulkHost": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "maxLength": 512 }, "enabled": { "type": "boolean", "nullable": true, "default": true, "description": "Is this host online and available for running jobs?" }, "instance_id": { "type": "string", "nullable": true, "default": "", "description": "The value used by the remote inventory source to uniquely identify the host", "maxLength": 1024 }, "description": { "type": "string", "nullable": true, "default": "" }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Host variables in JSON or YAML format." } }, "required": [ "name" ] }, "BulkHostCreateRequest": { "type": "object", "properties": { "inventory": { "type": "integer", "writeOnly": true, "description": "Primary Key ID of inventory to add hosts to." }, "hosts": { "type": "array", "items": { "$ref": "#/components/schemas/BulkHostRequest" }, "writeOnly": true, "description": "List of hosts to be created, JSON. e.g. [{\"name\": \"example.com\"}, {\"name\": \"127.0.0.1\"}]", "maxItems": 100000 } }, "required": [ "hosts", "inventory" ] }, "BulkHostDeleteRequest": { "type": "object", "properties": { "hosts": { "type": "array", "items": {}, "writeOnly": true, "description": "List of hosts ids to be deleted, e.g. [105, 130, 131, 200]", "maxItems": 100000 } }, "required": [ "hosts" ] }, "BulkHostRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "enabled": { "type": "boolean", "nullable": true, "default": true, "description": "Is this host online and available for running jobs?" }, "instance_id": { "type": "string", "nullable": true, "default": "", "description": "The value used by the remote inventory source to uniquely identify the host", "maxLength": 1024 }, "description": { "type": "string", "nullable": true, "default": "" }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Host variables in JSON or YAML format." } }, "required": [ "name" ] }, "BulkJobLaunchRequest": { "type": "object", "properties": { "name": { "type": "string", "writeOnly": true, "default": "Bulk Job Launch", "maxLength": 512 }, "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/BulkJobNodeRequest" }, "writeOnly": true, "description": "List of jobs to be launched, JSON. e.g. [{\"unified_job_template\": 7}, {\"unified_job_template\": 10}]" }, "description": { "type": "string", "writeOnly": true, "minLength": 1 }, "extra_vars": { "writeOnly": true }, "organization": { "type": "integer", "writeOnly": true, "nullable": true, "description": "Inherit permissions from this organization. If not provided, a organization the user is a member of will be selected automatically." }, "inventory": { "type": "integer", "writeOnly": true }, "limit": { "type": "string", "writeOnly": true, "minLength": 1 }, "scm_branch": { "type": "string", "writeOnly": true, "minLength": 1 }, "skip_tags": { "type": "string", "writeOnly": true, "minLength": 1 }, "job_tags": { "type": "string", "writeOnly": true, "minLength": 1 } }, "required": [ "jobs" ] }, "BulkJobNode": { "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 }, "extra_data": { "default": {} }, "inventory": { "type": "integer", "minimum": 1 }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "minimum": 1 }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "job": { "type": "integer", "nullable": true }, "workflow_job": { "type": "integer", "nullable": true }, "unified_job_template": { "type": "integer", "minimum": 1, "description": "Primary key of the template for this job, can be a job template or inventory source." }, "success_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "failure_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "always_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "all_parents_must_converge": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node" }, "do_not_run": { "type": "boolean", "nullable": true, "default": false, "description": "Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run." }, "identifier": { "type": "string", "nullable": true, "description": "An identifier coresponding to the workflow job template node that this node was created from.", "maxLength": 512 }, "credentials": { "type": "array", "items": { "type": "integer", "minimum": 1 } }, "labels": { "type": "array", "items": { "type": "integer", "minimum": 1 } }, "instance_groups": { "type": "array", "items": { "type": "integer", "minimum": 1 } } }, "required": [ "unified_job_template" ] }, "BulkJobNodeRequest": { "type": "object", "properties": { "extra_data": { "default": {} }, "inventory": { "type": "integer", "minimum": 1 }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "minimum": 1 }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "job": { "type": "integer", "nullable": true }, "workflow_job": { "type": "integer", "nullable": true }, "unified_job_template": { "type": "integer", "minimum": 1, "description": "Primary key of the template for this job, can be a job template or inventory source." }, "all_parents_must_converge": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node" }, "do_not_run": { "type": "boolean", "nullable": true, "default": false, "description": "Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run." }, "identifier": { "type": "string", "nullable": true, "description": "An identifier coresponding to the workflow job template node that this node was created from.", "maxLength": 512 }, "credentials": { "type": "array", "items": { "type": "integer", "minimum": 1 } }, "labels": { "type": "array", "items": { "type": "integer", "minimum": 1 } }, "instance_groups": { "type": "array", "items": { "type": "integer", "minimum": 1 } } }, "required": [ "unified_job_template" ] }, "ConstructedInventory": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "Organization containing this inventory." }, "kind": { "enum": [ "", "smart", "constructed", null ], "type": "string", "x-spec-enum-id": "2ff9e8df76c2ad0e", "readOnly": true, "nullable": true, "description": "Kind of inventory being represented.\n\n* `` - Hosts have a direct link to this inventory.\n* `smart` - Hosts for inventory generated using the host_filter property.\n* `constructed` - Parse list of source inventories with the constructed inventory plugin." }, "variables": { "type": "string", "nullable": true, "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", "nullable": true, "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", "nullable": true, "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 }, "source_vars": { "type": "string", "description": "The source_vars for the related auto-created inventory source, special to constructed inventory." }, "update_cache_timeout": { "type": "integer", "minimum": 0, "nullable": true, "description": "The cache timeout for the related auto-created inventory source, special to constructed inventory" }, "limit": { "type": "string", "description": "The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory." }, "verbosity": { "type": "integer", "maximum": 5, "minimum": 0, "nullable": true, "description": "The verbosity level for the related auto-created inventory source, special to constructed inventory" } }, "required": [ "name", "organization" ] }, "ConstructedInventoryRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "Organization containing this inventory." }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Inventory variables in JSON or YAML format." }, "prevent_instance_group_fallback": { "type": "boolean", "nullable": true, "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", "nullable": true, "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 }, "source_vars": { "type": "string", "description": "The source_vars for the related auto-created inventory source, special to constructed inventory." }, "update_cache_timeout": { "type": "integer", "minimum": 0, "nullable": true, "description": "The cache timeout for the related auto-created inventory source, special to constructed inventory" }, "limit": { "type": "string", "description": "The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory." }, "verbosity": { "type": "integer", "maximum": 5, "minimum": 0, "nullable": true, "description": "The verbosity level for the related auto-created inventory source, special to constructed inventory" } }, "required": [ "name", "organization" ] }, "Copy": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] }, "CopyRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 } }, "required": [ "name" ] }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true }, "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" ] }, "CredentialInputSource": { "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 }, "description": { "type": "string", "nullable": true, "default": "" }, "input_field_name": { "type": "string", "nullable": true, "maxLength": 1024 }, "metadata": { "default": {} }, "target_credential": { "type": "integer", "nullable": true }, "source_credential": { "type": "integer", "nullable": true } }, "required": [ "input_field_name", "source_credential", "target_credential" ] }, "CredentialInputSourceRequest": { "type": "object", "properties": { "description": { "type": "string", "nullable": true, "default": "" }, "input_field_name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 1024 }, "metadata": { "default": {} }, "target_credential": { "type": "integer", "nullable": true }, "source_credential": { "type": "integer", "nullable": true } }, "required": [ "input_field_name", "source_credential", "target_credential" ] }, "CredentialRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true }, "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" ] }, "CredentialSerializerCreate": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "Inherit permissions from organization roles. If provided on creation, do not give either user or team." }, "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" ] }, "CredentialSerializerCreateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "Inherit permissions from organization roles. If provided on creation, do not give either user or team." }, "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." }, "user": { "type": "integer", "writeOnly": true, "nullable": true, "description": "Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation." }, "team": { "type": "integer", "writeOnly": true, "nullable": true, "description": "Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation." } }, "required": [ "credential_type", "name" ] }, "CredentialType": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "kind": { "enum": [ "ssh", "vault", "net", "scm", "cloud", "registry", "token", "insights", "external", "kubernetes", "galaxy", "cryptography", null ], "type": "string", "description": "* `ssh` - Machine\n* `vault` - Vault\n* `net` - Network\n* `scm` - Source Control\n* `cloud` - Cloud\n* `registry` - Container Registry\n* `token` - Personal Access Token\n* `insights` - Insights\n* `external` - External\n* `kubernetes` - Kubernetes\n* `galaxy` - Galaxy/Automation Hub\n* `cryptography` - Cryptography", "x-spec-enum-id": "8c34823df94b101f", "nullable": true }, "namespace": { "type": "string", "readOnly": true, "nullable": true }, "managed": { "type": "boolean", "readOnly": true }, "inputs": { "default": {}, "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax." }, "injectors": { "default": {}, "description": "Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax." } }, "required": [ "kind", "name" ] }, "CredentialTypeRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "kind": { "enum": [ "cloud", "net" ], "type": "string", "description": "* `cloud` - Cloud\\n* `net` - Network", "x-spec-enum-id": "8c34823df94b101f", "nullable": true }, "inputs": { "default": {}, "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax." }, "injectors": { "default": {}, "description": "Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax." } }, "required": [ "kind", "name" ] }, "DABContentType": { "type": "object", "properties": { "api_slug": { "type": "string", "description": "String to use for references to this type from other models in the API.", "maxLength": 201 }, "service": { "type": "string", "description": "service namespace to track what service this type is for. Can have a value of shared, which indicates it is synchronized.", "maxLength": 100 }, "app_label": { "type": "string", "description": "Django app that the model is in. This is an internal technical detail that does not affect API use.", "maxLength": 100 }, "model": { "type": "string", "description": "Name of the type according to the Django ORM Meta model_name convention. Comes from the python class, but lowercase with no spaces.", "maxLength": 100 }, "parent_content_type": { "type": "string", "description": "String to use for references to this type from other models in the API.", "readOnly": true }, "pk_field_type": { "type": "string", "description": "Database field type of the primary key field of the model, relevant for interal logic tracking permissions.", "maxLength": 100 } }, "required": [ "app_label", "model" ] }, "DABPermission": { "type": "object", "properties": { "api_slug": { "type": "string", "description": "String to use for references to this type from other models in the API.", "maxLength": 201 }, "codename": { "type": "string", "description": "A codename for the permission, in the format {action}_{model_name}. Where action is typically the view set action (view/list/etc) from Django rest framework.", "maxLength": 100 }, "content_type": { "type": "string", "description": "String to use for references to this type from other models in the API.", "readOnly": true }, "name": { "type": "string", "description": "The name of this permission.", "maxLength": 255 } }, "required": [ "codename", "name" ] }, "ExecutionEnvironment": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "The organization used to determine access to this execution environment." }, "image": { "type": "string", "nullable": true, "title": "Image location", "description": "The full image location, including the container registry, image name, and version tag.", "maxLength": 1024 }, "managed": { "type": "boolean", "readOnly": true }, "credential": { "type": "integer", "nullable": true }, "pull": { "enum": [ "always", "missing", "never", "", null ], "type": "string", "x-spec-enum-id": "63475462f6c34286", "nullable": true, "default": "", "description": "Pull image before running?\n\n* `always` - Always pull container before running.\n* `missing` - Only pull the image if not present before running.\n* `never` - Never pull container before running." } }, "required": [ "image", "name" ] }, "ExecutionEnvironmentRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "The organization used to determine access to this execution environment." }, "image": { "type": "string", "nullable": true, "minLength": 1, "title": "Image location", "description": "The full image location, including the container registry, image name, and version tag.", "maxLength": 1024 }, "credential": { "type": "integer", "nullable": true }, "pull": { "enum": [ "always", "missing", "never", "", null ], "type": "string", "x-spec-enum-id": "63475462f6c34286", "nullable": true, "default": "", "description": "Pull image before running?\n\n* `always` - Always pull container before running.\n* `missing` - Only pull the image if not present before running.\n* `never` - Never pull container before running." } }, "required": [ "image", "name" ] }, "FeatureFlagStates": { "type": "object", "description": "Serialize list of feature flags", "properties": { "name": { "type": "string", "description": "The name of the feature flag. Must follow the format of FEATURE__ENABLED.", "maxLength": 64 }, "state": { "type": "string", "readOnly": true } }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "inventory": { "type": "integer" }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Group variables in JSON or YAML format." } }, "required": [ "inventory", "name" ] }, "GroupRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "inventory": { "type": "integer" }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Group variables in JSON or YAML format." } }, "required": [ "inventory", "name" ] }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "inventory": { "type": "integer" }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Group variables in JSON or YAML format." }, "children": { "type": "string", "readOnly": true } }, "required": [ "inventory", "name" ] }, "GroupVariableData": { "type": "object", "properties": { "variables": { "type": "string", "nullable": true, "default": "", "description": "Group variables in JSON or YAML format." } } }, "GroupVariableDataRequest": { "type": "object", "properties": { "variables": { "type": "string", "nullable": true, "default": "", "description": "Group variables in JSON or YAML format." } } }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "inventory": { "type": "integer" }, "enabled": { "type": "boolean", "nullable": true, "default": true, "description": "Is this host online and available for running jobs?" }, "instance_id": { "type": "string", "nullable": true, "default": "", "description": "The value used by the remote inventory source to uniquely identify the host", "maxLength": 1024 }, "variables": { "type": "string", "nullable": true, "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", "readOnly": true, "nullable": true }, "last_job_host_summary": { "type": "integer", "readOnly": true, "nullable": true }, "ansible_facts_modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time ansible_facts was last modified." } }, "required": [ "inventory", "name" ] }, "HostMetric": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "hostname": { "type": "string", "nullable": true, "maxLength": 512 }, "url": { "type": "string", "readOnly": true }, "first_automation": { "type": "string", "format": "date-time", "readOnly": true, "description": "When the host was first automated against" }, "last_automation": { "type": "string", "format": "date-time", "description": "When the host was last automated against" }, "last_deleted": { "type": "string", "format": "date-time", "nullable": true, "description": "When the host was last deleted" }, "automated_counter": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "default": 0, "description": "How many times was the host automated" }, "deleted_counter": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "default": 0, "description": "How many times was the host deleted" }, "deleted": { "type": "boolean", "nullable": true, "default": false, "description": "Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption" }, "used_in_inventories": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "nullable": true, "description": "How many inventories contain this host" } }, "required": [ "hostname", "last_automation" ] }, "HostMetricSummaryMonthly": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "date": { "type": "string", "format": "date", "readOnly": true }, "license_consumed": { "type": "integer", "readOnly": true, "description": "How many unique hosts are consumed from the license" }, "license_capacity": { "type": "integer", "readOnly": true, "description": "'License capacity as max. number of unique hosts" }, "hosts_added": { "type": "integer", "readOnly": true, "description": "How many hosts were added in the associated month, consuming more license capacity" }, "hosts_deleted": { "type": "integer", "readOnly": true, "description": "How many hosts were deleted in the associated month, freeing the license capacity" }, "indirectly_managed_hosts": { "type": "integer", "readOnly": true, "description": "Manually entered number indirectly managed hosts for a certain month" } } }, "HostRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "inventory": { "type": "integer" }, "enabled": { "type": "boolean", "nullable": true, "default": true, "description": "Is this host online and available for running jobs?" }, "instance_id": { "type": "string", "nullable": true, "default": "", "description": "The value used by the remote inventory source to uniquely identify the host", "maxLength": 1024 }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Host variables in JSON or YAML format." } }, "required": [ "inventory", "name" ] }, "HostVariableData": { "type": "object", "properties": { "variables": { "type": "string", "nullable": true, "default": "", "description": "Host variables in JSON or YAML format." } } }, "HostVariableDataRequest": { "type": "object", "properties": { "variables": { "type": "string", "nullable": true, "default": "", "description": "Host variables in JSON or YAML format." } } }, "Instance": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "hostname": { "type": "string", "nullable": true, "maxLength": 250, "pattern": "^localhost$|^127(?:\\.[0-9]+){0,2}\\.[0-9]+$|^(?:0*\\:)*?:?0*1$" }, "type": { "type": "string", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "related": { "type": "string", "readOnly": true }, "summary_fields": { "type": "string", "readOnly": true }, "uuid": { "type": "string", "readOnly": true, "nullable": true }, "created": { "type": "string", "readOnly": true }, "modified": { "type": "string", "readOnly": true }, "last_seen": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes." }, "health_check_started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The last time a health check was initiated on this instance." }, "health_check_pending": { "type": "string", "readOnly": true }, "last_health_check": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Last time a health check was ran on this instance to refresh cpu, memory, and capacity." }, "errors": { "type": "string", "readOnly": true, "description": "Any error details from the last health check." }, "capacity_adjustment": { "type": "string", "format": "decimal", "pattern": "^-?\\d{0,1}(?:\\.\\d{0,2})?$", "default": "1.00" }, "version": { "type": "string", "readOnly": true, "nullable": true }, "capacity": { "type": "integer", "minimum": 0, "readOnly": true }, "consumed_capacity": { "type": "string", "readOnly": true }, "percent_capacity_remaining": { "type": "string", "readOnly": true }, "jobs_running": { "type": "integer", "readOnly": true, "description": "Count of jobs in the running or waiting state that are targeted for this instance" }, "jobs_total": { "type": "integer", "readOnly": true, "description": "Count of all jobs that target this instance" }, "cpu": { "type": "string", "format": "decimal", "pattern": "^-?\\d{0,3}(?:\\.\\d{0,1})?$", "readOnly": true }, "memory": { "type": "integer", "readOnly": true, "description": "Total system memory of this instance in bytes." }, "cpu_capacity": { "type": "integer", "readOnly": true }, "mem_capacity": { "type": "integer", "readOnly": true }, "enabled": { "type": "boolean", "nullable": true, "default": true }, "managed_by_policy": { "type": "boolean", "nullable": true, "default": true }, "node_type": { "enum": [ "control", "execution", "hybrid", "hop", null ], "type": "string", "x-spec-enum-id": "a8ac655d7e95642d", "nullable": true, "default": "execution", "description": "Role that this node plays in the mesh.\n\n* `control` - Control plane node\n* `execution` - Execution plane node\n* `hybrid` - Controller and execution\n* `hop` - Message-passing node, no execution capability" }, "node_state": { "enum": [ "provisioning", "provision-fail", "installed", "ready", "unavailable", "deprovisioning", "deprovision-fail", null ], "type": "string", "x-spec-enum-id": "16153846e23ecc6d", "nullable": true, "default": "installed", "description": "Indicates the current life cycle stage of this instance.\n\n* `provisioning` - Provisioning\n* `provision-fail` - Provisioning Failure\n* `installed` - Installed\n* `ready` - Ready\n* `unavailable` - Unavailable\n* `deprovisioning` - De-provisioning\n* `deprovision-fail` - De-provisioning Failure" }, "managed": { "type": "boolean", "readOnly": true, "description": "If True, this instance is managed by the control plane." }, "ip_address": { "type": "string", "readOnly": true, "nullable": true }, "peers": { "type": "array", "items": { "type": "integer" }, "description": "Primary keys of receptor addresses to peer to." }, "reverse_peers": { "type": "string", "readOnly": true }, "listener_port": { "type": "integer", "nullable": true }, "peers_from_control_nodes": { "type": "boolean" }, "protocol": { "type": "string", "readOnly": true } }, "required": [ "hostname" ] }, "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", "nullable": true, "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", "nullable": true }, "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", "nullable": true, "default": "" }, "summary_fields": { "type": "string", "readOnly": true } }, "required": [ "name" ] }, "InstanceGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "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", "nullable": true }, "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", "nullable": true, "default": "" } }, "required": [ "name" ] }, "InstanceHealthCheck": { "type": "object", "properties": { "uuid": { "type": "string", "readOnly": true, "nullable": true }, "hostname": { "type": "string", "readOnly": true, "nullable": true }, "ip_address": { "type": "string", "readOnly": true, "nullable": true }, "version": { "type": "string", "readOnly": true, "nullable": true }, "last_health_check": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Last time a health check was ran on this instance to refresh cpu, memory, and capacity." }, "errors": { "type": "string", "readOnly": true, "description": "Any error details from the last health check." }, "cpu": { "type": "string", "format": "decimal", "pattern": "^-?\\d{0,3}(?:\\.\\d{0,1})?$", "readOnly": true }, "memory": { "type": "integer", "readOnly": true, "description": "Total system memory of this instance in bytes." }, "cpu_capacity": { "type": "integer", "readOnly": true }, "mem_capacity": { "type": "integer", "readOnly": true }, "capacity": { "type": "integer", "readOnly": true } } }, "InstanceRequest": { "type": "object", "properties": { "hostname": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 250, "pattern": "^localhost$|^127(?:\\.[0-9]+){0,2}\\.[0-9]+$|^(?:0*\\:)*?:?0*1$" }, "capacity_adjustment": { "type": "string", "format": "decimal", "pattern": "^-?\\d{0,1}(?:\\.\\d{0,2})?$", "default": "1.00" }, "enabled": { "type": "boolean", "nullable": true, "default": true }, "managed_by_policy": { "type": "boolean", "nullable": true, "default": true }, "node_type": { "enum": [ "control", "execution", "hybrid", "hop", null ], "type": "string", "x-spec-enum-id": "a8ac655d7e95642d", "nullable": true, "default": "execution", "description": "Role that this node plays in the mesh.\n\n* `control` - Control plane node\n* `execution` - Execution plane node\n* `hybrid` - Controller and execution\n* `hop` - Message-passing node, no execution capability" }, "node_state": { "enum": [ "provisioning", "provision-fail", "installed", "ready", "unavailable", "deprovisioning", "deprovision-fail", null ], "type": "string", "x-spec-enum-id": "16153846e23ecc6d", "nullable": true, "default": "installed", "description": "Indicates the current life cycle stage of this instance.\n\n* `provisioning` - Provisioning\n* `provision-fail` - Provisioning Failure\n* `installed` - Installed\n* `ready` - Ready\n* `unavailable` - Unavailable\n* `deprovisioning` - De-provisioning\n* `deprovision-fail` - De-provisioning Failure" }, "peers": { "type": "array", "items": { "type": "integer" }, "description": "Primary keys of receptor addresses to peer to." }, "listener_port": { "type": "integer", "nullable": true }, "peers_from_control_nodes": { "type": "boolean" } }, "required": [ "hostname" ] }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "Organization containing this inventory." }, "kind": { "enum": [ "", "smart", "constructed", null ], "type": "string", "x-spec-enum-id": "2ff9e8df76c2ad0e", "nullable": true, "default": "", "description": "Kind of inventory being represented.\n\n* `` - Hosts have a direct link to this inventory.\n* `smart` - Hosts for inventory generated using the host_filter property.\n* `constructed` - Parse list of source inventories with the constructed inventory plugin." }, "host_filter": { "type": "string", "nullable": true, "description": "Filter that will be applied to the hosts of this inventory." }, "variables": { "type": "string", "nullable": true, "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", "nullable": true, "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", "nullable": true, "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" ] }, "InventoryRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "Organization containing this inventory." }, "kind": { "enum": [ "", "smart", "constructed", null ], "type": "string", "x-spec-enum-id": "2ff9e8df76c2ad0e", "nullable": true, "default": "", "description": "Kind of inventory being represented.\n\n* `` - Hosts have a direct link to this inventory.\n* `smart` - Hosts for inventory generated using the host_filter property.\n* `constructed` - Parse list of source inventories with the constructed inventory plugin." }, "host_filter": { "type": "string", "nullable": true, "description": "Filter that will be applied to the hosts of this inventory." }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Inventory variables in JSON or YAML format." }, "prevent_instance_group_fallback": { "type": "boolean", "nullable": true, "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", "nullable": true, "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" ] }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "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\n* `controller` - Red Hat Ansible Automation Platform\n* `ec2` - Amazon EC2\n* `gce` - Google Compute Engine\n* `insights` - Red Hat Insights\n* `openshift_virtualization` - OpenShift Virtualization\n* `openstack` - OpenStack\n* `rhv` - Red Hat Virtualization\n* `satellite6` - Red Hat Satellite 6\n* `terraform` - Terraform State\n* `vmware` - VMware vCenter\n* `scm` - Sourced from a Project\n* `constructed` - Template additional groups and hostvars at runtime", "x-spec-enum-id": "2e54dfe09d4f7d8d" }, "source_path": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "source_vars": { "type": "string", "nullable": true, "default": "", "description": "Inventory source variables in YAML or JSON format." }, "scm_branch": { "type": "string", "nullable": true, "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", "minimum": 1, "nullable": true, "description": "Cloud credential to use for inventory updates." }, "enabled_var": { "type": "string", "nullable": true, "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", "nullable": true, "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", "nullable": true, "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", "nullable": true, "default": false, "description": "Overwrite local groups and hosts from remote inventory source." }, "overwrite_vars": { "type": "boolean", "nullable": true, "default": false, "description": "Overwrite local variables from remote inventory source." }, "custom_virtualenv": { "type": "string", "readOnly": true, "nullable": 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)\n* `1` - 1 (INFO)\n* `2` - 2 (DEBUG)", "x-spec-enum-id": "48197bd695a06691", "default": 1, "minimum": 0, "maximum": 9223372036854775807 }, "limit": { "type": "string", "nullable": true, "default": "", "description": "Enter host, group or pattern match" }, "last_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "last_job_failed": { "type": "boolean", "readOnly": true }, "next_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "status": { "enum": [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "none" ], "type": "string", "description": "* `new` - New\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled\n* `never updated` - Never Updated\n* `none` - No External Source", "x-spec-enum-id": "697673f6ed4abf52", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "inventory": { "type": "integer", "nullable": true }, "update_on_launch": { "type": "boolean", "nullable": true, "default": false }, "update_cache_timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0 }, "source_project": { "type": "integer", "nullable": true, "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" ] }, "InventorySourceRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "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\n* `controller` - Red Hat Ansible Automation Platform\n* `ec2` - Amazon EC2\n* `gce` - Google Compute Engine\n* `insights` - Red Hat Insights\n* `openshift_virtualization` - OpenShift Virtualization\n* `openstack` - OpenStack\n* `rhv` - Red Hat Virtualization\n* `satellite6` - Red Hat Satellite 6\n* `terraform` - Terraform State\n* `vmware` - VMware vCenter\n* `scm` - Sourced from a Project\n* `constructed` - Template additional groups and hostvars at runtime", "x-spec-enum-id": "2e54dfe09d4f7d8d" }, "source_path": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "source_vars": { "type": "string", "nullable": true, "default": "", "description": "Inventory source variables in YAML or JSON format." }, "scm_branch": { "type": "string", "nullable": true, "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", "minimum": 1, "nullable": true, "description": "Cloud credential to use for inventory updates." }, "enabled_var": { "type": "string", "nullable": true, "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", "nullable": true, "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", "nullable": true, "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", "nullable": true, "default": false, "description": "Overwrite local groups and hosts from remote inventory source." }, "overwrite_vars": { "type": "boolean", "nullable": true, "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)\n* `1` - 1 (INFO)\n* `2` - 2 (DEBUG)", "x-spec-enum-id": "48197bd695a06691", "default": 1, "minimum": 0, "maximum": 9223372036854775807 }, "limit": { "type": "string", "nullable": true, "default": "", "description": "Enter host, group or pattern match" }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "inventory": { "type": "integer", "nullable": true }, "update_on_launch": { "type": "boolean", "nullable": true, "default": false }, "update_cache_timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0 }, "source_project": { "type": "integer", "nullable": true, "description": "Project containing inventory file used as source." } }, "required": [ "inventory", "name", "source" ] }, "InventorySourceUpdate": { "type": "object", "properties": { "can_update": { "type": "boolean", "readOnly": true } } }, "InventoryUpdateCancel": { "type": "object", "properties": { "can_cancel": { "type": "boolean", "readOnly": true } } }, "InventoryUpdateDetail": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "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\n* `controller` - Red Hat Ansible Automation Platform\n* `ec2` - Amazon EC2\n* `gce` - Google Compute Engine\n* `insights` - Red Hat Insights\n* `openshift_virtualization` - OpenShift Virtualization\n* `openstack` - OpenStack\n* `rhv` - Red Hat Virtualization\n* `satellite6` - Red Hat Satellite 6\n* `terraform` - Terraform State\n* `vmware` - VMware vCenter\n* `scm` - Sourced from a Project\n* `constructed` - Template additional groups and hostvars at runtime", "x-spec-enum-id": "2e54dfe09d4f7d8d" }, "source_path": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "source_vars": { "type": "string", "nullable": true, "default": "", "description": "Inventory source variables in YAML or JSON format." }, "scm_branch": { "type": "string", "nullable": true, "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", "minimum": 1, "nullable": true, "description": "Cloud credential to use for inventory updates." }, "enabled_var": { "type": "string", "nullable": true, "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", "nullable": true, "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", "nullable": true, "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", "nullable": true, "default": false, "description": "Overwrite local groups and hosts from remote inventory source." }, "overwrite_vars": { "type": "boolean", "nullable": true, "default": false, "description": "Overwrite local variables from remote inventory source." }, "custom_virtualenv": { "type": "string", "nullable": true, "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)\n* `1` - 1 (INFO)\n* `2` - 2 (DEBUG)", "x-spec-enum-id": "48197bd695a06691", "default": 1, "minimum": 0, "maximum": 9223372036854775807 }, "limit": { "type": "string", "nullable": true, "default": "", "description": "Enter host, group or pattern match" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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_args": { "type": "string", "readOnly": true }, "job_cwd": { "type": "string", "readOnly": true }, "job_env": { "readOnly": true }, "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." }, "result_traceback": { "type": "string", "readOnly": true }, "event_processing_finished": { "type": "boolean", "readOnly": true, "description": "Indicates whether all of the events generated by this unified job have been saved to the database." }, "launched_by": { "type": "string", "readOnly": true }, "work_unit_id": { "type": "string", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "inventory": { "type": "integer", "nullable": true }, "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", "nullable": true, "description": "Inventory files from this Project Update were used for the inventory update." }, "instance_group": { "type": "integer", "nullable": true, "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" }, "source_project": { "type": "string", "readOnly": true, "description": "The project used for this job." } }, "required": [ "name", "source" ] }, "InventoryUpdateEvent": { "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 }, "event": { "type": "string", "readOnly": true }, "counter": { "type": "integer", "minimum": 0, "readOnly": true }, "event_display": { "type": "string", "readOnly": true }, "event_data": { "default": {} }, "failed": { "type": "string", "readOnly": true }, "changed": { "type": "string", "readOnly": true }, "uuid": { "type": "string", "readOnly": true }, "stdout": { "type": "string", "readOnly": true }, "start_line": { "type": "integer", "minimum": 0, "readOnly": true }, "end_line": { "type": "integer", "minimum": 0, "readOnly": true }, "verbosity": { "type": "integer", "minimum": 0, "readOnly": true }, "inventory_update": { "type": "integer", "readOnly": true } } }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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", "readOnly": true, "nullable": 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\n* `controller` - Red Hat Ansible Automation Platform\n* `ec2` - Amazon EC2\n* `gce` - Google Compute Engine\n* `insights` - Red Hat Insights\n* `openshift_virtualization` - OpenShift Virtualization\n* `openstack` - OpenStack\n* `rhv` - Red Hat Virtualization\n* `satellite6` - Red Hat Satellite 6\n* `terraform` - Terraform State\n* `vmware` - VMware vCenter\n* `scm` - Sourced from a Project\n* `constructed` - Template additional groups and hostvars at runtime", "x-spec-enum-id": "2e54dfe09d4f7d8d" }, "source_path": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "source_vars": { "type": "string", "nullable": true, "default": "", "description": "Inventory source variables in YAML or JSON format." }, "scm_branch": { "type": "string", "nullable": true, "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", "minimum": 1, "nullable": true, "description": "Cloud credential to use for inventory updates." }, "enabled_var": { "type": "string", "nullable": true, "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", "nullable": true, "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", "nullable": true, "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", "nullable": true, "default": false, "description": "Overwrite local groups and hosts from remote inventory source." }, "overwrite_vars": { "type": "boolean", "nullable": true, "default": false, "description": "Overwrite local variables from remote inventory source." }, "custom_virtualenv": { "type": "string", "nullable": true, "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)\n* `1` - 1 (INFO)\n* `2` - 2 (DEBUG)", "x-spec-enum-id": "48197bd695a06691", "default": 1, "minimum": 0, "maximum": 9223372036854775807 }, "limit": { "type": "string", "nullable": true, "default": "", "description": "Enter host, group or pattern match" }, "inventory": { "type": "integer", "nullable": true }, "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", "nullable": true, "description": "Inventory files from this Project Update were used for the inventory update." }, "instance_group": { "type": "integer", "nullable": true, "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" ] }, "InventoryVariableData": { "type": "object", "properties": { "variables": { "type": "string", "nullable": true, "default": "", "description": "Inventory variables in JSON or YAML format." } } }, "InventoryVariableDataRequest": { "type": "object", "properties": { "variables": { "type": "string", "nullable": true, "default": "", "description": "Inventory variables in JSON or YAML format." } } }, "JobCancel": { "type": "object", "properties": { "can_cancel": { "type": "boolean", "readOnly": true } } }, "JobCreateSchedule": { "type": "object", "properties": { "can_schedule": { "type": "string", "readOnly": true }, "prompts": { "type": "string", "readOnly": true } } }, "JobDetail": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "job_type": { "enum": [ "run", "check", "scan", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check\n* `scan` - Scan", "x-spec-enum-id": "b0ae05beb5a5e8ab", "nullable": true, "default": "run" }, "inventory": { "type": "integer", "nullable": true }, "project": { "type": "integer", "nullable": true }, "playbook": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "scm_branch": { "type": "string", "nullable": true, "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", "nullable": true, "default": "" }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "default": 0, "minimum": 0, "maximum": 9223372036854775807 }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "job_tags": { "type": "string", "nullable": true, "default": "" }, "force_handlers": { "type": "boolean", "nullable": true, "default": false }, "skip_tags": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "start_at_task": { "type": "string", "nullable": true, "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", "nullable": true, "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", "readOnly": true, "nullable": true, "description": "The organization used to determine access to this unified job." }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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_args": { "type": "string", "readOnly": true }, "job_cwd": { "type": "string", "readOnly": true }, "job_env": { "readOnly": true }, "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." }, "result_traceback": { "type": "string", "readOnly": true }, "event_processing_finished": { "type": "boolean", "readOnly": true, "description": "Indicates whether all of the events generated by this unified job have been saved to the database." }, "launched_by": { "type": "string", "readOnly": true }, "work_unit_id": { "type": "string", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "job_template": { "type": "integer", "nullable": true }, "passwords_needed_to_start": { "type": "string", "readOnly": true }, "allow_simultaneous": { "type": "boolean", "nullable": true, "default": false }, "artifacts": { "type": "string", "readOnly": true }, "scm_revision": { "type": "string", "readOnly": true, "description": "The SCM Revision from the Project used for this job, if available" }, "instance_group": { "type": "integer", "nullable": true, "description": "The Instance group the job was run under" }, "diff_mode": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled, textual changes made to any templated files on the host are shown in the standard output" }, "job_slice_number": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0, "description": "If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used." }, "job_slice_count": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 1, "description": "If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job." }, "webhook_service": { "enum": [ "github", "gitlab", "bitbucket_dc", "", null ], "type": "string", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "webhook_guid": { "type": "string", "nullable": true, "description": "Unique identifier of the event that triggered this webhook", "maxLength": 128 }, "host_status_counts": { "readOnly": true, "nullable": true, "description": "Playbook stats from the Ansible playbook_on_stats event." }, "playbook_counts": { "type": "string", "readOnly": true, "description": "A count of all plays and tasks for the job run." }, "custom_virtualenv": { "type": "string", "nullable": true, "description": "Local absolute file path containing a custom Python virtualenv to use", "readOnly": true } }, "required": [ "name" ] }, "JobEvent": { "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 }, "job": { "type": "integer", "readOnly": true, "nullable": true }, "event": { "enum": [ "runner_on_failed", "runner_on_start", "runner_on_ok", "runner_on_error", "runner_on_skipped", "runner_on_unreachable", "runner_on_no_hosts", "runner_on_async_poll", "runner_on_async_ok", "runner_on_async_failed", "runner_item_on_ok", "runner_item_on_failed", "runner_item_on_skipped", "runner_retry", "runner_on_file_diff", "playbook_on_start", "playbook_on_notify", "playbook_on_include", "playbook_on_no_hosts_matched", "playbook_on_no_hosts_remaining", "playbook_on_task_start", "playbook_on_vars_prompt", "playbook_on_setup", "playbook_on_import_for_host", "playbook_on_not_import_for_host", "playbook_on_play_start", "playbook_on_stats", "debug", "verbose", "deprecated", "warning", "system_warning", "error", null ], "type": "string", "description": "* `runner_on_failed` - Host Failed\n* `runner_on_start` - Host Started\n* `runner_on_ok` - Host OK\n* `runner_on_error` - Host Failure\n* `runner_on_skipped` - Host Skipped\n* `runner_on_unreachable` - Host Unreachable\n* `runner_on_no_hosts` - No Hosts Remaining\n* `runner_on_async_poll` - Host Polling\n* `runner_on_async_ok` - Host Async OK\n* `runner_on_async_failed` - Host Async Failure\n* `runner_item_on_ok` - Item OK\n* `runner_item_on_failed` - Item Failed\n* `runner_item_on_skipped` - Item Skipped\n* `runner_retry` - Host Retry\n* `runner_on_file_diff` - File Difference\n* `playbook_on_start` - Playbook Started\n* `playbook_on_notify` - Running Handlers\n* `playbook_on_include` - Including File\n* `playbook_on_no_hosts_matched` - No Hosts Matched\n* `playbook_on_no_hosts_remaining` - No Hosts Remaining\n* `playbook_on_task_start` - Task Started\n* `playbook_on_vars_prompt` - Variables Prompted\n* `playbook_on_setup` - Gathering Facts\n* `playbook_on_import_for_host` - internal: on Import for Host\n* `playbook_on_not_import_for_host` - internal: on Not Import for Host\n* `playbook_on_play_start` - Play Started\n* `playbook_on_stats` - Playbook Complete\n* `debug` - Debug\n* `verbose` - Verbose\n* `deprecated` - Deprecated\n* `warning` - Warning\n* `system_warning` - System Warning\n* `error` - Error", "x-spec-enum-id": "c0ba91bdee205c59", "nullable": true }, "counter": { "type": "integer", "minimum": 0, "readOnly": true }, "event_display": { "type": "string", "readOnly": true }, "event_data": { "default": {} }, "event_level": { "type": "integer", "readOnly": true }, "failed": { "type": "boolean", "readOnly": true }, "changed": { "type": "boolean", "readOnly": true }, "uuid": { "type": "string", "readOnly": true }, "parent_uuid": { "type": "string", "readOnly": true }, "host": { "type": "integer", "readOnly": true, "nullable": true }, "host_name": { "type": "string", "readOnly": true }, "playbook": { "type": "string", "readOnly": true }, "play": { "type": "string", "readOnly": true }, "task": { "type": "string", "readOnly": true }, "role": { "type": "string", "readOnly": true }, "stdout": { "type": "string", "readOnly": true }, "start_line": { "type": "integer", "minimum": 0, "readOnly": true }, "end_line": { "type": "integer", "minimum": 0, "readOnly": true }, "verbosity": { "type": "integer", "minimum": 0, "readOnly": true } }, "required": [ "event" ] }, "JobHostSummary": { "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 }, "job": { "type": "integer", "readOnly": true }, "host": { "type": "integer", "readOnly": true, "nullable": true }, "constructed_host": { "type": "integer", "readOnly": true, "nullable": true, "description": "Only for jobs run against constructed inventories, this links to the host inside the constructed inventory." }, "host_name": { "type": "string", "readOnly": true, "default": "" }, "changed": { "type": "integer", "minimum": 0, "readOnly": true }, "dark": { "type": "integer", "minimum": 0, "readOnly": true }, "failures": { "type": "integer", "minimum": 0, "readOnly": true }, "ok": { "type": "integer", "minimum": 0, "readOnly": true }, "processed": { "type": "integer", "minimum": 0, "readOnly": true }, "skipped": { "type": "integer", "minimum": 0, "readOnly": true }, "failed": { "type": "boolean", "readOnly": true }, "ignored": { "type": "integer", "minimum": 0, "readOnly": true }, "rescued": { "type": "integer", "minimum": 0, "readOnly": true } } }, "JobLaunch": { "type": "object", "properties": { "can_start_without_user_input": { "type": "boolean", "readOnly": true }, "passwords_needed_to_start": { "type": "string", "readOnly": true }, "ask_scm_branch_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_variables_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_tags_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_diff_mode_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_skip_tags_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_job_type_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_limit_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_verbosity_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_inventory_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_credential_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_execution_environment_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_labels_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_forks_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_job_slice_count_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_timeout_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_instance_groups_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "survey_enabled": { "type": "string", "readOnly": true }, "variables_needed_to_start": { "type": "string", "readOnly": true }, "credential_needed_to_start": { "type": "string", "readOnly": true }, "inventory_needed_to_start": { "type": "string", "readOnly": true }, "job_template_data": { "type": "string", "readOnly": true }, "defaults": { "type": "string", "readOnly": true } } }, "JobLaunchRequest": { "type": "object", "properties": { "extra_vars": { "writeOnly": true }, "inventory": { "type": "integer", "writeOnly": true }, "scm_branch": { "type": "string", "writeOnly": true }, "limit": { "type": "string", "writeOnly": true }, "job_tags": { "type": "string", "writeOnly": true }, "skip_tags": { "type": "string", "writeOnly": true }, "job_type": { "enum": [ "run", "check" ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "writeOnly": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "writeOnly": true }, "diff_mode": { "type": "boolean", "writeOnly": true }, "credentials": { "type": "array", "items": { "type": "integer", "writeOnly": true }, "writeOnly": true }, "credential_passwords": { "type": "string", "writeOnly": true }, "execution_environment": { "type": "integer", "writeOnly": true }, "labels": { "type": "array", "items": { "type": "integer", "writeOnly": true }, "writeOnly": true }, "forks": { "type": "integer", "minimum": 0, "writeOnly": true }, "job_slice_count": { "type": "integer", "minimum": 0, "writeOnly": true }, "timeout": { "type": "integer", "writeOnly": true }, "instance_groups": { "type": "array", "items": { "type": "integer", "writeOnly": true }, "writeOnly": true } } }, "JobList": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "job_type": { "enum": [ "run", "check", "scan", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check\n* `scan` - Scan", "x-spec-enum-id": "b0ae05beb5a5e8ab", "nullable": true, "default": "run" }, "inventory": { "type": "integer", "nullable": true }, "project": { "type": "integer", "nullable": true }, "playbook": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "scm_branch": { "type": "string", "nullable": true, "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", "nullable": true, "default": "" }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "default": 0, "minimum": 0, "maximum": 9223372036854775807 }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "job_tags": { "type": "string", "nullable": true, "default": "" }, "force_handlers": { "type": "boolean", "nullable": true, "default": false }, "skip_tags": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "start_at_task": { "type": "string", "nullable": true, "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", "nullable": true, "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", "readOnly": true, "nullable": true, "description": "The organization used to determine access to this unified job." }, "job_template": { "type": "integer", "nullable": true }, "passwords_needed_to_start": { "type": "string", "readOnly": true }, "allow_simultaneous": { "type": "boolean", "nullable": true, "default": false }, "scm_revision": { "type": "string", "readOnly": true, "description": "The SCM Revision from the Project used for this job, if available" }, "instance_group": { "type": "integer", "nullable": true, "description": "The Instance group the job was run under" }, "diff_mode": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled, textual changes made to any templated files on the host are shown in the standard output" }, "job_slice_number": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0, "description": "If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used." }, "job_slice_count": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 1, "description": "If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job." }, "webhook_service": { "enum": [ "github", "gitlab", "bitbucket_dc", "", null ], "type": "string", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "webhook_guid": { "type": "string", "nullable": true, "description": "Unique identifier of the event that triggered this webhook", "maxLength": 128 } }, "required": [ "name" ] }, "JobRelaunch": { "type": "object", "properties": { "passwords_needed_to_start": { "type": "string", "readOnly": true }, "retry_counts": { "type": "string", "readOnly": true } } }, "JobRelaunchRequest": { "type": "object", "properties": { "hosts": { "enum": [ "all", "failed", null ], "type": "string", "description": "* `all` - No change to job limit\n* `failed` - All failed and unreachable hosts", "x-spec-enum-id": "8755f71f4bbbbdab", "writeOnly": true, "nullable": true, "default": "all" }, "job_type": { "enum": [ "run", "check", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "writeOnly": true, "nullable": true }, "credential_passwords": { "type": "string", "writeOnly": true } } }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "job_type": { "enum": [ "run", "check", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true, "default": "run" }, "inventory": { "type": "integer", "nullable": true }, "project": { "type": "integer", "nullable": true }, "playbook": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "scm_branch": { "type": "string", "nullable": true, "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", "nullable": true, "default": "" }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "default": 0, "minimum": 0, "maximum": 9223372036854775807 }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "job_tags": { "type": "string", "nullable": true, "default": "" }, "force_handlers": { "type": "boolean", "nullable": true, "default": false }, "skip_tags": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "start_at_task": { "type": "string", "nullable": true, "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", "nullable": true, "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", "readOnly": true, "nullable": true, "description": "The organization used to determine access to this template." }, "last_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "last_job_failed": { "type": "boolean", "readOnly": true }, "next_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "status": { "enum": [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated" ], "type": "string", "description": "* `new` - New\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled\n* `never updated` - Never Updated", "x-spec-enum-id": "91b42427ee973322", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "host_config_key": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "ask_scm_branch_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_diff_mode_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_variables_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_limit_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_skip_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_job_type_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_verbosity_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_inventory_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_credential_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_execution_environment_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_labels_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_forks_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_job_slice_count_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_timeout_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_instance_groups_on_launch": { "type": "boolean", "nullable": true, "default": false }, "survey_enabled": { "type": "boolean", "nullable": true, "default": false }, "become_enabled": { "type": "boolean", "nullable": true, "default": false }, "diff_mode": { "type": "boolean", "nullable": true, "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", "nullable": true, "default": false }, "custom_virtualenv": { "type": "string", "readOnly": true, "nullable": 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", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "prevent_instance_group_fallback": { "type": "boolean", "nullable": true, "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", "nullable": true, "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" ] }, "JobTemplateRequest": { "type": "object", "description": "Provide recent jobs and survey details in summary_fields", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "job_type": { "enum": [ "run", "check", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true, "default": "run" }, "inventory": { "type": "integer", "nullable": true }, "project": { "type": "integer", "nullable": true }, "playbook": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "scm_branch": { "type": "string", "nullable": true, "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", "nullable": true, "default": "" }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "default": 0, "minimum": 0, "maximum": 9223372036854775807 }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "job_tags": { "type": "string", "nullable": true, "default": "" }, "force_handlers": { "type": "boolean", "nullable": true, "default": false }, "skip_tags": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "start_at_task": { "type": "string", "nullable": true, "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", "nullable": true, "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." }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "host_config_key": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "ask_scm_branch_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_diff_mode_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_variables_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_limit_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_skip_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_job_type_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_verbosity_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_inventory_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_credential_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_execution_environment_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_labels_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_forks_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_job_slice_count_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_timeout_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_instance_groups_on_launch": { "type": "boolean", "nullable": true, "default": false }, "survey_enabled": { "type": "boolean", "nullable": true, "default": false }, "become_enabled": { "type": "boolean", "nullable": true, "default": false }, "diff_mode": { "type": "boolean", "nullable": true, "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", "nullable": true, "default": false }, "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", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "prevent_instance_group_fallback": { "type": "boolean", "nullable": true, "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", "nullable": true, "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" ] }, "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", "nullable": true, "maxLength": 512 }, "organization": { "type": "integer", "description": "Organization this label belongs to." } }, "required": [ "name", "organization" ] }, "LabelRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "organization": { "type": "integer", "description": "Organization this label belongs to." } }, "required": [ "name", "organization" ] }, "Notification": { "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 }, "notification_template": { "type": "integer", "readOnly": true }, "error": { "type": "string", "readOnly": true }, "status": { "enum": [ "pending", "successful", "failed" ], "type": "string", "description": "* `pending` - Pending\n* `successful` - Successful\n* `failed` - Failed", "x-spec-enum-id": "91d6a0571e1ae0e7", "readOnly": true }, "notifications_sent": { "type": "integer", "readOnly": true }, "notification_type": { "enum": [ "awssns", "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook", null ], "type": "string", "description": "* `awssns` - AWS SNS\n* `email` - Email\n* `grafana` - Grafana\n* `irc` - IRC\n* `mattermost` - Mattermost\n* `pagerduty` - Pagerduty\n* `rocketchat` - Rocket.Chat\n* `slack` - Slack\n* `twilio` - Twilio\n* `webhook` - Webhook", "x-spec-enum-id": "867d131dea32a033", "nullable": true }, "recipients": { "type": "string", "readOnly": true }, "subject": { "type": "string", "readOnly": true }, "body": { "type": "string", "readOnly": true, "description": "Notification body" } }, "required": [ "notification_type" ] }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true }, "notification_type": { "enum": [ "awssns", "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook", null ], "type": "string", "description": "* `awssns` - AWS SNS\n* `email` - Email\n* `grafana` - Grafana\n* `irc` - IRC\n* `mattermost` - Mattermost\n* `pagerduty` - Pagerduty\n* `rocketchat` - Rocket.Chat\n* `slack` - Slack\n* `twilio` - Twilio\n* `webhook` - Webhook", "x-spec-enum-id": "867d131dea32a033", "nullable": true }, "notification_configuration": { "default": {} }, "messages": { "nullable": true, "default": { "started": null, "success": null, "error": null, "workflow_approval": null }, "description": "Optional custom messages for notification template." } }, "required": [ "name", "notification_type", "organization" ] }, "NotificationTemplateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true }, "notification_type": { "enum": [ "awssns", "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook", null ], "type": "string", "description": "* `awssns` - AWS SNS\n* `email` - Email\n* `grafana` - Grafana\n* `irc` - IRC\n* `mattermost` - Mattermost\n* `pagerduty` - Pagerduty\n* `rocketchat` - Rocket.Chat\n* `slack` - Slack\n* `twilio` - Twilio\n* `webhook` - Webhook", "x-spec-enum-id": "867d131dea32a033", "nullable": true }, "notification_configuration": { "default": {} }, "messages": { "nullable": true, "default": { "started": null, "success": null, "error": null, "workflow_approval": null }, "description": "Optional custom messages for notification template." } }, "required": [ "name", "notification_type", "organization" ] }, "Organization": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "max_hosts": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0, "description": "Maximum number of hosts allowed to be managed by this organization." }, "custom_virtualenv": { "type": "string", "readOnly": true, "nullable": true, "description": "Local absolute file path containing a custom Python virtualenv to use" }, "default_environment": { "type": "integer", "nullable": true, "description": "The default execution environment for jobs run by this organization." }, "opa_query_path": { "type": "string", "nullable": true, "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" ] }, "OrganizationCredentialSerializerCreate": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "Inherit permissions from organization roles. If provided on creation, do not give either user or team." }, "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" ] }, "OrganizationCredentialSerializerCreateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "Inherit permissions from organization roles. If provided on creation, do not give either user or team." }, "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" ] }, "OrganizationRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "max_hosts": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0, "description": "Maximum number of hosts allowed to be managed by this organization." }, "default_environment": { "type": "integer", "nullable": true, "description": "The default execution environment for jobs run by this organization." }, "opa_query_path": { "type": "string", "nullable": true, "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" ] }, "PaginatedActivityStreamList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityStream" } } } }, "PaginatedAdHocCommandEventList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AdHocCommandEvent" } } } }, "PaginatedAdHocCommandListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AdHocCommandList" } } } }, "PaginatedConstructedInventoryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConstructedInventory" } } } }, "PaginatedCredentialInputSourceList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialInputSource" } } } }, "PaginatedCredentialList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Credential" } } } }, "PaginatedCredentialSerializerCreateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialSerializerCreate" } } } }, "PaginatedCredentialTypeList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialType" } } } }, "PaginatedDABContentTypeList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DABContentType" } } } }, "PaginatedDABPermissionList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DABPermission" } } } }, "PaginatedExecutionEnvironmentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionEnvironment" } } } }, "PaginatedFeatureFlagStatesList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureFlagStates" } } } }, "PaginatedGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } } }, "PaginatedHostList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Host" } } } }, "PaginatedHostMetricList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HostMetric" } } } }, "PaginatedHostMetricSummaryMonthlyList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HostMetricSummaryMonthly" } } } }, "PaginatedInstanceGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InstanceGroup" } } } }, "PaginatedInstanceList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Instance" } } } }, "PaginatedInventoryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Inventory" } } } }, "PaginatedInventorySourceList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InventorySource" } } } }, "PaginatedInventoryUpdateEventList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryUpdateEvent" } } } }, "PaginatedInventoryUpdateListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryUpdateList" } } } }, "PaginatedJobEventList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/JobEvent" } } } }, "PaginatedJobHostSummaryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/JobHostSummary" } } } }, "PaginatedJobListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/JobList" } } } }, "PaginatedJobTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/JobTemplate" } } } }, "PaginatedLabelList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Label" } } } }, "PaginatedNotificationList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } }, "PaginatedNotificationTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationTemplate" } } } }, "PaginatedOrganizationCredentialSerializerCreateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationCredentialSerializerCreate" } } } }, "PaginatedProjectList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } } }, "PaginatedProjectUpdateEventList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectUpdateEvent" } } } }, "PaginatedProjectUpdateListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectUpdateList" } } } }, "PaginatedReceptorAddressList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReceptorAddress" } } } }, "PaginatedResourceAccessListElementList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceAccessListElement" } } } }, "PaginatedResourceListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceList" } } } }, "PaginatedResourceTypeList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceType" } } } }, "PaginatedRoleDefinitionList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDefinition" } } } }, "PaginatedRoleList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } }, "PaginatedRoleSerializerWithParentAccessList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RoleSerializerWithParentAccess" } } } }, "PaginatedRoleTeamAssignmentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RoleTeamAssignment" } } } }, "PaginatedRoleUserAssignmentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RoleUserAssignment" } } } }, "PaginatedScheduleList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Schedule" } } } }, "PaginatedServiceRoleTeamAssignmentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceRoleTeamAssignment" } } } }, "PaginatedServiceRoleUserAssignmentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceRoleUserAssignment" } } } }, "PaginatedSettingCategoryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SettingCategory" } } } }, "PaginatedSystemJobEventList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SystemJobEvent" } } } }, "PaginatedSystemJobListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "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", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SystemJobTemplate" } } } }, "PaginatedTeamAccessAssignmentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TeamAccessAssignment" } } } }, "PaginatedTeamAccessViewSet_Team_List": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TeamAccessViewSet_Team_" } } } }, "PaginatedTeamCredentialSerializerCreateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TeamCredentialSerializerCreate" } } } }, "PaginatedTeamList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } } } }, "PaginatedUnifiedJobListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UnifiedJobList" } } } }, "PaginatedUnifiedJobTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UnifiedJobTemplate" } } } }, "PaginatedUserAccessAssignmentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessAssignment" } } } }, "PaginatedUserAccessViewSet_User_List": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessViewSet_User_" } } } }, "PaginatedUserCredentialSerializerCreateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UserCredentialSerializerCreate" } } } }, "PaginatedUserList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } }, "PaginatedWorkflowApprovalListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowApprovalList" } } } }, "PaginatedWorkflowJobListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowJobList" } } } }, "PaginatedWorkflowJobNodeListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowJobNodeList" } } } }, "PaginatedWorkflowJobTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowJobTemplate" } } } }, "PaginatedWorkflowJobTemplateNodeList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowJobTemplateNode" } } } }, "PatchedConstructedInventoryRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "Organization containing this inventory." }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Inventory variables in JSON or YAML format." }, "prevent_instance_group_fallback": { "type": "boolean", "nullable": true, "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", "nullable": true, "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 }, "source_vars": { "type": "string", "description": "The source_vars for the related auto-created inventory source, special to constructed inventory." }, "update_cache_timeout": { "type": "integer", "minimum": 0, "nullable": true, "description": "The cache timeout for the related auto-created inventory source, special to constructed inventory" }, "limit": { "type": "string", "description": "The limit to restrict the returned hosts for the related auto-created inventory source, special to constructed inventory." }, "verbosity": { "type": "integer", "maximum": 5, "minimum": 0, "nullable": true, "description": "The verbosity level for the related auto-created inventory source, special to constructed inventory" } } }, "PatchedCredentialInputSourceRequest": { "type": "object", "properties": { "description": { "type": "string", "nullable": true, "default": "" }, "input_field_name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 1024 }, "metadata": { "default": {} }, "target_credential": { "type": "integer", "nullable": true }, "source_credential": { "type": "integer", "nullable": true } } }, "PatchedCredentialRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true }, "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." } } }, "PatchedCredentialTypeRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "kind": { "enum": [ "cloud", "net", null ], "type": "string", "description": "* `cloud` - Cloud\\n* `net` - Network", "x-spec-enum-id": "8c34823df94b101f", "nullable": true }, "inputs": { "default": {}, "description": "Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax." }, "injectors": { "default": {}, "description": "Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax." } } }, "PatchedExecutionEnvironmentRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "The organization used to determine access to this execution environment." }, "image": { "type": "string", "nullable": true, "minLength": 1, "title": "Image location", "description": "The full image location, including the container registry, image name, and version tag.", "maxLength": 1024 }, "credential": { "type": "integer", "nullable": true }, "pull": { "enum": [ "always", "missing", "never", "", null ], "type": "string", "x-spec-enum-id": "63475462f6c34286", "nullable": true, "default": "", "description": "Pull image before running?\n\n* `always` - Always pull container before running.\n* `missing` - Only pull the image if not present before running.\n* `never` - Never pull container before running." } } }, "PatchedGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "inventory": { "type": "integer" }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Group variables in JSON or YAML format." } } }, "PatchedGroupVariableDataRequest": { "type": "object", "properties": { "variables": { "type": "string", "nullable": true, "default": "", "description": "Group variables in JSON or YAML format." } } }, "PatchedHostRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "inventory": { "type": "integer" }, "enabled": { "type": "boolean", "nullable": true, "default": true, "description": "Is this host online and available for running jobs?" }, "instance_id": { "type": "string", "nullable": true, "default": "", "description": "The value used by the remote inventory source to uniquely identify the host", "maxLength": 1024 }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Host variables in JSON or YAML format." } } }, "PatchedHostVariableDataRequest": { "type": "object", "properties": { "variables": { "type": "string", "nullable": true, "default": "", "description": "Host variables in JSON or YAML format." } } }, "PatchedInstanceGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "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", "nullable": true }, "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", "nullable": true, "default": "" } } }, "PatchedInstanceRequest": { "type": "object", "properties": { "hostname": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 250, "pattern": "^localhost$|^127(?:\\.[0-9]+){0,2}\\.[0-9]+$|^(?:0*\\:)*?:?0*1$" }, "capacity_adjustment": { "type": "string", "format": "decimal", "pattern": "^-?\\d{0,1}(?:\\.\\d{0,2})?$", "default": "1.00" }, "enabled": { "type": "boolean", "nullable": true, "default": true }, "managed_by_policy": { "type": "boolean", "nullable": true, "default": true }, "node_type": { "enum": [ "control", "execution", "hybrid", "hop", null ], "type": "string", "x-spec-enum-id": "a8ac655d7e95642d", "nullable": true, "default": "execution", "description": "Role that this node plays in the mesh.\n\n* `control` - Control plane node\n* `execution` - Execution plane node\n* `hybrid` - Controller and execution\n* `hop` - Message-passing node, no execution capability" }, "node_state": { "enum": [ "provisioning", "provision-fail", "installed", "ready", "unavailable", "deprovisioning", "deprovision-fail", null ], "type": "string", "x-spec-enum-id": "16153846e23ecc6d", "nullable": true, "default": "installed", "description": "Indicates the current life cycle stage of this instance.\n\n* `provisioning` - Provisioning\n* `provision-fail` - Provisioning Failure\n* `installed` - Installed\n* `ready` - Ready\n* `unavailable` - Unavailable\n* `deprovisioning` - De-provisioning\n* `deprovision-fail` - De-provisioning Failure" }, "peers": { "type": "array", "items": { "type": "integer" }, "description": "Primary keys of receptor addresses to peer to." }, "listener_port": { "type": "integer", "nullable": true }, "peers_from_control_nodes": { "type": "boolean" } } }, "PatchedInventoryRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "Organization containing this inventory." }, "kind": { "enum": [ "", "smart", "constructed", null ], "type": "string", "x-spec-enum-id": "2ff9e8df76c2ad0e", "nullable": true, "default": "", "description": "Kind of inventory being represented.\n\n* `` - Hosts have a direct link to this inventory.\n* `smart` - Hosts for inventory generated using the host_filter property.\n* `constructed` - Parse list of source inventories with the constructed inventory plugin." }, "host_filter": { "type": "string", "nullable": true, "description": "Filter that will be applied to the hosts of this inventory." }, "variables": { "type": "string", "nullable": true, "default": "", "description": "Inventory variables in JSON or YAML format." }, "prevent_instance_group_fallback": { "type": "boolean", "nullable": true, "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", "nullable": true, "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 } } }, "PatchedInventorySourceRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "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\n* `controller` - Red Hat Ansible Automation Platform\n* `ec2` - Amazon EC2\n* `gce` - Google Compute Engine\n* `insights` - Red Hat Insights\n* `openshift_virtualization` - OpenShift Virtualization\n* `openstack` - OpenStack\n* `rhv` - Red Hat Virtualization\n* `satellite6` - Red Hat Satellite 6\n* `terraform` - Terraform State\n* `vmware` - VMware vCenter\n* `scm` - Sourced from a Project\n* `constructed` - Template additional groups and hostvars at runtime", "x-spec-enum-id": "2e54dfe09d4f7d8d" }, "source_path": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "source_vars": { "type": "string", "nullable": true, "default": "", "description": "Inventory source variables in YAML or JSON format." }, "scm_branch": { "type": "string", "nullable": true, "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", "minimum": 1, "nullable": true, "description": "Cloud credential to use for inventory updates." }, "enabled_var": { "type": "string", "nullable": true, "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", "nullable": true, "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", "nullable": true, "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", "nullable": true, "default": false, "description": "Overwrite local groups and hosts from remote inventory source." }, "overwrite_vars": { "type": "boolean", "nullable": true, "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)\n* `1` - 1 (INFO)\n* `2` - 2 (DEBUG)", "x-spec-enum-id": "48197bd695a06691", "default": 1, "minimum": 0, "maximum": 9223372036854775807 }, "limit": { "type": "string", "nullable": true, "default": "", "description": "Enter host, group or pattern match" }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "inventory": { "type": "integer", "nullable": true }, "update_on_launch": { "type": "boolean", "nullable": true, "default": false }, "update_cache_timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0 }, "source_project": { "type": "integer", "nullable": true, "description": "Project containing inventory file used as source." } } }, "PatchedInventoryVariableDataRequest": { "type": "object", "properties": { "variables": { "type": "string", "nullable": true, "default": "", "description": "Inventory variables in JSON or YAML format." } } }, "PatchedJobTemplateRequest": { "type": "object", "description": "Provide recent jobs and survey details in summary_fields", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "job_type": { "enum": [ "run", "check", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true, "default": "run" }, "inventory": { "type": "integer", "nullable": true }, "project": { "type": "integer", "nullable": true }, "playbook": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "scm_branch": { "type": "string", "nullable": true, "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", "nullable": true, "default": "" }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "default": 0, "minimum": 0, "maximum": 9223372036854775807 }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "job_tags": { "type": "string", "nullable": true, "default": "" }, "force_handlers": { "type": "boolean", "nullable": true, "default": false }, "skip_tags": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "start_at_task": { "type": "string", "nullable": true, "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", "nullable": true, "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." }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "host_config_key": { "type": "string", "nullable": true, "default": "", "maxLength": 1024 }, "ask_scm_branch_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_diff_mode_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_variables_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_limit_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_skip_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_job_type_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_verbosity_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_inventory_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_credential_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_execution_environment_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_labels_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_forks_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_job_slice_count_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_timeout_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_instance_groups_on_launch": { "type": "boolean", "nullable": true, "default": false }, "survey_enabled": { "type": "boolean", "nullable": true, "default": false }, "become_enabled": { "type": "boolean", "nullable": true, "default": false }, "diff_mode": { "type": "boolean", "nullable": true, "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", "nullable": true, "default": false }, "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", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "prevent_instance_group_fallback": { "type": "boolean", "nullable": true, "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", "nullable": true, "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 } } }, "PatchedLabelRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "organization": { "type": "integer", "description": "Organization this label belongs to." } } }, "PatchedNotificationTemplateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true }, "notification_type": { "enum": [ "awssns", "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook", null ], "type": "string", "description": "* `awssns` - AWS SNS\n* `email` - Email\n* `grafana` - Grafana\n* `irc` - IRC\n* `mattermost` - Mattermost\n* `pagerduty` - Pagerduty\n* `rocketchat` - Rocket.Chat\n* `slack` - Slack\n* `twilio` - Twilio\n* `webhook` - Webhook", "x-spec-enum-id": "867d131dea32a033", "nullable": true }, "notification_configuration": { "default": {} }, "messages": { "nullable": true, "default": { "started": null, "success": null, "error": null, "workflow_approval": null }, "description": "Optional custom messages for notification template." } } }, "PatchedOrganizationRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "max_hosts": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0, "description": "Maximum number of hosts allowed to be managed by this organization." }, "default_environment": { "type": "integer", "nullable": true, "description": "The default execution environment for jobs run by this organization." }, "opa_query_path": { "type": "string", "nullable": true, "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 } } }, "PatchedProjectRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "local_path": { "type": "string", "nullable": true, "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "maxLength": 1024 }, "scm_type": { "enum": [ "", "git", "svn", "insights", "archive", null ], "type": "string", "x-spec-enum-id": "18ccf5bfb5c453d7", "nullable": true, "default": "", "description": "Specifies the source control system used to store the project.\n\n* `` - Manual\n* `git` - Git\n* `svn` - Subversion\n* `insights` - Red Hat Insights\n* `archive` - Remote Archive" }, "scm_url": { "type": "string", "nullable": true, "default": "", "description": "The location where the project is stored.", "maxLength": 1024 }, "scm_branch": { "type": "string", "nullable": true, "default": "", "description": "Specific branch, tag or commit to checkout.", "maxLength": 256 }, "scm_refspec": { "type": "string", "nullable": true, "default": "", "description": "For git projects, an additional refspec to fetch.", "maxLength": 1024 }, "scm_clean": { "type": "boolean", "nullable": true, "default": false, "description": "Discard any local changes before syncing the project." }, "scm_track_submodules": { "type": "boolean", "nullable": true, "default": false, "description": "Track submodules latest commits on defined branch." }, "scm_delete_on_update": { "type": "boolean", "nullable": true, "default": false, "description": "Delete the project before syncing." }, "credential": { "type": "integer", "nullable": 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." }, "organization": { "type": "integer", "nullable": true, "description": "The organization used to determine access to this template." }, "scm_update_on_launch": { "type": "boolean", "nullable": true, "default": false, "description": "Update the project when a job is launched that uses the project." }, "scm_update_cache_timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0, "description": "The number of seconds after the last project update ran that a new project update will be launched as a job dependency." }, "allow_override": { "type": "boolean", "nullable": true, "default": false, "description": "Allow changing the SCM branch or revision in a job template that uses this project." }, "default_environment": { "type": "integer", "nullable": true, "description": "The default execution environment for jobs run using this project." }, "signature_validation_credential": { "type": "integer", "nullable": true, "description": "An optional credential used for validating files in the project against unexpected changes." } } }, "PatchedResourceRequest": { "type": "object", "properties": { "ansible_id": { "type": "string", "format": "uuid", "description": "A unique ID identifying this resource by the resource server." }, "service_id": { "type": "string", "format": "uuid", "description": "ID of the service responsible for managing this resource." }, "is_partially_migrated": { "type": "boolean", "description": "A flag indicating that the resource has been copied into the resource server, but the service_id hasn't been updated yet." }, "resource_type": { "type": "string", "minLength": 1 }, "resource_data": {} } }, "PatchedRoleDefinitionRequest": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "String to use for references to this type from other models in the API." } }, "content_type": { "type": "string", "minLength": 1, "description": "String to use for references to this type from other models in the API.", "nullable": true }, "name": { "type": "string", "minLength": 1, "description": "The name of this role." }, "description": { "type": "string", "description": "A description of this role." } } }, "PatchedScheduleRequest": { "type": "object", "properties": { "rrule": { "type": "string", "nullable": true, "minLength": 1, "description": "A value representing the schedules iCal recurrence rule." }, "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "extra_data": { "default": {} }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "unified_job_template": { "type": "integer" }, "enabled": { "type": "boolean", "nullable": true, "default": true, "description": "Enables processing of this schedule." } } }, "PatchedSettingSingletonRequest": { "type": "object", "description": "Present a group of settings (by category) as a single object.", "properties": { "ACTIVITY_STREAM_ENABLED": { "type": "boolean", "default": true, "title": "Enable Activity Stream", "description": "Enable capturing activity for the activity stream." }, "ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC": { "type": "boolean", "default": false, "title": "Enable Activity Stream for Inventory Sync", "description": "Enable capturing activity for the activity stream when running inventory sync." }, "ORG_ADMINS_CAN_SEE_ALL_USERS": { "type": "boolean", "default": true, "title": "All Users Visible to Organization Admins", "description": "Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization." }, "MANAGE_ORGANIZATION_AUTH": { "type": "boolean", "default": true, "title": "Organization Admins Can Manage Users and Teams", "description": "Controls whether any Organization Admin has the privileges to create and manage users and teams." }, "TOWER_URL_BASE": { "type": "string", "minLength": 1, "default": "https://platformhost", "title": "Base URL of the service", "description": "This setting is used by services like notifications to render a valid url to the service.", "format": "uri" }, "REMOTE_HOST_HEADERS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "REMOTE_ADDR", "REMOTE_HOST" ], "description": "HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as \"HTTP_X_FORWARDED_FOR\", if behind a reverse proxy. See the \"Proxy Support\" section of the AAP Installation guide for more details." }, "PROXY_IP_ALLOWED_LIST": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [], "description": "If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally')" }, "CSRF_TRUSTED_ORIGINS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [], "title": "CSRF Trusted Origins List", "description": "If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. " }, "REDHAT_USERNAME": { "type": "string", "default": "", "title": "Red Hat Client ID for Analytics", "description": "Client ID used to send data to Automation Analytics" }, "REDHAT_PASSWORD": { "type": "string", "default": "", "title": "Red Hat Client Secret for Analytics", "description": "Client secret used to send data to Automation Analytics" }, "SUBSCRIPTIONS_USERNAME": { "type": "string", "default": "", "title": "Red Hat Username for Subscriptions", "description": "Username used to retrieve subscription and content information" }, "SUBSCRIPTIONS_PASSWORD": { "type": "string", "default": "", "title": "Red Hat Password for Subscriptions", "description": "Password used to retrieve subscription and content information" }, "SUBSCRIPTIONS_CLIENT_ID": { "type": "string", "default": "", "title": "Red Hat Client ID for Subscriptions", "description": "Client ID used to retrieve subscription and content information" }, "SUBSCRIPTIONS_CLIENT_SECRET": { "type": "string", "default": "", "title": "Red Hat Client Secret for Subscriptions", "description": "Client secret used to retrieve subscription and content information" }, "AUTOMATION_ANALYTICS_URL": { "type": "string", "minLength": 1, "default": "https://example.com", "title": "Automation Analytics upload URL", "description": "This setting is used to to configure the upload URL for data collection for Automation Analytics.", "format": "uri" }, "AWX_ANALYTICS_CANDLEPIN_CA": { "type": "string", "default": "/etc/rhsm/ca/redhat-uep.pem", "title": "Candlepin CA Certificate Path", "description": "Path to the CA certificate file for verifying TLS connections to Candlepin. Leave blank to use system certificates." }, "AWX_ANALYTICS_CANDLEPIN_RENEWAL_THRESHOLD_DAYS": { "type": "integer", "minimum": 1, "default": 90, "title": "Candlepin Certificate Renewal Threshold", "description": "Number of days before certificate expiry to trigger automatic renewal of Candlepin identity certificates." }, "AWX_ANALYTICS_CANDLEPIN_PROXY_URL": { "type": "string", "default": "", "title": "Candlepin Proxy URL", "description": "HTTP/HTTPS proxy URL for Candlepin API requests (e.g., http://proxy.example.com:8080). Leave blank for no proxy." }, "DEFAULT_EXECUTION_ENVIRONMENT": { "type": "integer", "nullable": true, "title": "Global default execution environment", "description": "The Execution Environment to be used when one has not been configured for a job template." }, "CUSTOM_VENV_PATHS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [], "title": "Custom virtual environment paths", "description": "Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line." }, "AD_HOC_COMMANDS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "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" ], "title": "Ansible Modules Allowed for Ad Hoc Jobs", "description": "List of modules allowed to be used by ad-hoc jobs." }, "ALLOW_JINJA_IN_EXTRA_VARS": { "enum": [ "always", "never", "template" ], "type": "string", "x-spec-enum-id": "28bae37cee4f4fdb", "default": "template", "title": "When can extra variables contain Jinja templates?", "description": "Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to \"template\" or \"never\".\n\n* `always` - Always\n* `never` - Never\n* `template` - Only On Job Template Definitions" }, "INCLUDE_DEPRECATED_AWX_VAR_PREFIX": { "type": "boolean", "default": true, "title": "Include Deprecated AWX Variable Prefix", "description": "When enabled (default), auto-generated job variables are emitted with both the tower_ prefix and the deprecated awx_ prefix for backward compatibility. Disable to emit only tower_ prefixed variables and eliminate duplicates. The awx_ prefix is deprecated and this setting will default to False in a future release." }, "AWX_ISOLATION_BASE_PATH": { "type": "string", "minLength": 1, "default": "/tmp", "title": "Job execution path", "description": "The directory in which the service will create new temporary directories for job execution and isolation (such as credential files)." }, "AWX_ISOLATION_SHOW_PATHS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [], "title": "Paths to expose to isolated jobs", "description": "List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. " }, "AWX_TASK_ENV": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "default": {}, "title": "Extra Environment Variables", "description": "Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending." }, "AWX_RUNNER_KEEPALIVE_SECONDS": { "type": "integer", "default": 0, "title": "K8S Ansible Runner Keep-Alive Message Interval", "description": "Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open." }, "GALAXY_TASK_ENV": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "default": { "ANSIBLE_FORCE_COLOR": "false", "GIT_SSH_COMMAND": "ssh -o StrictHostKeyChecking=no" }, "title": "Environment Variables for Galaxy Commands", "description": "Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git." }, "INSIGHTS_TRACKING_STATE": { "type": "boolean", "default": false, "title": "Gather data for Automation Analytics", "description": "Enables the service to gather data on automation and send it to Automation Analytics." }, "PROJECT_UPDATE_VVV": { "type": "boolean", "default": false, "title": "Run Project Updates With Higher Verbosity", "description": "Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates." }, "AWX_ROLES_ENABLED": { "type": "boolean", "default": true, "title": "Enable Role Download", "description": "Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects." }, "AWX_COLLECTIONS_ENABLED": { "type": "boolean", "default": true, "title": "Enable Collection(s) Download", "description": "Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects." }, "AWX_SHOW_PLAYBOOK_LINKS": { "type": "boolean", "default": false, "title": "Follow symlinks", "description": "Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself." }, "AWX_MOUNT_ISOLATED_PATHS_ON_K8S": { "type": "boolean", "default": false, "title": "Expose host paths for Container Groups", "description": "Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. " }, "GALAXY_IGNORE_CERTS": { "type": "boolean", "default": false, "title": "Ignore Ansible Galaxy SSL Certificate Verification", "description": "If set to true, certificate validation will not be done when installing content from any Galaxy server." }, "STDOUT_MAX_BYTES_DISPLAY": { "type": "integer", "minimum": 0, "default": 1048576, "title": "Standard Output Maximum Display Size", "description": "Maximum Size of Standard Output in bytes to display before requiring the output be downloaded." }, "EVENT_STDOUT_MAX_BYTES_DISPLAY": { "type": "integer", "minimum": 0, "default": 1024, "title": "Job Event Standard Output Maximum Display Size", "description": "Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated." }, "MAX_WEBSOCKET_EVENT_RATE": { "type": "integer", "minimum": 0, "default": 30, "title": "Job Event Maximum Websocket Messages Per Second", "description": "Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit." }, "SCHEDULE_MAX_JOBS": { "type": "integer", "minimum": 1, "default": 10, "title": "Maximum Scheduled Jobs", "description": "Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created." }, "AWX_ANSIBLE_CALLBACK_PLUGINS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [], "title": "Ansible Callback Plugins", "description": "List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line." }, "DEFAULT_JOB_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this." }, "DEFAULT_JOB_IDLE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed." }, "DEFAULT_INVENTORY_UPDATE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this." }, "DEFAULT_PROJECT_UPDATE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this." }, "ANSIBLE_FACT_CACHE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "title": "Per-Host Ansible Fact Cache Timeout", "description": "Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed." }, "MAX_FORKS": { "type": "integer", "default": 200, "title": "Maximum number of forks per job", "description": "Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied." }, "LOG_AGGREGATOR_HOST": { "type": "string", "nullable": true, "minLength": 1, "title": "Logging Aggregator", "description": "Hostname/IP where external logs will be sent to." }, "LOG_AGGREGATOR_PORT": { "type": "integer", "nullable": true, "title": "Logging Aggregator Port", "description": "Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator)." }, "LOG_AGGREGATOR_TYPE": { "enum": [ "logstash", "splunk", "loggly", "sumologic", "other", null ], "type": "string", "x-spec-enum-id": "f7f9aae80827f128", "nullable": true, "title": "Logging Aggregator Type", "description": "Format messages for the chosen log aggregator.\n\n* `logstash` - logstash\n* `splunk` - splunk\n* `loggly` - loggly\n* `sumologic` - sumologic\n* `other` - other" }, "LOG_AGGREGATOR_USERNAME": { "type": "string", "default": "", "title": "Logging Aggregator Username", "description": "Username for external log aggregator (if required; HTTP/s only)." }, "LOG_AGGREGATOR_PASSWORD": { "type": "string", "default": "", "title": "Logging Aggregator Password/Token", "description": "Password or authentication token for external log aggregator (if required; HTTP/s only)." }, "LOG_AGGREGATOR_LOGGERS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "awx", "activity_stream", "job_events", "system_tracking", "broadcast_websocket", "job_lifecycle" ], "title": "Loggers Sending Data to Log Aggregator Form", "description": "List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\njob_lifecycle - logs related to processing of a job\n" }, "LOG_AGGREGATOR_INDIVIDUAL_FACTS": { "type": "boolean", "default": false, "title": "Log System Tracking Facts Individually", "description": "If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing." }, "LOG_AGGREGATOR_ENABLED": { "type": "boolean", "default": false, "title": "Enable External Logging", "description": "Enable sending logs to external log aggregator." }, "LOG_AGGREGATOR_TOWER_UUID": { "type": "string", "default": "", "title": "Cluster-wide unique identifier.", "description": "Useful to uniquely identify instances." }, "LOG_AGGREGATOR_PROTOCOL": { "enum": [ "https", "tcp", "udp" ], "type": "string", "x-spec-enum-id": "7d0c803b90b97cde", "default": "https", "title": "Logging Aggregator Protocol", "description": "Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname.\n\n* `https` - HTTPS/HTTP\n* `tcp` - TCP\n* `udp` - UDP" }, "LOG_AGGREGATOR_TCP_TIMEOUT": { "type": "integer", "default": 5, "title": "TCP Connection Timeout", "description": "Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols." }, "LOG_AGGREGATOR_VERIFY_CERT": { "type": "boolean", "default": true, "title": "Enable/disable HTTPS certificate verification", "description": "Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is \"https\". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection." }, "LOG_AGGREGATOR_LEVEL": { "enum": [ "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL" ], "type": "string", "x-spec-enum-id": "337bdbe45a1d1410", "default": "INFO", "title": "Logging Aggregator Level Threshold", "description": "Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting)\n\n* `DEBUG` - DEBUG\n* `INFO` - INFO\n* `WARNING` - WARNING\n* `ERROR` - ERROR\n* `CRITICAL` - CRITICAL" }, "LOG_AGGREGATOR_ACTION_QUEUE_SIZE": { "type": "integer", "minimum": 1, "default": 131072, "title": "Maximum number of messages that can be stored in the log action queue", "description": "Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5)." }, "LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB": { "type": "integer", "minimum": 1, "default": 1, "title": "Maximum disk persistence for rsyslogd action queuing (in GB)", "description": "Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH." }, "LOG_AGGREGATOR_MAX_DISK_USAGE_PATH": { "type": "string", "minLength": 1, "default": "/var/lib/awx", "title": "File system location for rsyslogd disk persistence", "description": "Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting." }, "LOG_AGGREGATOR_RSYSLOGD_DEBUG": { "type": "boolean", "default": false, "title": "Enable rsyslogd debugging", "description": "Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation." }, "API_400_ERROR_LOG_FORMAT": { "type": "string", "minLength": 1, "default": "status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}", "title": "Log Format For API 4XX Errors", "description": "The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {}." }, "AUTOMATION_ANALYTICS_LAST_GATHER": { "type": "string", "format": "date-time", "nullable": true, "title": "Last gather date for Automation Analytics." }, "AUTOMATION_ANALYTICS_LAST_ENTRIES": { "type": "string", "default": "", "title": "Last gathered entries from the data collection service of Automation Analytics" }, "AUTOMATION_ANALYTICS_GATHER_INTERVAL": { "type": "integer", "minimum": 1800, "default": 14400, "description": "Interval (in seconds) between data gathering." }, "CANDLEPIN_CONSUMER_UUID": { "type": "string", "default": "", "description": "UUID of the registered Candlepin consumer for this AAP instance." }, "CANDLEPIN_CERT_PEM": { "type": "string", "default": "", "title": "Candlepin Identity Certificate", "description": "PEM-encoded Candlepin identity certificate for mTLS authentication." }, "CANDLEPIN_KEY_PEM": { "type": "string", "default": "", "title": "Candlepin Identity Key", "description": "PEM-encoded private key for Candlepin identity certificate." }, "CANDLEPIN_SERIAL_NUMBER": { "type": "string", "default": "", "title": "Candlepin Certificate Serial Number", "description": "Serial number of the Candlepin identity certificate for tracking." }, "BULK_JOB_MAX_LAUNCH": { "type": "integer", "default": 100, "title": "Max jobs to allow bulk jobs to launch", "description": "Max jobs to allow bulk jobs to launch" }, "BULK_HOST_MAX_CREATE": { "type": "integer", "default": 100, "title": "Max number of hosts to allow to be created in a single bulk action", "description": "Max number of hosts to allow to be created in a single bulk action" }, "BULK_HOST_MAX_DELETE": { "type": "integer", "default": 250, "title": "Max number of hosts to allow to be deleted in a single bulk action", "description": "Max number of hosts to allow to be deleted in a single bulk action" }, "SUBSCRIPTION_USAGE_MODEL": { "enum": [ "", "unique_managed_hosts" ], "type": "string", "description": "* `` - No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n* `unique_managed_hosts` - Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes", "x-spec-enum-id": "f0cccba4fe8d04cb", "default": "", "title": "Defines subscription usage model and shows Host Metrics" }, "CLEANUP_HOST_METRICS_LAST_TS": { "type": "string", "format": "date-time", "nullable": true, "title": "Last cleanup date for HostMetrics" }, "HOST_METRIC_SUMMARY_TASK_LAST_TS": { "type": "string", "format": "date-time", "nullable": true, "title": "Last computing date of HostMetricSummaryMonthly" }, "AWX_CLEANUP_PATHS": { "type": "boolean", "default": true, "title": "Enable or Disable tmp dir cleanup", "description": "Enable or Disable TMP Dir cleanup" }, "AWX_REQUEST_PROFILE": { "type": "boolean", "default": false, "title": "Debug Web Requests", "description": "Debug web request python timing" }, "DEFAULT_CONTAINER_RUN_OPTIONS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "--network", "slirp4netns:enable_ipv6=true" ], "title": "Container Run Options", "description": "List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug']" }, "RECEPTOR_RELEASE_WORK": { "type": "boolean", "default": true, "title": "Release Receptor Work", "description": "Release receptor work" }, "RECEPTOR_KEEP_WORK_ON_ERROR": { "type": "boolean", "default": false, "title": "Keep receptor work on error", "description": "Prevent receptor work from being released on when error is detected" }, "OPA_HOST": { "type": "string", "default": "", "title": "OPA server hostname", "description": "The hostname used to connect to the OPA server. If empty, policy enforcement will be disabled." }, "OPA_PORT": { "type": "integer", "default": 8181, "title": "OPA server port", "description": "The port used to connect to the OPA server. Defaults to 8181." }, "OPA_SSL": { "type": "boolean", "default": false, "title": "Use SSL for OPA connection", "description": "Enable or disable the use of SSL to connect to the OPA server. Defaults to false." }, "OPA_AUTH_TYPE": { "enum": [ "None", "Token", "Certificate" ], "type": "string", "x-spec-enum-id": "831ccaccafb11069", "default": "None", "title": "OPA authentication type", "description": "The authentication type that will be used to connect to the OPA server: \"None\", \"Token\", or \"Certificate\".\n\n* `None` - None\n* `Token` - Token\n* `Certificate` - Certificate" }, "OPA_AUTH_TOKEN": { "type": "string", "default": "", "title": "OPA authentication token", "description": "The token for authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Token\". If an authorization header is defined in OPA_AUTH_CUSTOM_HEADERS, it will be overridden by OPA_AUTH_TOKEN." }, "OPA_AUTH_CLIENT_CERT": { "type": "string", "default": "", "title": "OPA client certificate content", "description": "The content of the client certificate file for mTLS authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Certificate\"." }, "OPA_AUTH_CLIENT_KEY": { "type": "string", "default": "", "title": "OPA client key content", "description": "The content of the client key for mTLS authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Certificate\"." }, "OPA_AUTH_CA_CERT": { "type": "string", "default": "", "title": "OPA CA certificate content", "description": "The content of the CA certificate for mTLS authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Certificate\"." }, "OPA_AUTH_CUSTOM_HEADERS": { "type": "object", "additionalProperties": {}, "default": {}, "title": "OPA custom authentication headers", "description": "Optional custom headers included in requests to the OPA server. Defaults to empty dictionary ({})." }, "OPA_REQUEST_TIMEOUT": { "type": "number", "format": "double", "default": 1.5, "description": "The number of seconds after which the connection to the OPA server will time out. Defaults to 1.5 seconds." }, "OPA_REQUEST_RETRIES": { "type": "integer", "default": 2, "title": "OPA request retry count", "description": "The number of retry attempts for connecting to the OPA server. Default is 2." }, "SESSION_COOKIE_AGE": { "type": "integer", "maximum": 30000000000, "minimum": 60, "format": "int64", "default": 1800, "title": "Idle Time Force Log Out", "description": "Number of seconds that a user is inactive before they will need to login again." }, "SESSIONS_PER_USER": { "type": "integer", "minimum": -1, "default": -1, "title": "Maximum number of simultaneous logged in sessions", "description": "Maximum number of simultaneous logged in sessions a user may have. To disable enter -1." }, "DISABLE_LOCAL_AUTH": { "type": "boolean", "default": false, "title": "Disable the built-in authentication system", "description": "Controls whether users are prevented from using the built-in authentication system. " }, "AUTH_BASIC_ENABLED": { "type": "boolean", "default": true, "title": "Enable HTTP Basic Auth", "description": "Enable HTTP Basic Auth for the API Browser." }, "LOGIN_REDIRECT_OVERRIDE": { "type": "string", "default": "", "title": "Login redirect override URL", "description": "URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page." }, "ALLOW_METRICS_FOR_ANONYMOUS_USERS": { "type": "boolean", "default": false, "title": "Allow anonymous users to poll metrics", "description": "If true, anonymous users are allowed to poll metrics." }, "CUSTOM_LOGIN_INFO": { "type": "string", "default": "", "description": "If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported." }, "CUSTOM_LOGO": { "type": "string", "default": "", "description": "To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported." }, "MAX_UI_JOB_EVENTS": { "type": "integer", "minimum": 100, "default": 4000, "title": "Max Job Events Retrieved by UI", "description": "Maximum number of job events for the UI to retrieve within a single request." }, "UI_LIVE_UPDATES_ENABLED": { "type": "boolean", "default": true, "title": "Enable Live Updates in the UI", "description": "If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details." } } }, "PatchedTeamRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer" } } }, "PatchedUserRequest": { "type": "object", "properties": { "username": { "type": "string", "nullable": true, "minLength": 1, "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "pattern": "^[\\w.@+-]+$", "maxLength": 150 }, "first_name": { "type": "string", "nullable": true, "maxLength": 150 }, "last_name": { "type": "string", "nullable": true, "maxLength": 150 }, "email": { "type": "string", "nullable": true, "title": "Email address", "maxLength": 254 }, "is_superuser": { "type": "boolean", "nullable": true, "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." } } }, "PatchedWorkflowApprovalTemplateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "default": 0, "description": "The amount of time (in seconds) before the approval node expires and fails." } } }, "PatchedWorkflowJobTemplateNodeDetailRequest": { "type": "object", "description": "Influence the api browser sample data to not include workflow_job_template\nwhen editing a WorkflowNode.\n\nNote: I was not able to accomplish this through the use of extra_kwargs.\nMaybe something to do with workflow_job_template being a relational field?", "properties": { "extra_data": { "default": {} }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "workflow_job_template": { "type": "integer" }, "unified_job_template": { "type": "integer", "nullable": true }, "all_parents_must_converge": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node" }, "identifier": { "type": "string", "nullable": true, "minLength": 1, "description": "An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "maxLength": 512 } } }, "PatchedWorkflowJobTemplateRequest": { "type": "object", "description": "Provide recent jobs and survey details in summary_fields", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "The organization used to determine access to this template." }, "survey_enabled": { "type": "boolean", "nullable": true, "default": false }, "allow_simultaneous": { "type": "boolean", "nullable": true, "default": false }, "ask_variables_on_launch": { "type": "boolean", "nullable": true, "default": false }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "limit": { "type": "string", "nullable": true }, "scm_branch": { "type": "string", "nullable": true }, "ask_inventory_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_scm_branch_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_limit_on_launch": { "type": "boolean", "nullable": true, "default": false }, "webhook_service": { "enum": [ "github", "gitlab", "bitbucket_dc", "", null ], "type": "string", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "ask_labels_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_skip_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "skip_tags": { "type": "string", "nullable": true }, "job_tags": { "type": "string", "nullable": true } } }, "Project": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "local_path": { "type": "string", "nullable": true, "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "maxLength": 1024 }, "scm_type": { "enum": [ "", "git", "svn", "insights", "archive", null ], "type": "string", "x-spec-enum-id": "18ccf5bfb5c453d7", "nullable": true, "default": "", "description": "Specifies the source control system used to store the project.\n\n* `` - Manual\n* `git` - Git\n* `svn` - Subversion\n* `insights` - Red Hat Insights\n* `archive` - Remote Archive" }, "scm_url": { "type": "string", "nullable": true, "default": "", "description": "The location where the project is stored.", "maxLength": 1024 }, "scm_branch": { "type": "string", "nullable": true, "default": "", "description": "Specific branch, tag or commit to checkout.", "maxLength": 256 }, "scm_refspec": { "type": "string", "nullable": true, "default": "", "description": "For git projects, an additional refspec to fetch.", "maxLength": 1024 }, "scm_clean": { "type": "boolean", "nullable": true, "default": false, "description": "Discard any local changes before syncing the project." }, "scm_track_submodules": { "type": "boolean", "nullable": true, "default": false, "description": "Track submodules latest commits on defined branch." }, "scm_delete_on_update": { "type": "boolean", "nullable": true, "default": false, "description": "Delete the project before syncing." }, "credential": { "type": "integer", "nullable": 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." }, "scm_revision": { "type": "string", "readOnly": true, "description": "The last revision fetched by a project update" }, "last_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "last_job_failed": { "type": "boolean", "readOnly": true }, "next_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "status": { "enum": [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing" ], "type": "string", "description": "* `new` - New\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled\n* `never updated` - Never Updated\n* `ok` - OK\n* `missing` - Missing", "x-spec-enum-id": "6d29d630b4939828", "readOnly": true }, "organization": { "type": "integer", "nullable": true, "description": "The organization used to determine access to this template." }, "scm_update_on_launch": { "type": "boolean", "nullable": true, "default": false, "description": "Update the project when a job is launched that uses the project." }, "scm_update_cache_timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0, "description": "The number of seconds after the last project update ran that a new project update will be launched as a job dependency." }, "allow_override": { "type": "boolean", "nullable": true, "default": false, "description": "Allow changing the SCM branch or revision in a job template that uses this project." }, "custom_virtualenv": { "type": "string", "readOnly": true, "nullable": true, "description": "Local absolute file path containing a custom Python virtualenv to use" }, "default_environment": { "type": "integer", "nullable": true, "description": "The default execution environment for jobs run using this project." }, "signature_validation_credential": { "type": "integer", "nullable": true, "description": "An optional credential used for validating files in the project against unexpected changes." }, "last_update_failed": { "type": "boolean", "readOnly": true }, "last_updated": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "name" ] }, "ProjectInventories": { "type": "object", "properties": { "inventory_files": { "readOnly": true, "description": "Array of inventory files and directories available within this project, not comprehensive." } } }, "ProjectPlaybooks": { "type": "object", "properties": { "playbooks": { "type": "string", "readOnly": true, "description": "Array of playbooks available within this project." } } }, "ProjectRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "local_path": { "type": "string", "nullable": true, "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "maxLength": 1024 }, "scm_type": { "enum": [ "", "git", "svn", "insights", "archive", null ], "type": "string", "x-spec-enum-id": "18ccf5bfb5c453d7", "nullable": true, "default": "", "description": "Specifies the source control system used to store the project.\n\n* `` - Manual\n* `git` - Git\n* `svn` - Subversion\n* `insights` - Red Hat Insights\n* `archive` - Remote Archive" }, "scm_url": { "type": "string", "nullable": true, "default": "", "description": "The location where the project is stored.", "maxLength": 1024 }, "scm_branch": { "type": "string", "nullable": true, "default": "", "description": "Specific branch, tag or commit to checkout.", "maxLength": 256 }, "scm_refspec": { "type": "string", "nullable": true, "default": "", "description": "For git projects, an additional refspec to fetch.", "maxLength": 1024 }, "scm_clean": { "type": "boolean", "nullable": true, "default": false, "description": "Discard any local changes before syncing the project." }, "scm_track_submodules": { "type": "boolean", "nullable": true, "default": false, "description": "Track submodules latest commits on defined branch." }, "scm_delete_on_update": { "type": "boolean", "nullable": true, "default": false, "description": "Delete the project before syncing." }, "credential": { "type": "integer", "nullable": 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." }, "organization": { "type": "integer", "nullable": true, "description": "The organization used to determine access to this template." }, "scm_update_on_launch": { "type": "boolean", "nullable": true, "default": false, "description": "Update the project when a job is launched that uses the project." }, "scm_update_cache_timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": 0, "format": "int64", "default": 0, "description": "The number of seconds after the last project update ran that a new project update will be launched as a job dependency." }, "allow_override": { "type": "boolean", "nullable": true, "default": false, "description": "Allow changing the SCM branch or revision in a job template that uses this project." }, "default_environment": { "type": "integer", "nullable": true, "description": "The default execution environment for jobs run using this project." }, "signature_validation_credential": { "type": "integer", "nullable": true, "description": "An optional credential used for validating files in the project against unexpected changes." } }, "required": [ "name" ] }, "ProjectUpdateCancel": { "type": "object", "properties": { "can_cancel": { "type": "boolean", "readOnly": true } } }, "ProjectUpdateDetail": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "local_path": { "type": "string", "nullable": true, "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "maxLength": 1024 }, "scm_type": { "enum": [ "", "git", "svn", "insights", "archive", null ], "type": "string", "x-spec-enum-id": "18ccf5bfb5c453d7", "nullable": true, "default": "", "description": "Specifies the source control system used to store the project.\n\n* `` - Manual\n* `git` - Git\n* `svn` - Subversion\n* `insights` - Red Hat Insights\n* `archive` - Remote Archive" }, "scm_url": { "type": "string", "nullable": true, "default": "", "description": "The location where the project is stored.", "maxLength": 1024 }, "scm_branch": { "type": "string", "nullable": true, "default": "", "description": "Specific branch, tag or commit to checkout.", "maxLength": 256 }, "scm_refspec": { "type": "string", "nullable": true, "default": "", "description": "For git projects, an additional refspec to fetch.", "maxLength": 1024 }, "scm_clean": { "type": "boolean", "nullable": true, "default": false, "description": "Discard any local changes before syncing the project." }, "scm_track_submodules": { "type": "boolean", "nullable": true, "default": false, "description": "Track submodules latest commits on defined branch." }, "scm_delete_on_update": { "type": "boolean", "nullable": true, "default": false, "description": "Delete the project before syncing." }, "credential": { "type": "integer", "nullable": 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." }, "scm_revision": { "type": "string", "readOnly": true, "description": "The SCM Revision discovered by this update for the given project and branch." }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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_args": { "type": "string", "readOnly": true }, "job_cwd": { "type": "string", "readOnly": true }, "job_env": { "readOnly": true }, "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." }, "result_traceback": { "type": "string", "readOnly": true }, "event_processing_finished": { "type": "boolean", "readOnly": true, "description": "Indicates whether all of the events generated by this unified job have been saved to the database." }, "launched_by": { "type": "string", "readOnly": true }, "work_unit_id": { "type": "string", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "project": { "type": "integer", "readOnly": true }, "job_type": { "enum": [ "run", "check", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true, "default": "check" }, "job_tags": { "type": "string", "nullable": true, "default": "", "description": "Parts of the project update playbook that will be run.", "maxLength": 1024 }, "host_status_counts": { "readOnly": true, "nullable": true, "description": "Playbook stats from the Ansible playbook_on_stats event." }, "playbook_counts": { "type": "string", "readOnly": true, "description": "A count of all plays and tasks for the job run." } }, "required": [ "name" ] }, "ProjectUpdateEvent": { "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 }, "event": { "enum": [ "runner_on_failed", "runner_on_start", "runner_on_ok", "runner_on_error", "runner_on_skipped", "runner_on_unreachable", "runner_on_no_hosts", "runner_on_async_poll", "runner_on_async_ok", "runner_on_async_failed", "runner_item_on_ok", "runner_item_on_failed", "runner_item_on_skipped", "runner_retry", "runner_on_file_diff", "playbook_on_start", "playbook_on_notify", "playbook_on_include", "playbook_on_no_hosts_matched", "playbook_on_no_hosts_remaining", "playbook_on_task_start", "playbook_on_vars_prompt", "playbook_on_setup", "playbook_on_import_for_host", "playbook_on_not_import_for_host", "playbook_on_play_start", "playbook_on_stats", "debug", "verbose", "deprecated", "warning", "system_warning", "error", null ], "type": "string", "description": "* `runner_on_failed` - Host Failed\n* `runner_on_start` - Host Started\n* `runner_on_ok` - Host OK\n* `runner_on_error` - Host Failure\n* `runner_on_skipped` - Host Skipped\n* `runner_on_unreachable` - Host Unreachable\n* `runner_on_no_hosts` - No Hosts Remaining\n* `runner_on_async_poll` - Host Polling\n* `runner_on_async_ok` - Host Async OK\n* `runner_on_async_failed` - Host Async Failure\n* `runner_item_on_ok` - Item OK\n* `runner_item_on_failed` - Item Failed\n* `runner_item_on_skipped` - Item Skipped\n* `runner_retry` - Host Retry\n* `runner_on_file_diff` - File Difference\n* `playbook_on_start` - Playbook Started\n* `playbook_on_notify` - Running Handlers\n* `playbook_on_include` - Including File\n* `playbook_on_no_hosts_matched` - No Hosts Matched\n* `playbook_on_no_hosts_remaining` - No Hosts Remaining\n* `playbook_on_task_start` - Task Started\n* `playbook_on_vars_prompt` - Variables Prompted\n* `playbook_on_setup` - Gathering Facts\n* `playbook_on_import_for_host` - internal: on Import for Host\n* `playbook_on_not_import_for_host` - internal: on Not Import for Host\n* `playbook_on_play_start` - Play Started\n* `playbook_on_stats` - Playbook Complete\n* `debug` - Debug\n* `verbose` - Verbose\n* `deprecated` - Deprecated\n* `warning` - Warning\n* `system_warning` - System Warning\n* `error` - Error", "x-spec-enum-id": "c0ba91bdee205c59", "nullable": true }, "counter": { "type": "integer", "minimum": 0, "readOnly": true }, "event_display": { "type": "string", "readOnly": true }, "event_data": { "type": "string", "readOnly": true }, "event_level": { "type": "integer", "readOnly": true }, "failed": { "type": "boolean", "readOnly": true }, "changed": { "type": "boolean", "readOnly": true }, "uuid": { "type": "string", "readOnly": true }, "host_name": { "type": "string", "readOnly": true }, "playbook": { "type": "string", "readOnly": true }, "play": { "type": "string", "readOnly": true }, "task": { "type": "string", "readOnly": true }, "role": { "type": "string", "readOnly": true }, "stdout": { "type": "string", "readOnly": true }, "start_line": { "type": "integer", "minimum": 0, "readOnly": true }, "end_line": { "type": "integer", "minimum": 0, "readOnly": true }, "verbosity": { "type": "integer", "minimum": 0, "readOnly": true }, "project_update": { "type": "integer", "readOnly": true } }, "required": [ "event" ] }, "ProjectUpdateList": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "local_path": { "type": "string", "nullable": true, "description": "Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.", "maxLength": 1024 }, "scm_type": { "enum": [ "", "git", "svn", "insights", "archive", null ], "type": "string", "x-spec-enum-id": "18ccf5bfb5c453d7", "nullable": true, "default": "", "description": "Specifies the source control system used to store the project.\n\n* `` - Manual\n* `git` - Git\n* `svn` - Subversion\n* `insights` - Red Hat Insights\n* `archive` - Remote Archive" }, "scm_url": { "type": "string", "nullable": true, "default": "", "description": "The location where the project is stored.", "maxLength": 1024 }, "scm_branch": { "type": "string", "nullable": true, "default": "", "description": "Specific branch, tag or commit to checkout.", "maxLength": 256 }, "scm_refspec": { "type": "string", "nullable": true, "default": "", "description": "For git projects, an additional refspec to fetch.", "maxLength": 1024 }, "scm_clean": { "type": "boolean", "nullable": true, "default": false, "description": "Discard any local changes before syncing the project." }, "scm_track_submodules": { "type": "boolean", "nullable": true, "default": false, "description": "Track submodules latest commits on defined branch." }, "scm_delete_on_update": { "type": "boolean", "nullable": true, "default": false, "description": "Delete the project before syncing." }, "credential": { "type": "integer", "nullable": 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." }, "scm_revision": { "type": "string", "readOnly": true, "description": "The SCM Revision discovered by this update for the given project and branch." }, "project": { "type": "integer", "readOnly": true }, "job_type": { "enum": [ "run", "check", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true, "default": "check" }, "job_tags": { "type": "string", "nullable": true, "default": "", "description": "Parts of the project update playbook that will be run.", "maxLength": 1024 } }, "required": [ "name" ] }, "ProjectUpdateView": { "type": "object", "properties": { "can_update": { "type": "boolean", "readOnly": true } } }, "ReceptorAddress": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "address": { "type": "string", "nullable": true, "description": "Routable address for this instance.", "maxLength": 255 }, "port": { "type": "integer", "maximum": 65535, "minimum": 0, "default": 27199, "description": "Port for the address." }, "protocol": { "enum": [ "tcp", "ws", "wss", null ], "type": "string", "x-spec-enum-id": "66927b81fe0555f9", "nullable": true, "default": "tcp", "description": "Protocol to use for the Receptor listener, 'tcp', 'wss', or 'ws'.\n\n* `tcp` - TCP\n* `ws` - WS\n* `wss` - WSS" }, "websocket_path": { "type": "string", "nullable": true, "default": "", "description": "Websocket path.", "maxLength": 255 }, "is_internal": { "type": "boolean", "nullable": true, "default": false, "description": "If True, only routable within the Kubernetes cluster." }, "canonical": { "type": "boolean", "nullable": true, "default": false, "description": "If True, this address is the canonical address for the instance." }, "instance": { "type": "integer" }, "peers_from_control_nodes": { "type": "boolean", "nullable": true, "default": false, "description": "If True, control plane cluster nodes should automatically peer to it." }, "full_address": { "type": "string", "readOnly": true } }, "required": [ "address", "instance" ] }, "Resource": { "type": "object", "properties": { "object_id": { "type": "string", "readOnly": true, "description": "The object id for this resource." }, "name": { "type": "string", "readOnly": true, "nullable": true, "description": "The name of this resource." }, "ansible_id": { "type": "string", "format": "uuid", "description": "A unique ID identifying this resource by the resource server." }, "service_id": { "type": "string", "format": "uuid", "description": "ID of the service responsible for managing this resource." }, "is_partially_migrated": { "type": "boolean", "description": "A flag indicating that the resource has been copied into the resource server, but the service_id hasn't been updated yet." }, "resource_type": { "type": "string" }, "has_serializer": { "type": "boolean", "readOnly": true }, "resource_data": {}, "url": { "type": "string", "readOnly": true }, "additional_data": { "type": "string", "readOnly": true } }, "required": [ "resource_data" ] }, "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", "nullable": true, "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "pattern": "^[\\w.@+-]+$", "maxLength": 150 }, "first_name": { "type": "string", "nullable": true, "maxLength": 150 }, "last_name": { "type": "string", "nullable": true, "maxLength": 150 }, "email": { "type": "string", "nullable": true, "title": "Email address", "maxLength": 254 }, "is_superuser": { "type": "boolean", "nullable": true, "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", "format": "date-time", "readOnly": true, "nullable": true } }, "required": [ "username" ] }, "ResourceList": { "type": "object", "properties": { "object_id": { "type": "string", "readOnly": true, "description": "The object id for this resource." }, "name": { "type": "string", "readOnly": true, "nullable": true, "description": "The name of this resource." }, "ansible_id": { "type": "string", "format": "uuid", "description": "A unique ID identifying this resource by the resource server." }, "service_id": { "type": "string", "format": "uuid", "description": "ID of the service responsible for managing this resource." }, "is_partially_migrated": { "type": "boolean", "description": "A flag indicating that the resource has been copied into the resource server, but the service_id hasn't been updated yet." }, "resource_type": { "type": "string" }, "has_serializer": { "type": "boolean", "readOnly": true }, "url": { "type": "string", "readOnly": true } } }, "ResourceRequest": { "type": "object", "properties": { "ansible_id": { "type": "string", "format": "uuid", "description": "A unique ID identifying this resource by the resource server." }, "service_id": { "type": "string", "format": "uuid", "description": "ID of the service responsible for managing this resource." }, "is_partially_migrated": { "type": "boolean", "description": "A flag indicating that the resource has been copied into the resource server, but the service_id hasn't been updated yet." }, "resource_type": { "type": "string", "minLength": 1 }, "resource_data": {} }, "required": [ "resource_data" ] }, "ResourceType": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true, "description": "The name of this resource type." }, "externally_managed": { "type": "boolean", "description": "Is this resource type managed externally from this service." }, "shared_resource_type": { "type": "string", "nullable": true, "readOnly": true }, "url": { "type": "string", "readOnly": true } }, "required": [ "externally_managed" ] }, "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 } } }, "RoleDefinition": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "related": { "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "summary_fields": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "permissions": { "type": "array", "items": { "type": "string", "description": "String to use for references to this type from other models in the API." } }, "content_type": { "type": "string", "description": "String to use for references to this type from other models in the API.", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date/time this resource was created." }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date/time this resource was created." }, "name": { "type": "string", "description": "The name of this role." }, "description": { "type": "string", "description": "A description of this role." }, "managed": { "type": "boolean", "readOnly": true, "description": "Is this role managed by the system (not changeable by the users)." }, "modified_by": { "type": "integer", "readOnly": true, "nullable": true, "description": "The user who last modified this resource." }, "created_by": { "type": "integer", "readOnly": true, "nullable": true, "description": "The user who created this resource." } }, "required": [ "name", "permissions" ] }, "RoleDefinitionDetail": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "related": { "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "summary_fields": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "permissions": { "type": "array", "items": { "type": "string", "description": "String to use for references to this type from other models in the API." } }, "content_type": { "type": "string", "description": "String to use for references to this type from other models in the API.", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date/time this resource was created." }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date/time this resource was created." }, "name": { "type": "string", "description": "The name of this role." }, "description": { "type": "string", "description": "A description of this role." }, "managed": { "type": "boolean", "readOnly": true, "description": "Is this role managed by the system (not changeable by the users)." }, "modified_by": { "type": "integer", "readOnly": true, "nullable": true, "description": "The user who last modified this resource." }, "created_by": { "type": "integer", "readOnly": true, "nullable": true, "description": "The user who created this resource." } }, "required": [ "name", "permissions" ] }, "RoleDefinitionDetailRequest": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "String to use for references to this type from other models in the API." } }, "name": { "type": "string", "minLength": 1, "description": "The name of this role." }, "description": { "type": "string", "description": "A description of this role." } }, "required": [ "name", "permissions" ] }, "RoleDefinitionRequest": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "String to use for references to this type from other models in the API." } }, "content_type": { "type": "string", "minLength": 1, "description": "String to use for references to this type from other models in the API.", "nullable": true }, "name": { "type": "string", "minLength": 1, "description": "The name of this role." }, "description": { "type": "string", "description": "A description of this role." } }, "required": [ "name", "permissions" ] }, "RoleMetadata": { "type": "object", "properties": { "allowed_permissions": { "type": "object", "additionalProperties": {}, "description": "A List of permissions allowed for a role definition, given its content type." } }, "required": [ "allowed_permissions" ] }, "RoleSerializerWithParentAccess": { "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 } } }, "RoleTeamAssignment": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "related": { "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "summary_fields": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date/time this resource was created." }, "created_by": { "type": "integer", "readOnly": true, "nullable": true, "description": "The user who created this resource." }, "content_type": { "type": "string", "description": "String to use for references to this type from other models in the API.", "readOnly": true }, "object_id": { "type": "string", "nullable": true, "description": "The primary key of the object this assignment applies to; null value indicates system-wide assignment." }, "object_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The resource id of the object this role applies to. An alternative to the object_id field." }, "role_definition": { "type": "integer", "description": "The role definition which defines permissions conveyed by this assignment." }, "team": { "type": "integer", "nullable": true }, "team_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The resource ID of the team who will receive permissions from this assignment. An alternative to team field." } }, "required": [ "role_definition" ] }, "RoleTeamAssignmentRequest": { "type": "object", "properties": { "object_id": { "type": "string", "nullable": true, "description": "The primary key of the object this assignment applies to; null value indicates system-wide assignment." }, "object_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The resource id of the object this role applies to. An alternative to the object_id field." }, "role_definition": { "type": "integer", "description": "The role definition which defines permissions conveyed by this assignment." }, "team": { "type": "integer", "nullable": true }, "team_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The resource ID of the team who will receive permissions from this assignment. An alternative to team field." } }, "required": [ "role_definition" ] }, "RoleUserAssignment": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "related": { "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "summary_fields": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date/time this resource was created." }, "created_by": { "type": "integer", "readOnly": true, "nullable": true, "description": "The user who created this resource." }, "content_type": { "type": "string", "description": "String to use for references to this type from other models in the API.", "readOnly": true }, "object_id": { "type": "string", "nullable": true, "description": "The primary key of the object this assignment applies to; null value indicates system-wide assignment." }, "object_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The resource id of the object this role applies to. An alternative to the object_id field." }, "role_definition": { "type": "integer", "description": "The role definition which defines permissions conveyed by this assignment." }, "user": { "type": "integer", "nullable": true }, "user_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The resource ID of the user who will receive permissions from this assignment. An alternative to user field." } }, "required": [ "role_definition" ] }, "Schedule": { "type": "object", "properties": { "rrule": { "type": "string", "nullable": true, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "extra_data": { "default": {} }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "unified_job_template": { "type": "integer" }, "enabled": { "type": "boolean", "nullable": true, "default": true, "description": "Enables processing of this schedule." }, "dtstart": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The first occurrence of the schedule occurs on or after this time." }, "dtend": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The last occurrence of the schedule occurs before this time, aftewards the schedule expires." }, "next_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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" ] }, "SchedulePreview": { "type": "object", "properties": { "rrule": { "type": "string", "nullable": true, "description": "A value representing the schedules iCal recurrence rule." } }, "required": [ "rrule" ] }, "SchedulePreviewRequest": { "type": "object", "properties": { "rrule": { "type": "string", "nullable": true, "minLength": 1, "description": "A value representing the schedules iCal recurrence rule." } }, "required": [ "rrule" ] }, "ScheduleRequest": { "type": "object", "properties": { "rrule": { "type": "string", "nullable": true, "minLength": 1, "description": "A value representing the schedules iCal recurrence rule." }, "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "extra_data": { "default": {} }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "unified_job_template": { "type": "integer" }, "enabled": { "type": "boolean", "nullable": true, "default": true, "description": "Enables processing of this schedule." } }, "required": [ "name", "rrule", "unified_job_template" ] }, "ServiceRoleTeamAssignment": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date/time this resource was created." }, "created_by_ansible_id": { "type": "string", "format": "uuid", "nullable": true }, "object_id": { "type": "string", "nullable": true }, "object_ansible_id": { "type": "string", "nullable": true }, "content_type": { "type": "string", "description": "String to use for references to this type from other models in the API.", "readOnly": true }, "role_definition": { "type": "string", "description": "The name of this role." }, "team_ansible_id": { "type": "string", "format": "uuid" } }, "required": [ "role_definition", "team_ansible_id" ] }, "ServiceRoleTeamAssignmentRequest": { "type": "object", "properties": { "created_by_ansible_id": { "type": "string", "format": "uuid", "nullable": true }, "object_id": { "type": "string", "nullable": true }, "object_ansible_id": { "type": "string", "nullable": true }, "role_definition": { "type": "string", "minLength": 1, "description": "The name of this role." }, "team_ansible_id": { "type": "string", "format": "uuid" } }, "required": [ "role_definition", "team_ansible_id" ] }, "ServiceRoleUserAssignment": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date/time this resource was created." }, "created_by_ansible_id": { "type": "string", "format": "uuid", "nullable": true }, "object_id": { "type": "string", "nullable": true }, "object_ansible_id": { "type": "string", "nullable": true }, "content_type": { "type": "string", "description": "String to use for references to this type from other models in the API.", "readOnly": true }, "role_definition": { "type": "string", "description": "The name of this role." }, "user_ansible_id": { "type": "string", "format": "uuid" } }, "required": [ "role_definition", "user_ansible_id" ] }, "ServiceRoleUserAssignmentRequest": { "type": "object", "properties": { "created_by_ansible_id": { "type": "string", "format": "uuid", "nullable": true }, "object_id": { "type": "string", "nullable": true }, "object_ansible_id": { "type": "string", "nullable": true }, "role_definition": { "type": "string", "minLength": 1, "description": "The name of this role." }, "user_ansible_id": { "type": "string", "format": "uuid" } }, "required": [ "role_definition", "user_ansible_id" ] }, "SettingCategory": { "type": "object", "description": "Serialize setting category", "properties": { "url": { "type": "string", "readOnly": true }, "slug": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true } } }, "SettingSingleton": { "type": "object", "description": "Present a group of settings (by category) as a single object.", "properties": { "ACTIVITY_STREAM_ENABLED": { "type": "boolean", "default": true, "title": "Enable Activity Stream", "description": "Enable capturing activity for the activity stream." }, "ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC": { "type": "boolean", "default": false, "title": "Enable Activity Stream for Inventory Sync", "description": "Enable capturing activity for the activity stream when running inventory sync." }, "ORG_ADMINS_CAN_SEE_ALL_USERS": { "type": "boolean", "default": true, "title": "All Users Visible to Organization Admins", "description": "Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization." }, "MANAGE_ORGANIZATION_AUTH": { "type": "boolean", "default": true, "title": "Organization Admins Can Manage Users and Teams", "description": "Controls whether any Organization Admin has the privileges to create and manage users and teams." }, "TOWER_URL_BASE": { "type": "string", "default": "https://platformhost", "title": "Base URL of the service", "description": "This setting is used by services like notifications to render a valid url to the service.", "format": "uri" }, "REMOTE_HOST_HEADERS": { "type": "array", "items": { "type": "string" }, "default": [ "REMOTE_ADDR", "REMOTE_HOST" ], "description": "HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as \"HTTP_X_FORWARDED_FOR\", if behind a reverse proxy. See the \"Proxy Support\" section of the AAP Installation guide for more details." }, "PROXY_IP_ALLOWED_LIST": { "type": "array", "items": { "type": "string" }, "default": [], "description": "If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally')" }, "CSRF_TRUSTED_ORIGINS": { "type": "array", "items": { "type": "string" }, "default": [], "title": "CSRF Trusted Origins List", "description": "If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. " }, "LICENSE": { "type": "object", "additionalProperties": {}, "readOnly": true, "description": "The license controls which features and functionality are enabled. Use /api/v2/config/ to update or change the license." }, "REDHAT_USERNAME": { "type": "string", "default": "", "title": "Red Hat Client ID for Analytics", "description": "Client ID used to send data to Automation Analytics" }, "REDHAT_PASSWORD": { "type": "string", "default": "", "title": "Red Hat Client Secret for Analytics", "description": "Client secret used to send data to Automation Analytics" }, "SUBSCRIPTIONS_USERNAME": { "type": "string", "default": "", "title": "Red Hat Username for Subscriptions", "description": "Username used to retrieve subscription and content information" }, "SUBSCRIPTIONS_PASSWORD": { "type": "string", "default": "", "title": "Red Hat Password for Subscriptions", "description": "Password used to retrieve subscription and content information" }, "SUBSCRIPTIONS_CLIENT_ID": { "type": "string", "default": "", "title": "Red Hat Client ID for Subscriptions", "description": "Client ID used to retrieve subscription and content information" }, "SUBSCRIPTIONS_CLIENT_SECRET": { "type": "string", "default": "", "title": "Red Hat Client Secret for Subscriptions", "description": "Client secret used to retrieve subscription and content information" }, "AUTOMATION_ANALYTICS_URL": { "type": "string", "default": "https://example.com", "title": "Automation Analytics upload URL", "description": "This setting is used to to configure the upload URL for data collection for Automation Analytics.", "format": "uri" }, "AWX_ANALYTICS_CANDLEPIN_CA": { "type": "string", "default": "/etc/rhsm/ca/redhat-uep.pem", "title": "Candlepin CA Certificate Path", "description": "Path to the CA certificate file for verifying TLS connections to Candlepin. Leave blank to use system certificates." }, "AWX_ANALYTICS_CANDLEPIN_RENEWAL_THRESHOLD_DAYS": { "type": "integer", "minimum": 1, "default": 90, "title": "Candlepin Certificate Renewal Threshold", "description": "Number of days before certificate expiry to trigger automatic renewal of Candlepin identity certificates." }, "AWX_ANALYTICS_CANDLEPIN_PROXY_URL": { "type": "string", "default": "", "title": "Candlepin Proxy URL", "description": "HTTP/HTTPS proxy URL for Candlepin API requests (e.g., http://proxy.example.com:8080). Leave blank for no proxy." }, "INSTALL_UUID": { "type": "string", "readOnly": true, "default": "00000000-0000-0000-0000-000000000000", "title": "Unique identifier for an installation" }, "DEFAULT_CONTROL_PLANE_QUEUE_NAME": { "type": "string", "readOnly": true, "default": "controlplane", "title": "The instance group where control plane tasks run" }, "DEFAULT_EXECUTION_QUEUE_NAME": { "type": "string", "readOnly": true, "default": "default", "title": "The instance group where user jobs run (currently only on non-VM installs)" }, "DEFAULT_EXECUTION_ENVIRONMENT": { "type": "integer", "nullable": true, "title": "Global default execution environment", "description": "The Execution Environment to be used when one has not been configured for a job template." }, "CUSTOM_VENV_PATHS": { "type": "array", "items": { "type": "string" }, "default": [], "title": "Custom virtual environment paths", "description": "Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line." }, "AD_HOC_COMMANDS": { "type": "array", "items": { "type": "string" }, "default": [ "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" ], "title": "Ansible Modules Allowed for Ad Hoc Jobs", "description": "List of modules allowed to be used by ad-hoc jobs." }, "ALLOW_JINJA_IN_EXTRA_VARS": { "enum": [ "always", "never", "template" ], "type": "string", "x-spec-enum-id": "28bae37cee4f4fdb", "default": "template", "title": "When can extra variables contain Jinja templates?", "description": "Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to \"template\" or \"never\".\n\n* `always` - Always\n* `never` - Never\n* `template` - Only On Job Template Definitions" }, "INCLUDE_DEPRECATED_AWX_VAR_PREFIX": { "type": "boolean", "default": true, "title": "Include Deprecated AWX Variable Prefix", "description": "When enabled (default), auto-generated job variables are emitted with both the tower_ prefix and the deprecated awx_ prefix for backward compatibility. Disable to emit only tower_ prefixed variables and eliminate duplicates. The awx_ prefix is deprecated and this setting will default to False in a future release." }, "AWX_ISOLATION_BASE_PATH": { "type": "string", "default": "/tmp", "title": "Job execution path", "description": "The directory in which the service will create new temporary directories for job execution and isolation (such as credential files)." }, "AWX_ISOLATION_SHOW_PATHS": { "type": "array", "items": { "type": "string" }, "default": [], "title": "Paths to expose to isolated jobs", "description": "List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. " }, "AWX_TASK_ENV": { "type": "object", "additionalProperties": { "type": "string" }, "default": {}, "title": "Extra Environment Variables", "description": "Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending." }, "AWX_RUNNER_KEEPALIVE_SECONDS": { "type": "integer", "default": 0, "title": "K8S Ansible Runner Keep-Alive Message Interval", "description": "Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open." }, "GALAXY_TASK_ENV": { "type": "object", "additionalProperties": { "type": "string" }, "default": { "ANSIBLE_FORCE_COLOR": "false", "GIT_SSH_COMMAND": "ssh -o StrictHostKeyChecking=no" }, "title": "Environment Variables for Galaxy Commands", "description": "Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git." }, "INSIGHTS_TRACKING_STATE": { "type": "boolean", "default": false, "title": "Gather data for Automation Analytics", "description": "Enables the service to gather data on automation and send it to Automation Analytics." }, "PROJECT_UPDATE_VVV": { "type": "boolean", "default": false, "title": "Run Project Updates With Higher Verbosity", "description": "Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates." }, "AWX_ROLES_ENABLED": { "type": "boolean", "default": true, "title": "Enable Role Download", "description": "Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects." }, "AWX_COLLECTIONS_ENABLED": { "type": "boolean", "default": true, "title": "Enable Collection(s) Download", "description": "Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects." }, "AWX_SHOW_PLAYBOOK_LINKS": { "type": "boolean", "default": false, "title": "Follow symlinks", "description": "Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself." }, "AWX_MOUNT_ISOLATED_PATHS_ON_K8S": { "type": "boolean", "default": false, "title": "Expose host paths for Container Groups", "description": "Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. " }, "GALAXY_IGNORE_CERTS": { "type": "boolean", "default": false, "title": "Ignore Ansible Galaxy SSL Certificate Verification", "description": "If set to true, certificate validation will not be done when installing content from any Galaxy server." }, "STDOUT_MAX_BYTES_DISPLAY": { "type": "integer", "minimum": 0, "default": 1048576, "title": "Standard Output Maximum Display Size", "description": "Maximum Size of Standard Output in bytes to display before requiring the output be downloaded." }, "EVENT_STDOUT_MAX_BYTES_DISPLAY": { "type": "integer", "minimum": 0, "default": 1024, "title": "Job Event Standard Output Maximum Display Size", "description": "Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated." }, "MAX_WEBSOCKET_EVENT_RATE": { "type": "integer", "minimum": 0, "default": 30, "title": "Job Event Maximum Websocket Messages Per Second", "description": "Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit." }, "SCHEDULE_MAX_JOBS": { "type": "integer", "minimum": 1, "default": 10, "title": "Maximum Scheduled Jobs", "description": "Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created." }, "AWX_ANSIBLE_CALLBACK_PLUGINS": { "type": "array", "items": { "type": "string" }, "default": [], "title": "Ansible Callback Plugins", "description": "List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line." }, "DEFAULT_JOB_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this." }, "DEFAULT_JOB_IDLE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed." }, "DEFAULT_INVENTORY_UPDATE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this." }, "DEFAULT_PROJECT_UPDATE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this." }, "ANSIBLE_FACT_CACHE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "title": "Per-Host Ansible Fact Cache Timeout", "description": "Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed." }, "MAX_FORKS": { "type": "integer", "default": 200, "title": "Maximum number of forks per job", "description": "Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied." }, "LOG_AGGREGATOR_HOST": { "type": "string", "nullable": true, "title": "Logging Aggregator", "description": "Hostname/IP where external logs will be sent to." }, "LOG_AGGREGATOR_PORT": { "type": "integer", "nullable": true, "title": "Logging Aggregator Port", "description": "Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator)." }, "LOG_AGGREGATOR_TYPE": { "enum": [ "logstash", "splunk", "loggly", "sumologic", "other", null ], "type": "string", "x-spec-enum-id": "f7f9aae80827f128", "nullable": true, "title": "Logging Aggregator Type", "description": "Format messages for the chosen log aggregator.\n\n* `logstash` - logstash\n* `splunk` - splunk\n* `loggly` - loggly\n* `sumologic` - sumologic\n* `other` - other" }, "LOG_AGGREGATOR_USERNAME": { "type": "string", "default": "", "title": "Logging Aggregator Username", "description": "Username for external log aggregator (if required; HTTP/s only)." }, "LOG_AGGREGATOR_PASSWORD": { "type": "string", "default": "", "title": "Logging Aggregator Password/Token", "description": "Password or authentication token for external log aggregator (if required; HTTP/s only)." }, "LOG_AGGREGATOR_LOGGERS": { "type": "array", "items": { "type": "string" }, "default": [ "awx", "activity_stream", "job_events", "system_tracking", "broadcast_websocket", "job_lifecycle" ], "title": "Loggers Sending Data to Log Aggregator Form", "description": "List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\njob_lifecycle - logs related to processing of a job\n" }, "LOG_AGGREGATOR_INDIVIDUAL_FACTS": { "type": "boolean", "default": false, "title": "Log System Tracking Facts Individually", "description": "If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing." }, "LOG_AGGREGATOR_ENABLED": { "type": "boolean", "default": false, "title": "Enable External Logging", "description": "Enable sending logs to external log aggregator." }, "LOG_AGGREGATOR_TOWER_UUID": { "type": "string", "default": "", "title": "Cluster-wide unique identifier.", "description": "Useful to uniquely identify instances." }, "LOG_AGGREGATOR_PROTOCOL": { "enum": [ "https", "tcp", "udp" ], "type": "string", "x-spec-enum-id": "7d0c803b90b97cde", "default": "https", "title": "Logging Aggregator Protocol", "description": "Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname.\n\n* `https` - HTTPS/HTTP\n* `tcp` - TCP\n* `udp` - UDP" }, "LOG_AGGREGATOR_TCP_TIMEOUT": { "type": "integer", "default": 5, "title": "TCP Connection Timeout", "description": "Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols." }, "LOG_AGGREGATOR_VERIFY_CERT": { "type": "boolean", "default": true, "title": "Enable/disable HTTPS certificate verification", "description": "Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is \"https\". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection." }, "LOG_AGGREGATOR_LEVEL": { "enum": [ "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL" ], "type": "string", "x-spec-enum-id": "337bdbe45a1d1410", "default": "INFO", "title": "Logging Aggregator Level Threshold", "description": "Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting)\n\n* `DEBUG` - DEBUG\n* `INFO` - INFO\n* `WARNING` - WARNING\n* `ERROR` - ERROR\n* `CRITICAL` - CRITICAL" }, "LOG_AGGREGATOR_ACTION_QUEUE_SIZE": { "type": "integer", "minimum": 1, "default": 131072, "title": "Maximum number of messages that can be stored in the log action queue", "description": "Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5)." }, "LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB": { "type": "integer", "minimum": 1, "default": 1, "title": "Maximum disk persistence for rsyslogd action queuing (in GB)", "description": "Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH." }, "LOG_AGGREGATOR_MAX_DISK_USAGE_PATH": { "type": "string", "default": "/var/lib/awx", "title": "File system location for rsyslogd disk persistence", "description": "Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting." }, "LOG_AGGREGATOR_RSYSLOGD_DEBUG": { "type": "boolean", "default": false, "title": "Enable rsyslogd debugging", "description": "Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation." }, "API_400_ERROR_LOG_FORMAT": { "type": "string", "default": "status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}", "title": "Log Format For API 4XX Errors", "description": "The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {}." }, "AUTOMATION_ANALYTICS_LAST_GATHER": { "type": "string", "format": "date-time", "nullable": true, "title": "Last gather date for Automation Analytics." }, "AUTOMATION_ANALYTICS_LAST_ENTRIES": { "type": "string", "default": "", "title": "Last gathered entries from the data collection service of Automation Analytics" }, "AUTOMATION_ANALYTICS_GATHER_INTERVAL": { "type": "integer", "minimum": 1800, "default": 14400, "description": "Interval (in seconds) between data gathering." }, "CANDLEPIN_CONSUMER_UUID": { "type": "string", "default": "", "description": "UUID of the registered Candlepin consumer for this AAP instance." }, "CANDLEPIN_CERT_PEM": { "type": "string", "default": "", "title": "Candlepin Identity Certificate", "description": "PEM-encoded Candlepin identity certificate for mTLS authentication." }, "CANDLEPIN_KEY_PEM": { "type": "string", "default": "", "title": "Candlepin Identity Key", "description": "PEM-encoded private key for Candlepin identity certificate." }, "CANDLEPIN_SERIAL_NUMBER": { "type": "string", "default": "", "title": "Candlepin Certificate Serial Number", "description": "Serial number of the Candlepin identity certificate for tracking." }, "IS_K8S": { "type": "boolean", "readOnly": true, "default": false, "description": "Indicates whether the instance is part of a kubernetes-based deployment." }, "BULK_JOB_MAX_LAUNCH": { "type": "integer", "default": 100, "title": "Max jobs to allow bulk jobs to launch", "description": "Max jobs to allow bulk jobs to launch" }, "BULK_HOST_MAX_CREATE": { "type": "integer", "default": 100, "title": "Max number of hosts to allow to be created in a single bulk action", "description": "Max number of hosts to allow to be created in a single bulk action" }, "BULK_HOST_MAX_DELETE": { "type": "integer", "default": 250, "title": "Max number of hosts to allow to be deleted in a single bulk action", "description": "Max number of hosts to allow to be deleted in a single bulk action" }, "SUBSCRIPTION_USAGE_MODEL": { "enum": [ "", "unique_managed_hosts" ], "type": "string", "description": "* `` - No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n* `unique_managed_hosts` - Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes", "x-spec-enum-id": "f0cccba4fe8d04cb", "default": "", "title": "Defines subscription usage model and shows Host Metrics" }, "CLEANUP_HOST_METRICS_LAST_TS": { "type": "string", "format": "date-time", "nullable": true, "title": "Last cleanup date for HostMetrics" }, "HOST_METRIC_SUMMARY_TASK_LAST_TS": { "type": "string", "format": "date-time", "nullable": true, "title": "Last computing date of HostMetricSummaryMonthly" }, "AWX_CLEANUP_PATHS": { "type": "boolean", "default": true, "title": "Enable or Disable tmp dir cleanup", "description": "Enable or Disable TMP Dir cleanup" }, "AWX_REQUEST_PROFILE": { "type": "boolean", "default": false, "title": "Debug Web Requests", "description": "Debug web request python timing" }, "DEFAULT_CONTAINER_RUN_OPTIONS": { "type": "array", "items": { "type": "string" }, "default": [ "--network", "slirp4netns:enable_ipv6=true" ], "title": "Container Run Options", "description": "List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug']" }, "RECEPTOR_RELEASE_WORK": { "type": "boolean", "default": true, "title": "Release Receptor Work", "description": "Release receptor work" }, "RECEPTOR_KEEP_WORK_ON_ERROR": { "type": "boolean", "default": false, "title": "Keep receptor work on error", "description": "Prevent receptor work from being released on when error is detected" }, "OPA_HOST": { "type": "string", "default": "", "title": "OPA server hostname", "description": "The hostname used to connect to the OPA server. If empty, policy enforcement will be disabled." }, "OPA_PORT": { "type": "integer", "default": 8181, "title": "OPA server port", "description": "The port used to connect to the OPA server. Defaults to 8181." }, "OPA_SSL": { "type": "boolean", "default": false, "title": "Use SSL for OPA connection", "description": "Enable or disable the use of SSL to connect to the OPA server. Defaults to false." }, "OPA_AUTH_TYPE": { "enum": [ "None", "Token", "Certificate" ], "type": "string", "x-spec-enum-id": "831ccaccafb11069", "default": "None", "title": "OPA authentication type", "description": "The authentication type that will be used to connect to the OPA server: \"None\", \"Token\", or \"Certificate\".\n\n* `None` - None\n* `Token` - Token\n* `Certificate` - Certificate" }, "OPA_AUTH_TOKEN": { "type": "string", "default": "", "title": "OPA authentication token", "description": "The token for authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Token\". If an authorization header is defined in OPA_AUTH_CUSTOM_HEADERS, it will be overridden by OPA_AUTH_TOKEN." }, "OPA_AUTH_CLIENT_CERT": { "type": "string", "default": "", "title": "OPA client certificate content", "description": "The content of the client certificate file for mTLS authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Certificate\"." }, "OPA_AUTH_CLIENT_KEY": { "type": "string", "default": "", "title": "OPA client key content", "description": "The content of the client key for mTLS authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Certificate\"." }, "OPA_AUTH_CA_CERT": { "type": "string", "default": "", "title": "OPA CA certificate content", "description": "The content of the CA certificate for mTLS authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Certificate\"." }, "OPA_AUTH_CUSTOM_HEADERS": { "type": "object", "additionalProperties": {}, "default": {}, "title": "OPA custom authentication headers", "description": "Optional custom headers included in requests to the OPA server. Defaults to empty dictionary ({})." }, "OPA_REQUEST_TIMEOUT": { "type": "number", "format": "double", "default": 1.5, "description": "The number of seconds after which the connection to the OPA server will time out. Defaults to 1.5 seconds." }, "OPA_REQUEST_RETRIES": { "type": "integer", "default": 2, "title": "OPA request retry count", "description": "The number of retry attempts for connecting to the OPA server. Default is 2." }, "SESSION_COOKIE_AGE": { "type": "integer", "maximum": 30000000000, "minimum": 60, "format": "int64", "default": 1800, "title": "Idle Time Force Log Out", "description": "Number of seconds that a user is inactive before they will need to login again." }, "SESSIONS_PER_USER": { "type": "integer", "minimum": -1, "default": -1, "title": "Maximum number of simultaneous logged in sessions", "description": "Maximum number of simultaneous logged in sessions a user may have. To disable enter -1." }, "DISABLE_LOCAL_AUTH": { "type": "boolean", "default": false, "title": "Disable the built-in authentication system", "description": "Controls whether users are prevented from using the built-in authentication system. " }, "AUTH_BASIC_ENABLED": { "type": "boolean", "default": true, "title": "Enable HTTP Basic Auth", "description": "Enable HTTP Basic Auth for the API Browser." }, "LOGIN_REDIRECT_OVERRIDE": { "type": "string", "default": "", "title": "Login redirect override URL", "description": "URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page." }, "ALLOW_METRICS_FOR_ANONYMOUS_USERS": { "type": "boolean", "default": false, "title": "Allow anonymous users to poll metrics", "description": "If true, anonymous users are allowed to poll metrics." }, "PENDO_TRACKING_STATE": { "enum": [ "off", "anonymous", "detailed" ], "type": "string", "x-spec-enum-id": "ba14e559ac551020", "readOnly": true, "default": "off", "title": "User Analytics Tracking State", "description": "Enable or Disable User Analytics Tracking.\n\n* `off` - Off\n* `anonymous` - Anonymous\n* `detailed` - Detailed" }, "CUSTOM_LOGIN_INFO": { "type": "string", "default": "", "description": "If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported." }, "CUSTOM_LOGO": { "type": "string", "default": "", "description": "To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported." }, "MAX_UI_JOB_EVENTS": { "type": "integer", "minimum": 100, "default": 4000, "title": "Max Job Events Retrieved by UI", "description": "Maximum number of job events for the UI to retrieve within a single request." }, "UI_LIVE_UPDATES_ENABLED": { "type": "boolean", "default": true, "title": "Enable Live Updates in the UI", "description": "If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details." }, "NAMED_URL_FORMATS": { "type": "object", "additionalProperties": {}, "readOnly": true, "default": { "execution_environments": "", "organizations": "", "teams": "++", "credential_types": "+", "credentials": "+++++", "notification_templates": "++", "job_templates": "++", "projects": "++", "inventories": "++", "hosts": "++++", "groups": "++++", "inventory_sources": "++++", "instance_groups": "", "workflow_job_templates": "++", "workflow_job_template_nodes": "++++", "labels": "++", "users": "", "instances": "" }, "title": "Formats of all available named urls", "description": "Read-only list of key-value pairs that shows the standard format of all available named URLs." }, "NAMED_URL_GRAPH_NODES": { "type": "object", "additionalProperties": {}, "readOnly": true, "default": { "execution_environments": { "fields": [ "name" ], "adj_list": [] }, "organizations": { "fields": [ "name" ], "adj_list": [] }, "teams": { "fields": [ "name" ], "adj_list": [ [ "organization", "organizations" ] ] }, "credential_types": { "fields": [ "name", "kind" ], "adj_list": [] }, "credentials": { "fields": [ "name" ], "adj_list": [ [ "credential_type", "credential_types" ], [ "organization", "organizations" ] ] }, "notification_templates": { "fields": [ "name" ], "adj_list": [ [ "organization", "organizations" ] ] }, "job_templates": { "fields": [ "name" ], "adj_list": [ [ "organization", "organizations" ] ] }, "projects": { "fields": [ "name" ], "adj_list": [ [ "organization", "organizations" ] ] }, "inventories": { "fields": [ "name" ], "adj_list": [ [ "organization", "organizations" ] ] }, "hosts": { "fields": [ "name" ], "adj_list": [ [ "inventory", "inventories" ] ] }, "groups": { "fields": [ "name" ], "adj_list": [ [ "inventory", "inventories" ] ] }, "inventory_sources": { "fields": [ "name" ], "adj_list": [ [ "inventory", "inventories" ] ] }, "instance_groups": { "fields": [ "name" ], "adj_list": [] }, "workflow_job_templates": { "fields": [ "name" ], "adj_list": [ [ "organization", "organizations" ] ] }, "workflow_job_template_nodes": { "fields": [ "identifier" ], "adj_list": [ [ "workflow_job_template", "workflow_job_templates" ] ] }, "labels": { "fields": [ "name" ], "adj_list": [ [ "organization", "organizations" ] ] }, "users": { "fields": [ "username" ], "adj_list": [] }, "instances": { "fields": [ "hostname" ], "adj_list": [] } }, "title": "List of all named url graph nodes.", "description": "Read-only list of key-value pairs that exposes named URL graph topology. Use this list to programmatically generate named URLs for resources" } } }, "SettingSingletonRequest": { "type": "object", "description": "Present a group of settings (by category) as a single object.", "properties": { "ACTIVITY_STREAM_ENABLED": { "type": "boolean", "default": true, "title": "Enable Activity Stream", "description": "Enable capturing activity for the activity stream." }, "ACTIVITY_STREAM_ENABLED_FOR_INVENTORY_SYNC": { "type": "boolean", "default": false, "title": "Enable Activity Stream for Inventory Sync", "description": "Enable capturing activity for the activity stream when running inventory sync." }, "ORG_ADMINS_CAN_SEE_ALL_USERS": { "type": "boolean", "default": true, "title": "All Users Visible to Organization Admins", "description": "Controls whether any Organization Admin can view all users and teams, even those not associated with their Organization." }, "MANAGE_ORGANIZATION_AUTH": { "type": "boolean", "default": true, "title": "Organization Admins Can Manage Users and Teams", "description": "Controls whether any Organization Admin has the privileges to create and manage users and teams." }, "TOWER_URL_BASE": { "type": "string", "minLength": 1, "default": "https://platformhost", "title": "Base URL of the service", "description": "This setting is used by services like notifications to render a valid url to the service.", "format": "uri" }, "REMOTE_HOST_HEADERS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "REMOTE_ADDR", "REMOTE_HOST" ], "description": "HTTP headers and meta keys to search to determine remote host name or IP. Add additional items to this list, such as \"HTTP_X_FORWARDED_FOR\", if behind a reverse proxy. See the \"Proxy Support\" section of the AAP Installation guide for more details." }, "PROXY_IP_ALLOWED_LIST": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [], "description": "If the service is behind a reverse proxy/load balancer, use this setting to configure the proxy IP addresses from which the service should trust custom REMOTE_HOST_HEADERS header values. If this setting is an empty list (the default), the headers specified by REMOTE_HOST_HEADERS will be trusted unconditionally')" }, "CSRF_TRUSTED_ORIGINS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [], "title": "CSRF Trusted Origins List", "description": "If the service is behind a reverse proxy/load balancer, use this setting to configure the schema://addresses from which the service should trust Origin header values. " }, "REDHAT_USERNAME": { "type": "string", "default": "", "title": "Red Hat Client ID for Analytics", "description": "Client ID used to send data to Automation Analytics" }, "REDHAT_PASSWORD": { "type": "string", "default": "", "title": "Red Hat Client Secret for Analytics", "description": "Client secret used to send data to Automation Analytics" }, "SUBSCRIPTIONS_USERNAME": { "type": "string", "default": "", "title": "Red Hat Username for Subscriptions", "description": "Username used to retrieve subscription and content information" }, "SUBSCRIPTIONS_PASSWORD": { "type": "string", "default": "", "title": "Red Hat Password for Subscriptions", "description": "Password used to retrieve subscription and content information" }, "SUBSCRIPTIONS_CLIENT_ID": { "type": "string", "default": "", "title": "Red Hat Client ID for Subscriptions", "description": "Client ID used to retrieve subscription and content information" }, "SUBSCRIPTIONS_CLIENT_SECRET": { "type": "string", "default": "", "title": "Red Hat Client Secret for Subscriptions", "description": "Client secret used to retrieve subscription and content information" }, "AUTOMATION_ANALYTICS_URL": { "type": "string", "minLength": 1, "default": "https://example.com", "title": "Automation Analytics upload URL", "description": "This setting is used to to configure the upload URL for data collection for Automation Analytics.", "format": "uri" }, "AWX_ANALYTICS_CANDLEPIN_CA": { "type": "string", "default": "/etc/rhsm/ca/redhat-uep.pem", "title": "Candlepin CA Certificate Path", "description": "Path to the CA certificate file for verifying TLS connections to Candlepin. Leave blank to use system certificates." }, "AWX_ANALYTICS_CANDLEPIN_RENEWAL_THRESHOLD_DAYS": { "type": "integer", "minimum": 1, "default": 90, "title": "Candlepin Certificate Renewal Threshold", "description": "Number of days before certificate expiry to trigger automatic renewal of Candlepin identity certificates." }, "AWX_ANALYTICS_CANDLEPIN_PROXY_URL": { "type": "string", "default": "", "title": "Candlepin Proxy URL", "description": "HTTP/HTTPS proxy URL for Candlepin API requests (e.g., http://proxy.example.com:8080). Leave blank for no proxy." }, "DEFAULT_EXECUTION_ENVIRONMENT": { "type": "integer", "nullable": true, "title": "Global default execution environment", "description": "The Execution Environment to be used when one has not been configured for a job template." }, "CUSTOM_VENV_PATHS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [], "title": "Custom virtual environment paths", "description": "Paths where Tower will look for custom virtual environments (in addition to /var/lib/awx/venv/). Enter one path per line." }, "AD_HOC_COMMANDS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "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" ], "title": "Ansible Modules Allowed for Ad Hoc Jobs", "description": "List of modules allowed to be used by ad-hoc jobs." }, "ALLOW_JINJA_IN_EXTRA_VARS": { "enum": [ "always", "never", "template" ], "type": "string", "x-spec-enum-id": "28bae37cee4f4fdb", "default": "template", "title": "When can extra variables contain Jinja templates?", "description": "Ansible allows variable substitution via the Jinja2 templating language for --extra-vars. This poses a potential security risk where users with the ability to specify extra vars at job launch time can use Jinja2 templates to run arbitrary Python. It is recommended that this value be set to \"template\" or \"never\".\n\n* `always` - Always\n* `never` - Never\n* `template` - Only On Job Template Definitions" }, "INCLUDE_DEPRECATED_AWX_VAR_PREFIX": { "type": "boolean", "default": true, "title": "Include Deprecated AWX Variable Prefix", "description": "When enabled (default), auto-generated job variables are emitted with both the tower_ prefix and the deprecated awx_ prefix for backward compatibility. Disable to emit only tower_ prefixed variables and eliminate duplicates. The awx_ prefix is deprecated and this setting will default to False in a future release." }, "AWX_ISOLATION_BASE_PATH": { "type": "string", "minLength": 1, "default": "/tmp", "title": "Job execution path", "description": "The directory in which the service will create new temporary directories for job execution and isolation (such as credential files)." }, "AWX_ISOLATION_SHOW_PATHS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [], "title": "Paths to expose to isolated jobs", "description": "List of paths that would otherwise be hidden to expose to isolated jobs. Enter one path per line. Volumes will be mounted from the execution node to the container. The supported format is HOST-DIR[:CONTAINER-DIR[:OPTIONS]]. " }, "AWX_TASK_ENV": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "default": {}, "title": "Extra Environment Variables", "description": "Additional environment variables set for playbook runs, inventory updates, project updates, and notification sending." }, "AWX_RUNNER_KEEPALIVE_SECONDS": { "type": "integer", "default": 0, "title": "K8S Ansible Runner Keep-Alive Message Interval", "description": "Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open." }, "GALAXY_TASK_ENV": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "default": { "ANSIBLE_FORCE_COLOR": "false", "GIT_SSH_COMMAND": "ssh -o StrictHostKeyChecking=no" }, "title": "Environment Variables for Galaxy Commands", "description": "Additional environment variables set for invocations of ansible-galaxy within project updates. Useful if you must use a proxy server for ansible-galaxy but not git." }, "INSIGHTS_TRACKING_STATE": { "type": "boolean", "default": false, "title": "Gather data for Automation Analytics", "description": "Enables the service to gather data on automation and send it to Automation Analytics." }, "PROJECT_UPDATE_VVV": { "type": "boolean", "default": false, "title": "Run Project Updates With Higher Verbosity", "description": "Adds the CLI -vvv flag to ansible-playbook runs of project_update.yml used for project updates." }, "AWX_ROLES_ENABLED": { "type": "boolean", "default": true, "title": "Enable Role Download", "description": "Allows roles to be dynamically downloaded from a requirements.yml file for SCM projects." }, "AWX_COLLECTIONS_ENABLED": { "type": "boolean", "default": true, "title": "Enable Collection(s) Download", "description": "Allows collections to be dynamically downloaded from a requirements.yml file for SCM projects." }, "AWX_SHOW_PLAYBOOK_LINKS": { "type": "boolean", "default": false, "title": "Follow symlinks", "description": "Follow symbolic links when scanning for playbooks. Be aware that setting this to True can lead to infinite recursion if a link points to a parent directory of itself." }, "AWX_MOUNT_ISOLATED_PATHS_ON_K8S": { "type": "boolean", "default": false, "title": "Expose host paths for Container Groups", "description": "Expose paths via hostPath for the Pods created by a Container Group. HostPath volumes present many security risks, and it is a best practice to avoid the use of HostPaths when possible. " }, "GALAXY_IGNORE_CERTS": { "type": "boolean", "default": false, "title": "Ignore Ansible Galaxy SSL Certificate Verification", "description": "If set to true, certificate validation will not be done when installing content from any Galaxy server." }, "STDOUT_MAX_BYTES_DISPLAY": { "type": "integer", "minimum": 0, "default": 1048576, "title": "Standard Output Maximum Display Size", "description": "Maximum Size of Standard Output in bytes to display before requiring the output be downloaded." }, "EVENT_STDOUT_MAX_BYTES_DISPLAY": { "type": "integer", "minimum": 0, "default": 1024, "title": "Job Event Standard Output Maximum Display Size", "description": "Maximum Size of Standard Output in bytes to display for a single job or ad hoc command event. `stdout` will end with `…` when truncated." }, "MAX_WEBSOCKET_EVENT_RATE": { "type": "integer", "minimum": 0, "default": 30, "title": "Job Event Maximum Websocket Messages Per Second", "description": "Maximum number of messages to update the UI live job output with per second. Value of 0 means no limit." }, "SCHEDULE_MAX_JOBS": { "type": "integer", "minimum": 1, "default": 10, "title": "Maximum Scheduled Jobs", "description": "Maximum number of the same job template that can be waiting to run when launching from a schedule before no more are created." }, "AWX_ANSIBLE_CALLBACK_PLUGINS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [], "title": "Ansible Callback Plugins", "description": "List of paths to search for extra callback plugins to be used when running jobs. Enter one path per line." }, "DEFAULT_JOB_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum time in seconds to allow jobs to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual job template will override this." }, "DEFAULT_JOB_IDLE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "If no output is detected from ansible in this number of seconds the execution will be terminated. Use value of 0 to indicate that no idle timeout should be imposed." }, "DEFAULT_INVENTORY_UPDATE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum time in seconds to allow inventory updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual inventory source will override this." }, "DEFAULT_PROJECT_UPDATE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum time in seconds to allow project updates to run. Use value of 0 to indicate that no timeout should be imposed. A timeout set on an individual project will override this." }, "ANSIBLE_FACT_CACHE_TIMEOUT": { "type": "integer", "minimum": 0, "default": 0, "title": "Per-Host Ansible Fact Cache Timeout", "description": "Maximum time, in seconds, that stored Ansible facts are considered valid since the last time they were modified. Only valid, non-stale, facts will be accessible by a playbook. Note, this does not influence the deletion of ansible_facts from the database. Use a value of 0 to indicate that no timeout should be imposed." }, "MAX_FORKS": { "type": "integer", "default": 200, "title": "Maximum number of forks per job", "description": "Saving a Job Template with more than this number of forks will result in an error. When set to 0, no limit is applied." }, "LOG_AGGREGATOR_HOST": { "type": "string", "nullable": true, "minLength": 1, "title": "Logging Aggregator", "description": "Hostname/IP where external logs will be sent to." }, "LOG_AGGREGATOR_PORT": { "type": "integer", "nullable": true, "title": "Logging Aggregator Port", "description": "Port on Logging Aggregator to send logs to (if required and not provided in Logging Aggregator)." }, "LOG_AGGREGATOR_TYPE": { "enum": [ "logstash", "splunk", "loggly", "sumologic", "other", null ], "type": "string", "x-spec-enum-id": "f7f9aae80827f128", "nullable": true, "title": "Logging Aggregator Type", "description": "Format messages for the chosen log aggregator.\n\n* `logstash` - logstash\n* `splunk` - splunk\n* `loggly` - loggly\n* `sumologic` - sumologic\n* `other` - other" }, "LOG_AGGREGATOR_USERNAME": { "type": "string", "default": "", "title": "Logging Aggregator Username", "description": "Username for external log aggregator (if required; HTTP/s only)." }, "LOG_AGGREGATOR_PASSWORD": { "type": "string", "default": "", "title": "Logging Aggregator Password/Token", "description": "Password or authentication token for external log aggregator (if required; HTTP/s only)." }, "LOG_AGGREGATOR_LOGGERS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "awx", "activity_stream", "job_events", "system_tracking", "broadcast_websocket", "job_lifecycle" ], "title": "Loggers Sending Data to Log Aggregator Form", "description": "List of loggers that will send HTTP logs to the collector, these can include any or all of: \nawx - service logs\nactivity_stream - activity stream records\njob_events - callback data from Ansible job events\nsystem_tracking - facts gathered from scan jobs\nbroadcast_websocket - errors pertaining to websockets broadcast metrics\njob_lifecycle - logs related to processing of a job\n" }, "LOG_AGGREGATOR_INDIVIDUAL_FACTS": { "type": "boolean", "default": false, "title": "Log System Tracking Facts Individually", "description": "If set, system tracking facts will be sent for each package, service, or other item found in a scan, allowing for greater search query granularity. If unset, facts will be sent as a single dictionary, allowing for greater efficiency in fact processing." }, "LOG_AGGREGATOR_ENABLED": { "type": "boolean", "default": false, "title": "Enable External Logging", "description": "Enable sending logs to external log aggregator." }, "LOG_AGGREGATOR_TOWER_UUID": { "type": "string", "default": "", "title": "Cluster-wide unique identifier.", "description": "Useful to uniquely identify instances." }, "LOG_AGGREGATOR_PROTOCOL": { "enum": [ "https", "tcp", "udp" ], "type": "string", "x-spec-enum-id": "7d0c803b90b97cde", "default": "https", "title": "Logging Aggregator Protocol", "description": "Protocol used to communicate with log aggregator. HTTPS/HTTP assumes HTTPS unless http:// is explicitly used in the Logging Aggregator hostname.\n\n* `https` - HTTPS/HTTP\n* `tcp` - TCP\n* `udp` - UDP" }, "LOG_AGGREGATOR_TCP_TIMEOUT": { "type": "integer", "default": 5, "title": "TCP Connection Timeout", "description": "Number of seconds for a TCP connection to external log aggregator to timeout. Applies to HTTPS and TCP log aggregator protocols." }, "LOG_AGGREGATOR_VERIFY_CERT": { "type": "boolean", "default": true, "title": "Enable/disable HTTPS certificate verification", "description": "Flag to control enable/disable of certificate verification when LOG_AGGREGATOR_PROTOCOL is \"https\". If enabled, the log handler will verify certificate sent by external log aggregator before establishing connection." }, "LOG_AGGREGATOR_LEVEL": { "enum": [ "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL" ], "type": "string", "x-spec-enum-id": "337bdbe45a1d1410", "default": "INFO", "title": "Logging Aggregator Level Threshold", "description": "Level threshold used by log handler. Severities from lowest to highest are DEBUG, INFO, WARNING, ERROR, CRITICAL. Messages less severe than the threshold will be ignored by log handler. (messages under category awx.anlytics ignore this setting)\n\n* `DEBUG` - DEBUG\n* `INFO` - INFO\n* `WARNING` - WARNING\n* `ERROR` - ERROR\n* `CRITICAL` - CRITICAL" }, "LOG_AGGREGATOR_ACTION_QUEUE_SIZE": { "type": "integer", "minimum": 1, "default": 131072, "title": "Maximum number of messages that can be stored in the log action queue", "description": "Defines how large the rsyslog action queue can grow in number of messages stored. This can have an impact on memory utilization. When the queue reaches 75% of this number, the queue will start writing to disk (queue.highWatermark in rsyslog). When it reaches 90%, NOTICE, INFO, and DEBUG messages will start to be discarded (queue.discardMark with queue.discardSeverity=5)." }, "LOG_AGGREGATOR_ACTION_MAX_DISK_USAGE_GB": { "type": "integer", "minimum": 1, "default": 1, "title": "Maximum disk persistence for rsyslogd action queuing (in GB)", "description": "Amount of data to store (in gigabytes) if an rsyslog action takes time to process an incoming message (defaults to 1). Equivalent to the rsyslogd queue.maxdiskspace setting on the action (e.g. omhttp). It stores files in the directory specified by LOG_AGGREGATOR_MAX_DISK_USAGE_PATH." }, "LOG_AGGREGATOR_MAX_DISK_USAGE_PATH": { "type": "string", "minLength": 1, "default": "/var/lib/awx", "title": "File system location for rsyslogd disk persistence", "description": "Location to persist logs that should be retried after an outage of the external log aggregator (defaults to /var/lib/awx). Equivalent to the rsyslogd queue.spoolDirectory setting." }, "LOG_AGGREGATOR_RSYSLOGD_DEBUG": { "type": "boolean", "default": false, "title": "Enable rsyslogd debugging", "description": "Enabled high verbosity debugging for rsyslogd. Useful for debugging connection issues for external log aggregation." }, "API_400_ERROR_LOG_FORMAT": { "type": "string", "minLength": 1, "default": "status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr}", "title": "Log Format For API 4XX Errors", "description": "The format of logged messages when an API 4XX error occurs, the following variables will be substituted: \nstatus_code - The HTTP status code of the error\nuser_name - The user name attempting to use the API\nurl_path - The URL path to the API endpoint called\nremote_addr - The remote address seen for the user\nerror - The error set by the api endpoint\nVariables need to be in the format {}." }, "AUTOMATION_ANALYTICS_LAST_GATHER": { "type": "string", "format": "date-time", "nullable": true, "title": "Last gather date for Automation Analytics." }, "AUTOMATION_ANALYTICS_LAST_ENTRIES": { "type": "string", "default": "", "title": "Last gathered entries from the data collection service of Automation Analytics" }, "AUTOMATION_ANALYTICS_GATHER_INTERVAL": { "type": "integer", "minimum": 1800, "default": 14400, "description": "Interval (in seconds) between data gathering." }, "CANDLEPIN_CONSUMER_UUID": { "type": "string", "default": "", "description": "UUID of the registered Candlepin consumer for this AAP instance." }, "CANDLEPIN_CERT_PEM": { "type": "string", "default": "", "title": "Candlepin Identity Certificate", "description": "PEM-encoded Candlepin identity certificate for mTLS authentication." }, "CANDLEPIN_KEY_PEM": { "type": "string", "default": "", "title": "Candlepin Identity Key", "description": "PEM-encoded private key for Candlepin identity certificate." }, "CANDLEPIN_SERIAL_NUMBER": { "type": "string", "default": "", "title": "Candlepin Certificate Serial Number", "description": "Serial number of the Candlepin identity certificate for tracking." }, "BULK_JOB_MAX_LAUNCH": { "type": "integer", "default": 100, "title": "Max jobs to allow bulk jobs to launch", "description": "Max jobs to allow bulk jobs to launch" }, "BULK_HOST_MAX_CREATE": { "type": "integer", "default": 100, "title": "Max number of hosts to allow to be created in a single bulk action", "description": "Max number of hosts to allow to be created in a single bulk action" }, "BULK_HOST_MAX_DELETE": { "type": "integer", "default": 250, "title": "Max number of hosts to allow to be deleted in a single bulk action", "description": "Max number of hosts to allow to be deleted in a single bulk action" }, "SUBSCRIPTION_USAGE_MODEL": { "enum": [ "", "unique_managed_hosts" ], "type": "string", "description": "* `` - No subscription. Deletion of host_metrics will not be considered for purposes of managed host counting\n* `unique_managed_hosts` - Usage based on unique managed nodes in a large historical time frame and delete functionality for no longer used managed nodes", "x-spec-enum-id": "f0cccba4fe8d04cb", "default": "", "title": "Defines subscription usage model and shows Host Metrics" }, "CLEANUP_HOST_METRICS_LAST_TS": { "type": "string", "format": "date-time", "nullable": true, "title": "Last cleanup date for HostMetrics" }, "HOST_METRIC_SUMMARY_TASK_LAST_TS": { "type": "string", "format": "date-time", "nullable": true, "title": "Last computing date of HostMetricSummaryMonthly" }, "AWX_CLEANUP_PATHS": { "type": "boolean", "default": true, "title": "Enable or Disable tmp dir cleanup", "description": "Enable or Disable TMP Dir cleanup" }, "AWX_REQUEST_PROFILE": { "type": "boolean", "default": false, "title": "Debug Web Requests", "description": "Debug web request python timing" }, "DEFAULT_CONTAINER_RUN_OPTIONS": { "type": "array", "items": { "type": "string", "minLength": 1 }, "default": [ "--network", "slirp4netns:enable_ipv6=true" ], "title": "Container Run Options", "description": "List of options to pass to podman run example: ['--network', 'slirp4netns:enable_ipv6=true', '--log-level', 'debug']" }, "RECEPTOR_RELEASE_WORK": { "type": "boolean", "default": true, "title": "Release Receptor Work", "description": "Release receptor work" }, "RECEPTOR_KEEP_WORK_ON_ERROR": { "type": "boolean", "default": false, "title": "Keep receptor work on error", "description": "Prevent receptor work from being released on when error is detected" }, "OPA_HOST": { "type": "string", "default": "", "title": "OPA server hostname", "description": "The hostname used to connect to the OPA server. If empty, policy enforcement will be disabled." }, "OPA_PORT": { "type": "integer", "default": 8181, "title": "OPA server port", "description": "The port used to connect to the OPA server. Defaults to 8181." }, "OPA_SSL": { "type": "boolean", "default": false, "title": "Use SSL for OPA connection", "description": "Enable or disable the use of SSL to connect to the OPA server. Defaults to false." }, "OPA_AUTH_TYPE": { "enum": [ "None", "Token", "Certificate" ], "type": "string", "x-spec-enum-id": "831ccaccafb11069", "default": "None", "title": "OPA authentication type", "description": "The authentication type that will be used to connect to the OPA server: \"None\", \"Token\", or \"Certificate\".\n\n* `None` - None\n* `Token` - Token\n* `Certificate` - Certificate" }, "OPA_AUTH_TOKEN": { "type": "string", "default": "", "title": "OPA authentication token", "description": "The token for authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Token\". If an authorization header is defined in OPA_AUTH_CUSTOM_HEADERS, it will be overridden by OPA_AUTH_TOKEN." }, "OPA_AUTH_CLIENT_CERT": { "type": "string", "default": "", "title": "OPA client certificate content", "description": "The content of the client certificate file for mTLS authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Certificate\"." }, "OPA_AUTH_CLIENT_KEY": { "type": "string", "default": "", "title": "OPA client key content", "description": "The content of the client key for mTLS authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Certificate\"." }, "OPA_AUTH_CA_CERT": { "type": "string", "default": "", "title": "OPA CA certificate content", "description": "The content of the CA certificate for mTLS authentication to the OPA server. Required when OPA_AUTH_TYPE is \"Certificate\"." }, "OPA_AUTH_CUSTOM_HEADERS": { "type": "object", "additionalProperties": {}, "default": {}, "title": "OPA custom authentication headers", "description": "Optional custom headers included in requests to the OPA server. Defaults to empty dictionary ({})." }, "OPA_REQUEST_TIMEOUT": { "type": "number", "format": "double", "default": 1.5, "description": "The number of seconds after which the connection to the OPA server will time out. Defaults to 1.5 seconds." }, "OPA_REQUEST_RETRIES": { "type": "integer", "default": 2, "title": "OPA request retry count", "description": "The number of retry attempts for connecting to the OPA server. Default is 2." }, "SESSION_COOKIE_AGE": { "type": "integer", "maximum": 30000000000, "minimum": 60, "format": "int64", "default": 1800, "title": "Idle Time Force Log Out", "description": "Number of seconds that a user is inactive before they will need to login again." }, "SESSIONS_PER_USER": { "type": "integer", "minimum": -1, "default": -1, "title": "Maximum number of simultaneous logged in sessions", "description": "Maximum number of simultaneous logged in sessions a user may have. To disable enter -1." }, "DISABLE_LOCAL_AUTH": { "type": "boolean", "default": false, "title": "Disable the built-in authentication system", "description": "Controls whether users are prevented from using the built-in authentication system. " }, "AUTH_BASIC_ENABLED": { "type": "boolean", "default": true, "title": "Enable HTTP Basic Auth", "description": "Enable HTTP Basic Auth for the API Browser." }, "LOGIN_REDIRECT_OVERRIDE": { "type": "string", "default": "", "title": "Login redirect override URL", "description": "URL to which unauthorized users will be redirected to log in. If blank, users will be sent to the login page." }, "ALLOW_METRICS_FOR_ANONYMOUS_USERS": { "type": "boolean", "default": false, "title": "Allow anonymous users to poll metrics", "description": "If true, anonymous users are allowed to poll metrics." }, "CUSTOM_LOGIN_INFO": { "type": "string", "default": "", "description": "If needed, you can add specific information (such as a legal notice or a disclaimer) to a text box in the login modal using this setting. Any content added must be in plain text or an HTML fragment, as other markup languages are not supported." }, "CUSTOM_LOGO": { "type": "string", "default": "", "description": "To set up a custom logo, provide a file that you create. For the custom logo to look its best, use a .png file with a transparent background. GIF, PNG and JPEG formats are supported." }, "MAX_UI_JOB_EVENTS": { "type": "integer", "minimum": 100, "default": 4000, "title": "Max Job Events Retrieved by UI", "description": "Maximum number of job events for the UI to retrieve within a single request." }, "UI_LIVE_UPDATES_ENABLED": { "type": "boolean", "default": true, "title": "Enable Live Updates in the UI", "description": "If disabled, the page will not refresh when events are received. Reloading the page will be required to get the latest details." } } }, "SystemJob": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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_args": { "type": "string", "readOnly": true }, "job_cwd": { "type": "string", "readOnly": true }, "job_env": { "readOnly": true }, "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." }, "result_traceback": { "type": "string", "readOnly": true }, "event_processing_finished": { "type": "boolean", "readOnly": true, "description": "Indicates whether all of the events generated by this unified job have been saved to the database." }, "launched_by": { "type": "string", "readOnly": true }, "work_unit_id": { "type": "string", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "system_job_template": { "type": "integer", "nullable": true }, "job_type": { "enum": [ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "", null ], "type": "string", "description": "* `cleanup_jobs` - Remove jobs older than a certain number of days\n* `cleanup_activitystream` - Remove activity stream entries older than a certain number of days\n* `cleanup_sessions` - Removes expired browser sessions from the database", "x-spec-enum-id": "c3fb7965187f07c2", "nullable": true, "default": "" }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "result_stdout": { "type": "string", "readOnly": true } }, "required": [ "name" ] }, "SystemJobCancel": { "type": "object", "properties": { "can_cancel": { "type": "boolean", "readOnly": true } } }, "SystemJobEvent": { "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 }, "event": { "type": "string", "readOnly": true }, "counter": { "type": "integer", "minimum": 0, "readOnly": true }, "event_display": { "type": "string", "readOnly": true }, "event_data": { "default": {} }, "failed": { "type": "string", "readOnly": true }, "changed": { "type": "string", "readOnly": true }, "uuid": { "type": "string", "readOnly": true }, "stdout": { "type": "string", "readOnly": true }, "start_line": { "type": "integer", "minimum": 0, "readOnly": true }, "end_line": { "type": "integer", "minimum": 0, "readOnly": true }, "verbosity": { "type": "integer", "minimum": 0, "readOnly": true }, "system_job": { "type": "integer", "readOnly": true } } }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "system_job_template": { "type": "integer", "nullable": true }, "job_type": { "enum": [ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "", null ], "type": "string", "description": "* `cleanup_jobs` - Remove jobs older than a certain number of days\n* `cleanup_activitystream` - Remove activity stream entries older than a certain number of days\n* `cleanup_sessions` - Removes expired browser sessions from the database", "x-spec-enum-id": "c3fb7965187f07c2", "nullable": true, "default": "" }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "result_stdout": { "type": "string", "readOnly": true } }, "required": [ "name" ] }, "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "last_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "last_job_failed": { "type": "boolean", "readOnly": true }, "next_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "status": { "enum": [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ], "type": "string", "description": "* `new` - New\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled\n* `never updated` - Never Updated\n* `ok` - OK\n* `missing` - Missing\n* `none` - No External Source\n* `updating` - Updating", "x-spec-enum-id": "b387d72f4f16647d", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "job_type": { "enum": [ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "", null ], "type": "string", "description": "* `cleanup_jobs` - Remove jobs older than a certain number of days\n* `cleanup_activitystream` - Remove activity stream entries older than a certain number of days\n* `cleanup_sessions` - Removes expired browser sessions from the database", "x-spec-enum-id": "c3fb7965187f07c2", "nullable": true, "default": "" } }, "required": [ "name" ] }, "Team": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer" } }, "required": [ "name", "organization" ] }, "TeamAccessAssignment": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "related": { "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "summary_fields": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date/time this resource was created." }, "created_by": { "type": "integer", "readOnly": true, "nullable": true, "description": "The user who created this resource." }, "content_type": { "type": "string", "description": "String to use for references to this type from other models in the API.", "readOnly": true }, "object_id": { "type": "string", "nullable": true, "description": "The primary key of the object this assignment applies to; null value indicates system-wide assignment." }, "object_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The resource id of the object this role applies to. An alternative to the object_id field." }, "role_definition": { "type": "integer", "description": "The role definition which defines permissions conveyed by this assignment." }, "team": { "type": "integer", "nullable": true }, "team_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The resource ID of the team who will receive permissions from this assignment. An alternative to team field." } }, "required": [ "role_definition" ] }, "TeamAccessViewSet_Team_": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "related": { "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "name": { "type": "string", "maxLength": 512 }, "organization": { "type": "integer" }, "object_role_assignments": { "type": "string", "readOnly": true } }, "required": [ "name", "organization" ] }, "TeamCredentialSerializerCreate": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "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" ] }, "TeamCredentialSerializerCreateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "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." }, "team": { "type": "integer", "writeOnly": true, "nullable": true, "description": "Write-only field used to add team to owner role. If provided, do not give either user or organization. Only valid for creation." } }, "required": [ "credential_type", "name" ] }, "TeamRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer" } }, "required": [ "name", "organization" ] }, "UnifiedJobList": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." } }, "required": [ "name" ] }, "UnifiedJobStdout": { "type": "object", "properties": { "result_stdout": { "type": "string", "readOnly": true } } }, "UnifiedJobTemplate": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "last_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "last_job_failed": { "type": "boolean", "readOnly": true }, "next_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "status": { "enum": [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ], "type": "string", "description": "* `new` - New\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled\n* `never updated` - Never Updated\n* `ok` - OK\n* `missing` - Missing\n* `none` - No External Source\n* `updating` - Updating", "x-spec-enum-id": "b387d72f4f16647d", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." } }, "required": [ "name" ] }, "User": { "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", "nullable": true, "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "pattern": "^[\\w.@+-]+$", "maxLength": 150 }, "first_name": { "type": "string", "nullable": true, "maxLength": 150 }, "last_name": { "type": "string", "nullable": true, "maxLength": 150 }, "email": { "type": "string", "nullable": true, "title": "Email address", "maxLength": 254 }, "is_superuser": { "type": "boolean", "nullable": true, "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", "format": "date-time", "readOnly": true, "nullable": true } }, "required": [ "username" ] }, "UserAccessAssignment": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "related": { "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "summary_fields": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "The date/time this resource was created." }, "created_by": { "type": "integer", "readOnly": true, "nullable": true, "description": "The user who created this resource." }, "content_type": { "type": "string", "description": "String to use for references to this type from other models in the API.", "readOnly": true }, "object_id": { "type": "string", "nullable": true, "description": "The primary key of the object this assignment applies to; null value indicates system-wide assignment." }, "object_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The resource id of the object this role applies to. An alternative to the object_id field." }, "role_definition": { "type": "integer", "description": "The role definition which defines permissions conveyed by this assignment." }, "user": { "type": "integer", "nullable": true }, "user_ansible_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The resource ID of the user who will receive permissions from this assignment. An alternative to user field." }, "intermediary_roles": { "type": "string", "readOnly": true } }, "required": [ "role_definition" ] }, "UserAccessViewSet_User_": { "type": "object", "description": "controller uses auth.User model so this needs to be as compatible as possible, thus ModelSerializer", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "readOnly": true }, "related": { "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "username": { "type": "string", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "pattern": "^[\\w.@+-]+$", "maxLength": 150 }, "is_superuser": { "type": "boolean", "title": "Superuser status", "description": "Designates that this user has all permissions without explicitly assigning them." }, "first_name": { "type": "string", "maxLength": 150 }, "last_name": { "type": "string", "maxLength": 150 }, "object_role_assignments": { "type": "string", "readOnly": true } }, "required": [ "username" ] }, "UserCredentialSerializerCreate": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "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" ] }, "UserCredentialSerializerCreateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "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." }, "user": { "type": "integer", "writeOnly": true, "nullable": true, "description": "Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation." } }, "required": [ "credential_type", "name" ] }, "UserRequest": { "type": "object", "properties": { "username": { "type": "string", "nullable": true, "minLength": 1, "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "pattern": "^[\\w.@+-]+$", "maxLength": 150 }, "first_name": { "type": "string", "nullable": true, "maxLength": 150 }, "last_name": { "type": "string", "nullable": true, "maxLength": 150 }, "email": { "type": "string", "nullable": true, "title": "Email address", "maxLength": 254 }, "is_superuser": { "type": "boolean", "nullable": true, "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." } }, "required": [ "username" ] }, "WorkflowApproval": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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_args": { "type": "string", "readOnly": true }, "job_cwd": { "type": "string", "readOnly": true }, "job_env": { "readOnly": true }, "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" }, "result_traceback": { "type": "string", "readOnly": true }, "event_processing_finished": { "type": "boolean", "readOnly": true, "description": "Indicates whether all of the events generated by this unified job have been saved to the database." }, "launched_by": { "type": "string", "readOnly": true }, "work_unit_id": { "type": "string", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "can_approve_or_deny": { "type": "string", "readOnly": true }, "approval_expiration": { "type": "string", "readOnly": true }, "timed_out": { "type": "boolean", "description": "Shows when an approval node (with a timeout assigned to it) has timed out.", "readOnly": true } }, "required": [ "name" ] }, "WorkflowApprovalList": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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" }, "launched_by": { "type": "string", "readOnly": true }, "work_unit_id": { "type": "string", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "can_approve_or_deny": { "type": "string", "readOnly": true }, "approval_expiration": { "type": "string", "readOnly": true }, "timed_out": { "type": "boolean", "description": "Shows when an approval node (with a timeout assigned to it) has timed out.", "readOnly": true } }, "required": [ "name" ] }, "WorkflowApprovalTemplate": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "last_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "last_job_failed": { "type": "boolean", "readOnly": true }, "next_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "status": { "enum": [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ], "type": "string", "description": "* `new` - New\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled\n* `never updated` - Never Updated\n* `ok` - OK\n* `missing` - Missing\n* `none` - No External Source\n* `updating` - Updating", "x-spec-enum-id": "b387d72f4f16647d", "readOnly": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "default": 0, "description": "The amount of time (in seconds) before the approval node expires and fails." } }, "required": [ "name" ] }, "WorkflowApprovalTemplateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "default": 0, "description": "The amount of time (in seconds) before the approval node expires and fails." } }, "required": [ "name" ] }, "WorkflowJob": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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_args": { "type": "string", "readOnly": true }, "job_cwd": { "type": "string", "readOnly": true }, "job_env": { "readOnly": true }, "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" }, "result_traceback": { "type": "string", "readOnly": true }, "launched_by": { "type": "string", "readOnly": true }, "work_unit_id": { "type": "string", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "workflow_job_template": { "type": "integer", "nullable": true }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "allow_simultaneous": { "type": "boolean", "nullable": true, "default": false }, "job_template": { "type": "integer", "nullable": true, "description": "If automatically created for a sliced job run, the job template the workflow job was created from." }, "is_sliced_job": { "type": "boolean", "nullable": true, "default": false }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "limit": { "type": "string", "nullable": true }, "scm_branch": { "type": "string", "nullable": true }, "webhook_service": { "enum": [ "github", "gitlab", "bitbucket_dc", "", null ], "type": "string", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "webhook_guid": { "type": "string", "nullable": true, "description": "Unique identifier of the event that triggered this webhook", "maxLength": 128 }, "skip_tags": { "type": "string", "nullable": true }, "job_tags": { "type": "string", "nullable": true } }, "required": [ "name" ] }, "WorkflowJobCancel": { "type": "object", "properties": { "can_cancel": { "type": "boolean", "readOnly": true } } }, "WorkflowJobLaunch": { "type": "object", "properties": { "ask_inventory_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_limit_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_scm_branch_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "can_start_without_user_input": { "type": "boolean", "readOnly": true }, "defaults": { "type": "string", "readOnly": true }, "survey_enabled": { "type": "string", "readOnly": true }, "variables_needed_to_start": { "type": "string", "readOnly": true }, "node_templates_missing": { "type": "string", "readOnly": true }, "node_prompts_rejected": { "type": "string", "readOnly": true }, "workflow_job_template_data": { "type": "string", "readOnly": true }, "ask_variables_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_labels_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_skip_tags_on_launch": { "type": "boolean", "readOnly": true, "nullable": true }, "ask_tags_on_launch": { "type": "boolean", "readOnly": true, "nullable": true } } }, "WorkflowJobLaunchRequest": { "type": "object", "properties": { "extra_vars": { "type": "string", "writeOnly": true }, "inventory": { "type": "integer", "writeOnly": true }, "limit": { "type": "string", "writeOnly": true }, "scm_branch": { "type": "string", "writeOnly": true }, "labels": { "type": "array", "items": { "type": "integer", "writeOnly": true }, "writeOnly": true }, "skip_tags": { "type": "string", "writeOnly": true }, "job_tags": { "type": "string", "writeOnly": true } } }, "WorkflowJobList": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "unified_job_template": { "type": "integer", "readOnly": true, "nullable": true }, "launch_type": { "enum": [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ], "type": "string", "description": "* `manual` - Manual\n* `relaunch` - Relaunch\n* `callback` - Callback\n* `scheduled` - Scheduled\n* `dependency` - Dependency\n* `workflow` - Workflow\n* `webhook` - Webhook\n* `sync` - Sync\n* `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\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled", "x-spec-enum-id": "6021859c28387823", "readOnly": true }, "failed": { "type": "boolean", "readOnly": true }, "started": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job was queued for starting." }, "finished": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "The date and time the job finished execution." }, "canceled_on": { "type": "string", "format": "date-time", "readOnly": true, "nullable": 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" }, "launched_by": { "type": "string", "readOnly": true }, "work_unit_id": { "type": "string", "readOnly": true, "nullable": true, "description": "The Receptor work unit ID associated with this job." }, "workflow_job_template": { "type": "integer", "nullable": true }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "allow_simultaneous": { "type": "boolean", "nullable": true, "default": false }, "job_template": { "type": "integer", "nullable": true, "description": "If automatically created for a sliced job run, the job template the workflow job was created from." }, "is_sliced_job": { "type": "boolean", "nullable": true, "default": false }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "limit": { "type": "string", "nullable": true }, "scm_branch": { "type": "string", "nullable": true }, "webhook_service": { "enum": [ "github", "gitlab", "bitbucket_dc", "", null ], "type": "string", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "webhook_guid": { "type": "string", "nullable": true, "description": "Unique identifier of the event that triggered this webhook", "maxLength": 128 }, "skip_tags": { "type": "string", "nullable": true }, "job_tags": { "type": "string", "nullable": true } }, "required": [ "name" ] }, "WorkflowJobListRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "workflow_job_template": { "type": "integer", "nullable": true }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "allow_simultaneous": { "type": "boolean", "nullable": true, "default": false }, "job_template": { "type": "integer", "nullable": true, "description": "If automatically created for a sliced job run, the job template the workflow job was created from." }, "is_sliced_job": { "type": "boolean", "nullable": true, "default": false }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "limit": { "type": "string", "nullable": true }, "scm_branch": { "type": "string", "nullable": true }, "webhook_service": { "enum": [ "github", "gitlab", "bitbucket_dc", "", null ], "type": "string", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "webhook_guid": { "type": "string", "nullable": true, "description": "Unique identifier of the event that triggered this webhook", "maxLength": 128 }, "skip_tags": { "type": "string", "nullable": true }, "job_tags": { "type": "string", "nullable": true } }, "required": [ "name" ] }, "WorkflowJobNodeDetail": { "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 }, "extra_data": { "default": {} }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "job": { "type": "integer", "nullable": true }, "workflow_job": { "type": "integer", "nullable": true }, "unified_job_template": { "type": "integer", "nullable": true }, "success_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "failure_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "always_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "all_parents_must_converge": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node" }, "do_not_run": { "type": "boolean", "nullable": true, "default": false, "description": "Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run." }, "identifier": { "type": "string", "nullable": true, "description": "An identifier coresponding to the workflow job template node that this node was created from.", "maxLength": 512 } } }, "WorkflowJobNodeList": { "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 }, "extra_data": { "default": {} }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "job": { "type": "integer", "nullable": true }, "workflow_job": { "type": "integer", "nullable": true }, "unified_job_template": { "type": "integer", "nullable": true }, "success_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "failure_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "always_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "all_parents_must_converge": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node" }, "do_not_run": { "type": "boolean", "nullable": true, "default": false, "description": "Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run." }, "identifier": { "type": "string", "nullable": true, "description": "An identifier coresponding to the workflow job template node that this node was created from.", "maxLength": 512 } } }, "WorkflowJobTemplate": { "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", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "last_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "last_job_failed": { "type": "boolean", "readOnly": true }, "next_job_run": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "status": { "enum": [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ], "type": "string", "description": "* `new` - New\n* `pending` - Pending\n* `waiting` - Waiting\n* `running` - Running\n* `successful` - Successful\n* `failed` - Failed\n* `error` - Error\n* `canceled` - Canceled\n* `never updated` - Never Updated\n* `ok` - OK\n* `missing` - Missing\n* `none` - No External Source\n* `updating` - Updating", "x-spec-enum-id": "b387d72f4f16647d", "readOnly": true }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "The organization used to determine access to this template." }, "survey_enabled": { "type": "boolean", "nullable": true, "default": false }, "allow_simultaneous": { "type": "boolean", "nullable": true, "default": false }, "ask_variables_on_launch": { "type": "boolean", "nullable": true, "default": false }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "limit": { "type": "string", "nullable": true }, "scm_branch": { "type": "string", "nullable": true }, "ask_inventory_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_scm_branch_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_limit_on_launch": { "type": "boolean", "nullable": true, "default": false }, "webhook_service": { "enum": [ "github", "gitlab", "bitbucket_dc", "", null ], "type": "string", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "ask_labels_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_skip_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "skip_tags": { "type": "string", "nullable": true }, "job_tags": { "type": "string", "nullable": true } }, "required": [ "name" ] }, "WorkflowJobTemplateNode": { "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 }, "extra_data": { "default": {} }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "workflow_job_template": { "type": "integer" }, "unified_job_template": { "type": "integer", "nullable": true }, "success_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "failure_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "always_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "all_parents_must_converge": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node" }, "identifier": { "type": "string", "nullable": true, "description": "An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "maxLength": 512 } }, "required": [ "workflow_job_template" ] }, "WorkflowJobTemplateNodeCreateApproval": { "type": "object", "properties": { "timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "default": 0, "description": "The amount of time (in seconds) before the approval node expires and fails." }, "name": { "type": "string", "nullable": true, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" } }, "required": [ "name" ] }, "WorkflowJobTemplateNodeCreateApprovalRequest": { "type": "object", "properties": { "timeout": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "default": 0, "description": "The amount of time (in seconds) before the approval node expires and fails." }, "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" } }, "required": [ "name" ] }, "WorkflowJobTemplateNodeDetail": { "type": "object", "description": "Influence the api browser sample data to not include workflow_job_template\nwhen editing a WorkflowNode.\n\nNote: I was not able to accomplish this through the use of extra_kwargs.\nMaybe something to do with workflow_job_template being a relational field?", "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 }, "extra_data": { "default": {} }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "workflow_job_template": { "type": "integer" }, "unified_job_template": { "type": "integer", "nullable": true }, "success_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "failure_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "always_nodes": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "all_parents_must_converge": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node" }, "identifier": { "type": "string", "nullable": true, "description": "An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "maxLength": 512 } }, "required": [ "workflow_job_template" ] }, "WorkflowJobTemplateNodeDetailRequest": { "type": "object", "description": "Influence the api browser sample data to not include workflow_job_template\nwhen editing a WorkflowNode.\n\nNote: I was not able to accomplish this through the use of extra_kwargs.\nMaybe something to do with workflow_job_template being a relational field?", "properties": { "extra_data": { "default": {} }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "workflow_job_template": { "type": "integer" }, "unified_job_template": { "type": "integer", "nullable": true }, "all_parents_must_converge": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node" }, "identifier": { "type": "string", "nullable": true, "minLength": 1, "description": "An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "maxLength": 512 } }, "required": [ "workflow_job_template" ] }, "WorkflowJobTemplateNodeRequest": { "type": "object", "properties": { "extra_data": { "default": {} }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "scm_branch": { "type": "string", "nullable": true }, "job_type": { "enum": [ "run", "check", "", null ], "type": "string", "description": "* `run` - Run\n* `check` - Check", "x-spec-enum-id": "726608a431c1f104", "nullable": true }, "job_tags": { "type": "string", "nullable": true }, "skip_tags": { "type": "string", "nullable": true }, "limit": { "type": "string", "nullable": true }, "diff_mode": { "type": "boolean", "nullable": true }, "verbosity": { "enum": [ 0, 1, 2, 3, 4, 5, null ], "type": "integer", "description": "* `0` - 0 (Normal)\n* `1` - 1 (Verbose)\n* `2` - 2 (More Verbose)\n* `3` - 3 (Debug)\n* `4` - 4 (Connection Debug)\n* `5` - 5 (WinRM Debug)", "x-spec-enum-id": "8cfb81af905b865a", "nullable": true }, "execution_environment": { "type": "integer", "nullable": true, "description": "The container image to be used for execution." }, "forks": { "type": "integer", "minimum": 0, "nullable": true }, "job_slice_count": { "type": "integer", "minimum": 0, "nullable": true }, "timeout": { "type": "integer", "nullable": true }, "workflow_job_template": { "type": "integer" }, "unified_job_template": { "type": "integer", "nullable": true }, "all_parents_must_converge": { "type": "boolean", "nullable": true, "default": false, "description": "If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node" }, "identifier": { "type": "string", "nullable": true, "minLength": 1, "description": "An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.", "maxLength": 512 } }, "required": [ "workflow_job_template" ] }, "WorkflowJobTemplateRequest": { "type": "object", "description": "Provide recent jobs and survey details in summary_fields", "properties": { "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 512 }, "description": { "type": "string", "nullable": true, "default": "" }, "extra_vars": { "type": "string", "nullable": true, "default": "" }, "organization": { "type": "integer", "nullable": true, "description": "The organization used to determine access to this template." }, "survey_enabled": { "type": "boolean", "nullable": true, "default": false }, "allow_simultaneous": { "type": "boolean", "nullable": true, "default": false }, "ask_variables_on_launch": { "type": "boolean", "nullable": true, "default": false }, "inventory": { "type": "integer", "nullable": true, "description": "Inventory applied as a prompt, assuming job template prompts for inventory" }, "limit": { "type": "string", "nullable": true }, "scm_branch": { "type": "string", "nullable": true }, "ask_inventory_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_scm_branch_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_limit_on_launch": { "type": "boolean", "nullable": true, "default": false }, "webhook_service": { "enum": [ "github", "gitlab", "bitbucket_dc", "", null ], "type": "string", "x-spec-enum-id": "eee3a42406ba2781", "nullable": true, "description": "Service that webhook requests will be accepted from\n\n* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket_dc` - BitBucket DataCenter" }, "webhook_credential": { "type": "integer", "nullable": true, "description": "Personal Access Token for posting back the status to the service API" }, "ask_labels_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_skip_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "ask_tags_on_launch": { "type": "boolean", "nullable": true, "default": false }, "skip_tags": { "type": "string", "nullable": true }, "job_tags": { "type": "string", "nullable": true } }, "required": [ "name" ] } } } }