{ "openapi": "3.0.4", "info": { "title": "PortalAPI", "version": "v1.0.0" }, "paths": { "/portalapi/ActionLog/ActionLogGetByParametersV2": { "post": { "tags": [ "ActionLog" ], "summary": "Get Action Logs By Parameters.", "description": "Parameters Values:\r\n \r\n {\r\n \"ActionType\": \"execute | install | network | registry | read | write | move |\r\n delete | baseline | powershell | elevate | configuration | dns\",\r\n \"SourceTableId\": \"ActionLog = 1 | DenyActionLog = 2 | BaselineActionLog = 3 | EventLogActionLog = 4\",\r\n \"ActionId\": \"Permit = 1 | Deny = 2 | DenyOptionToRequest = 3 | InstallMode = 4 | MissingCoreFiles = 5 | Ringfenced = 6 | AnyDeny = 7\",\r\n \"GroupBy\": \"FullPath = path | Hash = hash | SourceIp = sourceip | Cert = cert | Hostname = hostname | Username = username | ProcessPath = process\"\r\n }", "parameters": [ { "name": "usenewsearch", "in": "header", "schema": { "type": "string" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionLogParamsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActionLogParamsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActionLogParamsDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ActionLog/ActionLogGetAllForFileHistory": { "get": { "tags": [ "ActionLog" ], "summary": "Get All File History by hostname and fullpath", "description": "Parameters Values:\r\n \r\n {\r\n \"sourceTableId\": \"ActionLog = 1 | DenyActionLog = 2 | BaselineActionLog = 3 | EventLogActionLog = 4\"\r\n }", "parameters": [ { "name": "sourceTableId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "hostname", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fullPath", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ActionLog/ActionLogGetAllForFileHistoryV2": { "get": { "tags": [ "ActionLog" ], "summary": "Get All File History by hostname and fullpath", "description": "Parameters Values:\r\n \r\n {\r\n \"sourceTableId\": \"ActionLog = 1 | DenyActionLog = 2 | BaselineActionLog = 3 | EventLogActionLog = 4\"\r\n }", "parameters": [ { "name": "sourceTableId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "hostname", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fullPath", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "computerId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ActionLog/ActionLogGetById": { "get": { "tags": [ "ActionLog" ], "summary": "Get Action Logs by Id.", "description": "Parameters Values:\r\n \r\n {\r\n \"sourceTableId\": \"ActionLog = 1 | DenyActionLog = 2 | BaselineActionLog = 3 | EventLogActionLog = 4\"\r\n }", "parameters": [ { "name": "actionLogId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int64" } }, { "name": "sourceTableId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "addToApplication", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ActionLog/ActionLogGetByIdV2": { "get": { "tags": [ "ActionLog" ], "parameters": [ { "name": "eActionLogId", "in": "query", "schema": { "type": "string" } }, { "name": "sourceTableId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "addToApplication", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "getAllParents", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "openedFromLink", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ActionLog/ActionLogGetTestingEnvironmentDetailsById": { "post": { "tags": [ "ActionLog" ], "summary": "Get Testing Environment Details For VDI HyperV", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileDownloadDetailsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileDownloadDetailsDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ActionLog/ActionLogGetPolicyConditionsForPermitApplication": { "post": { "tags": [ "ActionLog" ], "summary": "Get Policy Conditions For Permit Application", "description": "Parameters Values:\r\n \r\n {\r\n \"OSType\": \"All = 0 | Windows = 1 | MAC = 2 | Linux = 3\"\r\n \"ActionType\": \"None = 0 | BaseLine = 1 | Configuration = 2 | Delete = 3 | Elevation = 4 | Execute = 5 |\r\n Install = 6 | Move = 7 | Network = 8 | NewProcess = 9 | Powershell = 10 | Read = 11 | \r\n Registry = 12 | Uninstall = 13 | Write = 14 | OSEventLog = 15\",\r\n }", "parameters": [ { "name": "usenewsearch", "in": "header", "schema": { "type": "string" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermitApplicationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PermitApplicationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PermitApplicationDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ActionLog/ActionLogGetSearchString": { "post": { "tags": [ "ActionLog" ], "summary": "Get Search String (This is for save search).", "description": "Parameters Values:\r\n \r\n {\r\n \"ActionType\": \"None = 0 | BaseLine = 1 | Configuration = 2 | Delete = 3 | Elevation = 4 | Execute = 5 |\r\n Install = 6 | Move = 7 | Network = 8 | NewProcess = 9 | Powershell = 10 | Read = 11 | \r\n Registry = 12 | Uninstall = 13 | Write = 14 | OSEventLog = 15\",\r\n \"SourceTableId\": \"ActionLog = 1 | DenyActionLog = 2 | BaselineActionLog = 3 | EventLogActionLog = 4\",\r\n \"ActionId\": \"Permit = 1 | Deny = 2 | DenyOptionToRequest = 3 | InstallMode = 4 | MissingCoreFiles = 5 | Ringfenced = 6 | AnyDeny = 7\",\r\n \"GroupBy\": \"FullPath = path | Hash = hash | SourceIp = sourceip | Cert = cert | Hostname = hostname | Username = username | ProcessPath = process\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionLogParamsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActionLogParamsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActionLogParamsDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ActionLog/ActionLogGetFileDownloadDetailsById": { "get": { "tags": [ "ActionLog" ], "parameters": [ { "name": "eActionLogId", "in": "query", "schema": { "type": "string" } }, { "name": "sourceTableId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Application/ApplicationGetById": { "get": { "tags": [ "Application" ], "summary": "Get Application by Id.", "parameters": [ { "name": "applicationId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Application/ApplicationGetForNetworkPolicyProcessById": { "get": { "tags": [ "Application" ], "summary": "Get Application Details for Network Policy Process by Id.", "parameters": [ { "name": "applicationId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Application/ApplicationGetResearchDetailsById": { "get": { "tags": [ "Application" ], "summary": "Get Application Research Details by Id.", "parameters": [ { "name": "applicationId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Application/ApplicationGetForMaintenanceMode": { "get": { "tags": [ "Application" ], "summary": "Get Application Options for Maintenance Scheduling", "description": "Parameters Values:\r\n \r\n {\r\n \"OSType\": \"All = 0 | Windows = 1 | MAC = 2 | Linux = 3\"\r\n }", "parameters": [ { "name": "osType", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Application/ApplicationGetMatchingList": { "post": { "tags": [ "Application" ], "summary": "Get Matching Applications", "description": "Parameters Values:\r\n \r\n {\r\n \"OSType\": \"All = 0 | Windows = 1 | MAC = 2 | Linux = 3\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationMatchParameterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplicationMatchParameterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplicationMatchParameterDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Application/ApplicationGetForApplicationOptions": { "post": { "tags": [ "Application" ], "summary": "Load Application", "description": "Parameters Values:\r\n \r\n {\r\n \"OSType\": \"All = 0 | Windows = 1 | MAC = 2 | Linux = 3\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationGetForApplicationOptionsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApplicationGetForApplicationOptionsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApplicationGetForApplicationOptionsDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestGetById": { "get": { "tags": [ "ApprovalRequest" ], "summary": "Get Approval Request By ID", "parameters": [ { "name": "approvalRequestId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestGetFileDownloadDetailsById": { "get": { "tags": [ "ApprovalRequest" ], "summary": "Get File Download Details By Approval Request Id", "parameters": [ { "name": "approvalRequestId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestGetPermitApplicationById": { "get": { "tags": [ "ApprovalRequest" ], "summary": "Get Permit Application Details By Approval Request Id", "parameters": [ { "name": "approvalRequestId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestTemporaryPermitApplication": { "post": { "tags": [ "ApprovalRequest" ], "summary": "", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemporaryCompleteApprovalRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemporaryCompleteApprovalRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemporaryCompleteApprovalRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestPermitApplication": { "post": { "tags": [ "ApprovalRequest" ], "summary": "Approve Permit Application Request", "description": "Parameters Values:\r\n \r\n {\r\n \"osType\": \"All = 0 | Windows = 1 | MAC = 2 | Linux = 3\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermitApplicationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PermitApplicationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PermitApplicationDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestAutoPermitApplication": { "post": { "tags": [ "ApprovalRequest" ], "summary": "Approve Permit Application Request", "description": "Parameters Values:\r\n \r\n {\r\n \"osType\": \"All = 0 | Windows = 1 | MAC = 2 | Linux = 3\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermitApplicationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PermitApplicationDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PermitApplicationDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestGetStorageApprovalById": { "get": { "tags": [ "ApprovalRequest" ], "summary": "Get Storage Approval Request By Id", "parameters": [ { "name": "approvalRequestId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestPermitStorageApproval": { "post": { "tags": [ "ApprovalRequest" ], "summary": "Approve Storage Request", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageApprovalDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StorageApprovalDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StorageApprovalDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestGetByParameters": { "post": { "tags": [ "ApprovalRequest" ], "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestParametersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestParametersDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestParametersDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestGetCount": { "get": { "tags": [ "ApprovalRequest" ], "summary": "Get Approval Request Pending Count", "parameters": [ { "name": "includeChildOrganizations", "in": "query", "description": "", "schema": { "type": "boolean", "default": true } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestUpdateForTakeOwnership": { "post": { "tags": [ "ApprovalRequest" ], "summary": "Take Ownership of Approval Request", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestUpdateForIgnore": { "post": { "tags": [ "ApprovalRequest" ], "summary": "Ignore Approval Request", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestUpdateParametersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestUpdateParametersDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestUpdateParametersDto" } } } }, "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/portalapi/ApprovalRequest/ApprovalRequestUpdateForReject": { "post": { "tags": [ "ApprovalRequest" ], "summary": "Reject Approval Request", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestUpdateParametersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestUpdateParametersDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestUpdateParametersDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ApprovalRequest/ApprovalRequestAuthorizeForPermitById": { "post": { "tags": [ "ApprovalRequest" ], "summary": "Authorize Approval Request for Permit", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestAuthorizeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestAuthorizeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestAuthorizeDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerGetByAllParameters": { "post": { "tags": [ "Computer" ], "summary": "Load Computers By All Parameters", "description": "Parameters Values:\r\n \r\n \r\n {\r\n \"OrderBy\": \"computername | group | action | lastcheckin | computerinstalldate | deniedcountthreedays | updatechannel | threatlockerversion\",\r\n \"Action\": \" All Computer Mode | Secure | Installation | Learning | MonitorOnly | Manual Update | Pre-Releases | Regular | Expedited | Slow and Steady\",\r\n \"KindOfAction\": \" Computer Mode | TamperProtectionDisabled | NeedsReview | ReadyToSecure | BaselineNotUploaded | Update Channel\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerParameterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerParameterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerParameterDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerGetForEditById": { "get": { "tags": [ "Computer" ], "summary": "Get Computer Information By Id.", "parameters": [ { "name": "computerId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerUpdateForEdit": { "patch": { "tags": [ "Computer" ], "summary": "Update Computer", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerUpdateDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerUpdateBaselineRescan": { "post": { "tags": [ "Computer" ], "summary": "Update Baseline Rescan Computer", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerRescanBaselineDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerRescanBaselineDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerRescanBaselineDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerUpdateShouldRestartByIds": { "post": { "tags": [ "Computer" ], "summary": "Restart service for selected computers", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerRestartServiceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerRestartServiceDto" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerRestartServiceDto" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerUpdateShouldRestartByOrganization": { "post": { "tags": [ "Computer" ], "summary": "Restart Organization Computers", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } }, "application/*+json": { "schema": { "type": "boolean" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerMoveToOtherOrganization": { "post": { "tags": [ "Computer" ], "summary": "Move Computer", "description": "Parameters Values:\r\n \r\n {\r\n \"MaintenanceTypeId\": \" MonitorOnly = 1 | Installation Mode = 2 | Learning = 3 | Elevation Mode = 4 | Learning Mode Hash Only = 5 | TamperProtectionDisabled = 6\",\r\n \"OSType\": \"Windows = 1 | MAC = 2 | Linux = 3\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerTransferDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerTransferDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerTransferDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerEnableProtection": { "post": { "tags": [ "Computer" ], "summary": "Computer Enable Protection", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerEnableProtectionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerEnableProtectionDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerEnableProtectionDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerDisableProtection": { "post": { "tags": [ "Computer" ], "summary": "Disable Computer Protection", "description": "Parameters Values:\r\n \r\n {\r\n \"Action\": \" MonitorOnly | Installation Mode | Learning | Elevation Mode | Learning Mode Hash Only | TamperProtectionDisabled | Secure\",\r\n \"MaintenanceModeType\": \" MonitorOnly = 1 | Learning = 3 | TamperProtectionDisabled = 6\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerDisabledProtectionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerDisabledProtectionDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerDisabledProtectionDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerRemoveDuplicate": { "post": { "tags": [ "Computer" ], "summary": "Remove Duplicate Computers", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } }, "application/*+json": { "schema": { "type": "boolean" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerUpdateMaintenanceMode": { "post": { "tags": [ "Computer" ], "summary": "Updates a device's maintenance mode settings.", "description": "Use this endpoint to enable or disable specific maintenance modes for a device.\r\n \r\n**Maintenance Mode IDs:**\r\n* **Application Control Monitor**: `1`\r\n* **Application Control Installation**: `2`\r\n* **Application Control Learning**: `3`\r\n* **Network Control Monitor**: `17`\r\n* **Storage Control Monitor**: `18`\r\n* **Elevation Mode**: `4`\r\n* **Disable ThreatLocker Detect**: `16`\r\n \r\n**OS Type IDs:**\r\n* **Windows**: `1`\r\n* **MAC**: `2`\r\n* **Linux**: `3`", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "A DTO containing the device identifier and the maintenance mode settings to apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerUpdateMaintenanceModeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerUpdateMaintenanceModeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerUpdateMaintenanceModeDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerUpdateThreatlockerVersionByIds": { "post": { "tags": [ "Computer" ], "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerVersionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerVersionDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerVersionDto" } } } }, "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/portalapi/Computer/ComputerGetThreatlockerVersions": { "get": { "tags": [ "Computer" ], "summary": "Retrieves ThreatLocker agent versions for computers in the managed organization.", "parameters": [ { "name": "includeChildOrganizations", "in": "query", "description": "If true, also include computers from child organizations the user has access to.", "schema": { "type": "boolean", "default": false } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerUpdateToFinishMaintenanceMode": { "post": { "tags": [ "Computer" ], "summary": "End Maintenance Mode", "description": "Parameters Values:\r\n \r\n {\r\n \"MaintenanceTypeId\": \" MonitorOnly = 1 | Installation Mode = 2 | Learning = 3 | Elevation Mode = 4 | Learning Mode Hash Only = 5 | TamperProtectionDisabled = 6\",\r\n \"OSType\": \"Windows = 1 | MAC = 2 | Linux = 3\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerUpdateToFinishMaintenanceModeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerUpdateToFinishMaintenanceModeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerUpdateToFinishMaintenanceModeDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerGetForNewComputer": { "get": { "tags": [ "Computer" ], "summary": "Get data for new computer", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerGetDownload": { "post": { "tags": [ "Computer" ], "summary": "Computer Get Download", "description": "Parameters Values:\r\n \r\n {\r\n \"FileType\": \" Stub Installer = stub | MSI Installer = windows | PowerShell Script = pssscript | PKG File = mac | Remediator Service Installer = remediation\",\r\n \"Platform\": \" X86 | X64 | ''\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerDownloadParameterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerDownloadParameterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerDownloadParameterDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerGetDownloadStream": { "post": { "tags": [ "Computer" ], "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerDownloadParameterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerDownloadParameterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerDownloadParameterDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerGetOSTypeByIds": { "post": { "tags": [ "Computer" ], "summary": "Get OS Types for Computer.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerSignedScriptDownload": { "get": { "tags": [ "Computer" ], "summary": "Download Login Script", "parameters": [ { "name": "brand", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerSamplePathDownload": { "get": { "tags": [ "Computer" ], "summary": "Download Sample Batch File", "parameters": [ { "name": "brand", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "authKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerUnSignedScriptDownload": { "get": { "tags": [ "Computer" ], "summary": "Download Unsigned Login Script", "parameters": [ { "name": "brand", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerUpdateChannel": { "post": { "tags": [ "Computer" ], "summary": "Threatlocker Update Channel", "description": "Parameters Values:\r\n \r\n {\r\n \"UpdateChannel\": \" Manual Update = 0 | Pre-Releases = 1 | Regular = 2 | Expedited = 3 | Slow and Steady = 4\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerChannelDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerChannelDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerChannelDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Computer/ComputerGetThrottleStatusByIds": { "post": { "tags": [ "Computer" ], "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ComputerCheckin/ComputerCheckinGetByParameters": { "post": { "tags": [ "ComputerCheckin" ], "summary": "Get Computer Check-In History by Parameters", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerCheckinParametersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComputerCheckinParametersDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComputerCheckinParametersDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ComputerGroup/ComputerGroupGetGroupAndComputer": { "get": { "tags": [ "ComputerGroup" ], "summary": "Get Groups and Computer", "description": "Parameters Values:\r\n \r\n {\r\n \"OSType\": \"All = 0 | Windows = 1 | MAC = 2 | Linux = 3\"\r\n }", "parameters": [ { "name": "ComputerGroupId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "OSType", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeGlobal", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeAllPolicies", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeOrganizations", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeAllComputers", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeParentGroups", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeLoggedInObjects", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeDnsServers", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeIngestors", "in": "query", "schema": { "type": "boolean" } }, { "name": "PortalModuleTypeId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "IncludeAccessDevices", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeRemovedComputers", "in": "query", "schema": { "type": "boolean" } }, { "name": "MinimumVersions", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OSVersionDto" } } }, { "name": "OsTypeExclusions", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ComputerGroup/ComputerGroupGetDropdownByOrganizationId": { "get": { "tags": [ "ComputerGroup" ], "summary": "Get Computer Groups by OrganizationId", "parameters": [ { "name": "computerGroupOSTypeId", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "computerOSType", "in": "query", "schema": { "type": "string", "default": "windows" } }, { "name": "hideGlobals", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ComputerGroup/ComputerGroupGetForPermitApplication": { "get": { "tags": [ "ComputerGroup" ], "summary": "Get Computer Groups For Permit Application", "description": "Parameters Values:\r\n \r\n {\r\n \"OSType\": \"All = 0 | Windows = 1 | MAC = 2 | Linux = 3\"\r\n }", "parameters": [ { "name": "osType", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ComputerGroup/ComputerGroupGetForDownload": { "get": { "tags": [ "ComputerGroup" ], "summary": "Get Group Download Installers", "parameters": [ { "name": "installKey", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/MaintenanceMode/MaintenanceModeGetByComputerId": { "get": { "tags": [ "MaintenanceMode" ], "summary": "Get Maintenance Schedule By Computer Id", "parameters": [ { "name": "computerId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/portalapi/MaintenanceMode/MaintenanceModeInsert": { "post": { "tags": [ "MaintenanceMode" ], "summary": "Add to Maintenance Schedule", "description": "Parameters Values:\r\n \r\n {\r\n \"AutomaticApplicationType\": \" empty = 0 | Automatic Computer = 1 | Automatic Group = 2 | Automatic System = 3\",\r\n \"MaintenanceTypeId\": \" MonitorOnly = 1 | Installation Mode = 2 | Learning = 3 | Elevation Mode = 4 | Learning Mode Hash Only = 5 | TamperProtectionDisabled = 6\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaintenanceModeInsertDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MaintenanceModeInsertDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MaintenanceModeInsertDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/MaintenanceMode/MaintenanceModeEndById": { "patch": { "tags": [ "MaintenanceMode" ], "summary": "End Maintenance Schedule", "description": "Parameters Values:\r\n \r\n {\r\n \"AppliesToType\": \" empty = 0 | Automatic Computer = 1 | Automatic Group = 2 | Automatic System = 3\",\r\n \"MaintenanceTypeId\": \" MonitorOnly = 1 | Installation Mode = 2 | Learning = 3 | Elevation Mode = 4 | Learning Mode Hash Only = 5 | TamperProtectionDisabled = 6\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaintenanceModeEndDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MaintenanceModeEndDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MaintenanceModeEndDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/MaintenanceMode/MaintenanceModeUpdateEndDateTimeForSpecificDate": { "post": { "tags": [ "MaintenanceMode" ], "summary": "Updated Maintenance Mode End Date Time.", "description": "Parameters Values:\r\n \r\n {\r\n \"MaintenanceTypeId\": \" MonitorOnly = 1 | Installation Mode = 2 | Learning = 3 | Elevation Mode = 4 | Learning Mode Hash Only = 5 | TamperProtectionDisabled = 6\",\r\n \"OSType\": \"Windows = 1 | MAC = 2 | Linux = 3\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaintenanceModeUpdateEndDateTimeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MaintenanceModeUpdateEndDateTimeDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MaintenanceModeUpdateEndDateTimeDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/OnlineDevices/OnlineDevicesGetByParameters": { "get": { "tags": [ "OnlineDevices" ], "summary": "View Online Devices", "parameters": [ { "name": "pageNumber", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string", "default": "HostName" } }, { "name": "isAscending", "in": "query", "description": "", "schema": { "type": "boolean", "default": true } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Organization/OrganizationGetAuthKeyById": { "get": { "tags": [ "Organization" ], "summary": "Get Auth Key", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Organization/OrganizationUpdateAuthKeyById": { "post": { "tags": [ "Organization" ], "summary": "Generate Auth Key", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Organization/OrganizationGetForMoveComputers": { "get": { "tags": [ "Organization" ], "summary": "Get Organizations For Move Computers", "parameters": [ { "name": "searchText", "in": "query", "description": "", "schema": { "type": "string", "default": "" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Organization/OrganizationGetChildOrganizationsByParameters": { "post": { "tags": [ "Organization" ], "summary": "Get Child Organizations By Parameters.", "description": " Use this endpoint to return all child organizations based on the selected fields below.\r\n \r\n**Required body:**\r\n\r\n {\r\n \"orderBy\": \"billingMethod\" | \"businessClassificationName\" | \"dateAdded\" | \"name\",\r\n \"pageNumber\": \"1\",\r\n \"pageSize\": \"25\" | \"50\" | \"100\" | \"500\"\r\n }\r\n\r\n**Optional body:**\r\n\r\n {\r\n \"orderBy\": \"billingMethod\" | \"businessClassificationName\" | \"dateAdded\" | \"name\",\r\n \"pageNumber\": \"1\",\r\n \"pageSize\": \"25\" | \"50\" | \"100\" | \"500\"\r\n \"includeAllChildren\": \"true\" | \"false\",\r\n \"includeProductBundles\": \"true\" | \"false\",\r\n \"isAscending\": \"true\" | \"false\",\r\n \"isExport\": \"true\" | \"false\",\r\n \"searchText\": \"\"\r\n }\r\n\r\n \r\n **Link to KB articles:**\r\n * **[/portalAPI/Organization/OrganizationGetChildOrganizationsByParameters | ThreatLocker Help Center](https://threatlocker.kb.help/portalapiorganization/#:~:text=Install%20Computers-,OrganizationGetChildOrganizationsByParameters,-https%3A//portalapi.INSTANCE)**\r\n * **[/portalAPI/Organization/* | ThreatLocker Help Center](https://threatlocker.kb.help/portalapiorganization/)**\r\n * **[API Documentation](https://threatlocker.kb.help/api-documentation/)**", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationChildDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrganizationChildDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OrganizationChildDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/Policy/PolicyGetById": { "get": { "tags": [ "Policy" ], "summary": "Get Policy by Id.", "parameters": [ { "name": "policyId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Report/ReportGetByOrganizationId": { "get": { "tags": [ "Report" ], "summary": "Get report(s) by organization id.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Report/ReportGetDynamicData": { "post": { "tags": [ "Report" ], "summary": "Generate report data.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportParams" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/RingfencePolicy/OptIn": { "post": { "tags": [ "RingfencePolicy" ], "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/RingfencePolicy/{ringfencePolicyId}": { "get": { "tags": [ "RingfencePolicy" ], "parameters": [ { "name": "ringfencePolicyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/RingfencePolicy/ConvertLegacyRingfencePolicy/{applicationId}": { "get": { "tags": [ "RingfencePolicy" ], "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/RingfencePolicy/Eligibility": { "post": { "tags": [ "RingfencePolicy" ], "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/RingfencePolicy/HasLegacyPolicy": { "post": { "tags": [ "RingfencePolicy" ], "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RingfencePolicyLegacyMatchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RingfencePolicyLegacyMatchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RingfencePolicyLegacyMatchRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/RingfencePolicy/GetRingfenceAgentVersion": { "get": { "tags": [ "RingfencePolicy" ], "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/SaveSearch/SaveSearchGetByPage": { "post": { "tags": [ "SaveSearch" ], "summary": "Get Save Search.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveSearchesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveSearchesDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveSearchesDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/SaveSearch/SaveSearchInsert": { "post": { "tags": [ "SaveSearch" ], "summary": "Insert Save Search.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveSearchDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveSearchDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveSearchDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/SaveSearch/SaveSearchDeleteById": { "delete": { "tags": [ "SaveSearch" ], "summary": "Delete Save Search.", "parameters": [ { "name": "saveSearchId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/SaveSearch/SaveSearchTQLGetByPage": { "post": { "tags": [ "SaveSearch" ], "summary": "Get TQL Save Search.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveSearchesDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveSearchesDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveSearchesDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/SaveSearch/SaveSearchTQLInsert": { "post": { "tags": [ "SaveSearch" ], "summary": "Insert TQL Save Search.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveSearchDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveSearchDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveSearchDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/SaveSearch/SaveSearchTQLDeleteById": { "delete": { "tags": [ "SaveSearch" ], "summary": "Delete TQL Save Search.", "parameters": [ { "name": "saveSearchId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ScheduledAgentAction/List": { "get": { "tags": [ "ScheduledAgentAction" ], "summary": "Get a list of Scheduled Agent Actions", "description": "Parameters Values:\r\n \r\n {\r\n \"ScheduledType\": \"Version Update = 1\",\r\n \"IncludeChildren\": \"true or false\"\r\n }", "parameters": [ { "name": "scheduledType", "in": "query", "description": "Scheduled type identifier", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeChildren", "in": "query", "description": "Whether to include child organizations.", "schema": { "type": "boolean" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ScheduledAgentAction/AppliesTo": { "get": { "tags": [ "ScheduledAgentAction" ], "summary": "Get a list of valid Applies To records", "description": "Parameters Values:\r\n \r\n {\r\n \"OSType\": \"Windows = 1 | Mac = 2 | Linux = 3 | Red Hat Enterprise Linux 6 = 7\",\r\n \"IncludeChildren\": \"true or false\",\r\n \"SearchText\": \"(Optional) - Any alphanumeric text\"\r\n }", "parameters": [ { "name": "osType", "in": "query", "description": "Operating system type identifier.", "schema": { "type": "integer", "format": "int32" } }, { "name": "includeChildren", "in": "query", "description": "Whether to include child organizations.", "schema": { "type": "boolean" } }, { "name": "searchText", "in": "query", "description": "Optional search filter text.", "schema": { "type": "string", "default": "" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ScheduledAgentAction/GetForHydration": { "get": { "tags": [ "ScheduledAgentAction" ], "summary": "Get the Scheduled Agent Action details", "description": "Parameters Values:\r\n \r\n {\r\n \"ScheduledId\": \"A value present in the response returned from GetScheduledAgentActionList\",\r\n }", "parameters": [ { "name": "scheduledId", "in": "query", "description": "The unique identifier of the scheduled agent action.", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/ScheduledAgentAction/GetByParameters": { "post": { "tags": [ "ScheduledAgentAction" ], "summary": "Get the scheduled agent actions based on the provided filter parameters.", "description": "Parameters Values:\r\n \r\n {\r\n \"ScheduledId\": \"A value present in the response returned from GetScheduledAgentActionList\",\r\n \"OrderBy\": \"scheduleddatetime | computername | computergroupname | organizationname\",\r\n \"IsAscending\": \"true or false\",\r\n \"SearchText\": \"Any alphanumeric text\",\r\n \"PageSize\": \"The number of records per page\",\r\n \"PageNumber\": \"The page number to display\",\r\n \"OrganizationIds\": \"A list of organization ids of the records to display\",\r\n \"ComputerGroupIds\": \"A list of computer group ids of the records to display\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "A DTO containing filter parameters such as organization IDs, computer group IDs, sorting options, and pagination settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionParametersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionParametersDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionParametersDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ScheduledAgentAction": { "post": { "tags": [ "ScheduledAgentAction" ], "summary": "Inserts a new scheduled agent action.", "description": "Parameters Values:\r\n \r\n {\r\n \"ScheduledType\": \"Version Update = 1\",\r\n \"ScheduledTypePayload\": \"If ScheduledType = 1, then must include the Target TL Version Id\",\r\n \"AppliesTo\": \"A list of Applies To\",\r\n \"BatchAmount\": \"25 | 50 | 100 | 250 | 500\",\r\n \"StartDate\": \"The date to start the schedule\",\r\n \"WindowStartTime\": \"The start time used for scheduling\",\r\n \"WindowEndTime\": \"The end time used for scheduling\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "A DTO containing the details of the scheduled agent action to be created, including type, targets, and scheduling parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionInsertDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionInsertDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionInsertDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ScheduledAgentAction/Abort": { "post": { "tags": [ "ScheduledAgentAction" ], "summary": "Aborts one or more scheduled agent actions.", "description": "Parameters Values:\r\n \r\n {\r\n \"ScheduledId\": \"A value present in the response returned from GetScheduledAgentActionList\",\r\n \"AppliesTo\": \"A list of Applies To\",\r\n \"AbortAll\": \"true or false\",\r\n }\r\n\r\nIf \"AbortAll\" = \"false\", then the AppliesTo must have at least 1 record.\r\nIf \"AbortAll\" = \"true\", then the AppliesTo must be empty and all records for the ScheduledId will be aborted.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "A DTO containing the abort parameters, including the scheduled action ID and a flag indicating whether to abort all applicable actions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionAbortDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionAbortDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionAbortDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ScheduledAgentAction/Update": { "post": { "tags": [ "ScheduledAgentAction" ], "summary": "Updates one or more scheduled agent actions by setting the scheduled date to the current UTC date/time.", "description": "Parameters Values:\r\n \r\n {\r\n \"ScheduledId\": \"A value present in the response returned from GetScheduledAgentActionList\",\r\n \"AppliesTo\": \"A list of Applies To\",\r\n \"ApplyAll\": \"true or false\"\r\n }\r\n\r\nIf \"ApplyAll\" = \"false\", then AppliesTo must contain at least one record.\r\nIf \"ApplyAll\" = \"true\", then AppliesTo must be empty and all records for the ScheduledId will be updated.\r\nThe update sets the scheduled execution date/time to UTC now, causing the scheduled process\r\nto pick up and execute the actions immediately.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "A DTO containing the scheduled action update parameters, including the scheduled action ID and a flag indicating whether all applicable actions should be updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionUpdateDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScheduledAgentActionUpdateDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/SystemAudit/SystemAuditGetForHealthCenter": { "post": { "tags": [ "SystemAudit" ], "summary": "Retrieves System Audit data for the Health Center, specifically focused on login attempts.", "description": "This endpoint retrieves a paginated list of audit records related to user login attempts, \r\nfiltered by date range, search text, and whether the login was successful or denied.\r\nIt can also filter by latitude and longitude if provided in the correct format within the search text.\r\n\r\n\r\n\r\n**Search Text Usage:**\r\n\r\n* **Standard Text Search:** You can enter countries, regions, or cities to search within the audit records.\r\n* **Latitude/Longitude Search:** To search by geographical location, use the format \"lat:[latitude]&long:[longitude]\". \r\n - For example, \"lat:34.0522&long:-118.2437\" will search for audit records near Los Angeles.\r\n\r\n\r\n\r\n**Sample request:**\r\n \r\n POST /SystemAuditGetForHealthCenter\r\n {\r\n \"days\": 30,\r\n \"isLoggedIn\": false,\r\n \"pageSize\": 25,\r\n \"pageNumber\": 1,\r\n \"searchText\": \"lat:40.7128&long:-74.0060\"\r\n }\r\n \r\n POST /SystemAuditGetForHealthCenter\r\n {\r\n \"days\": 30,\r\n \"isLoggedIn\": false,\r\n \"pageSize\": 25,\r\n \"pageNumber\": 1,\r\n \"searchText\": \"United States\"\r\n }\r\n \r\n POST /SystemAuditGetForHealthCenter\r\n {\r\n \"days\": 30,\r\n \"isLoggedIn\": false,\r\n \"pageSize\": 25,\r\n \"pageNumber\": 1,\r\n \"emailAddress\": \"test.user@email.com\"\r\n }\r\n \r\n POST /SystemAuditGetForHealthCenter\r\n {\r\n \"days\": 30,\r\n \"isLoggedIn\": false,\r\n \"pageSize\": 25,\r\n \"pageNumber\": 1,\r\n \"ipAddresses\": \"123.123.123.123\"\r\n }", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters for filtering audit data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemAuditHealthCenterParams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemAuditHealthCenterParams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SystemAuditHealthCenterParams" } } } }, "responses": { "200": { "description": "Successfully retrieved the Health Center audit data." }, "400": { "description": "The request was malformed or invalid." }, "401": { "description": "The user does not have the required permissions." }, "403": { "description": "The user is not authorized to perform this action." }, "500": { "description": "An unexpected error occurred on the server." } } } }, "/portalapi/SystemAudit/SystemAuditGetLoginAttemptFiltersForHealthCenter": { "get": { "tags": [ "SystemAudit" ], "summary": "Retrieves unique emails and IP addresses from system audit data for login attempts filter.", "description": "\r\n\r\n **Sample request:**\r\n \r\n GET /SystemAuditGetLoginAttemptFiltersForHealthCenter\r\n {\r\n \"days\": 30,\r\n \"isLoggedIn\": false,\r\n \"pageSize\": 25,\r\n \"pageNumber\": 1,\r\n \"emailAddress\": \"test.user@email.com\"\r\n }\r\n \r\n GET /SystemAuditGetLoginAttemptFiltersForHealthCenter\r\n {\r\n \"days\": 30,\r\n \"isLoggedIn\": false,\r\n \"pageSize\": 25,\r\n \"pageNumber\": 1,\r\n \"ipAddresses\": \"123.123.123.123\"\r\n }", "parameters": [ { "name": "Days", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 30 } }, { "name": "SearchText", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "IsLoggedIn", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "EmailAddress", "in": "query", "schema": { "type": "string" } }, { "name": "IPAddresses", "in": "query", "schema": { "type": "string" } }, { "name": "AfterKeys", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValue" }, "nullable": true } } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved the Health Center login attempt filters." }, "400": { "description": "The request was malformed or invalid." }, "401": { "description": "The user does not have the required permissions." }, "403": { "description": "The user is not authorized to perform this action." }, "500": { "description": "An unexpected error occurred on the server." } } } }, "/portalapi/SystemAudit/SystemAuditGetByParameters": { "post": { "tags": [ "SystemAudit" ], "summary": "Retrieves System Audit records based on specified parameters.", "description": "This endpoint retrieves a paginated list of System Audit records, allowing filtering by various parameters such as username, action, IP address, effective action, details, date range, and organization.\r\n\r\n\r\n\r\n**Filtering and Search:**\r\n\r\n\r\n* **Wildcard Search:** The `Details`, `IPAddress`, `EffectiveAction`, and `Username` fields support wildcard searches.\r\n - If the search text contains an asterisk (`*`), it will be replaced with a percent sign (`%`) for the SQL LIKE operator.\r\n - If the search text does not contain an asterisk (`*`), a percent sign (`%`) will be added to both the beginning and end of the search text by default (searching for \"test\" will become \"%test%\"). This means it will search for any records that *contain* the search text.\r\n* **Date Range:** Use `StartDate` and `EndDate` to filter records within a specific date range.\r\n* **Organization:** By default, the endpoint retrieves records for the current organization. Set `ViewChildOrganizations` to `true` to include child organizations in the search. If the user is logged into the Master Organization, it is not necessary to use `ViewChildOrganizations`.\r\n\r\n\r\n\r\n**Sample Request:**\r\n \r\n POST /portalApi/SystemAuditGetByParameters\r\n {\r\n \"username\": \"*test*\", OR \"username\": \"test\",\r\n \"action\": \"Read\",\r\n \"ipAddress\": \"*\",\r\n \"effectiveAction\": \"Permitted\",\r\n \"details\": \"Viewed*\",\r\n \"startDate\": \"2023-01-01T00:00:00Z\",\r\n \"endDate\": \"2024-01-27T23:59:59Z\",\r\n \"pageSize\": 25,\r\n \"pageNumber\": 1,\r\n \"viewChildOrganizations\": false,\r\n \"objectId\": \"00000000-0000-0000-0000-000000000000\"\r\n }\r\n**This request would search for:**\r\n- Usernames that contain \"test\" anywhere.\r\n- Any IP address.\r\n- Details that start with \"Viewed\".", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters for filtering System Audit records.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemAuditParametersDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemAuditParametersDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SystemAuditParametersDto" } } } }, "responses": { "200": { "description": "Successfully retrieved the System Audit records." }, "400": { "description": "The request was malformed or invalid." }, "401": { "description": "The user is not authenticated or does not have permission to view System Audit records." }, "403": { "description": "The user is not authorized to perform this action." }, "500": { "description": "An unexpected error occurred on the server." } } } }, "/portalapi/Tag/TagGetById": { "get": { "tags": [ "Tag" ], "summary": "Get Tag by Id.", "parameters": [ { "name": "tagId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Tag/TagGetDowndownOptionsByOrganizationId": { "get": { "tags": [ "Tag" ], "summary": "Get Tag Dropdown Options.", "parameters": [ { "name": "includeBuiltIns", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "tagType", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "includeNetworkTagInMaster", "in": "query", "description": "", "schema": { "type": "boolean", "default": true } }, { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/Tag/TagUpdate": { "post": { "tags": [ "Tag" ], "summary": "Update Tag.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TagDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TagDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/ThreatLockerVersion/ThreatLockerVersionGetForDropdownList": { "get": { "tags": [ "ThreatLockerVersion" ], "summary": "Get Threatlocker Versions", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/portalapi/UploadRequest/UploadRequestInsert": { "post": { "tags": [ "UploadRequest" ], "summary": "Insert Upload Request.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UploadRequestDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/UploadRequest/UploadRequestGet": { "post": { "tags": [ "UploadRequest" ], "summary": "Get Upload Request.", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UploadRequestDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/portalapi/VDIHyperV/VDIHyperVGetTestingEnvironmentDetails": { "post": { "tags": [ "VDIHyperV" ], "summary": "Get Testing Environment Details For VDI HyperV", "parameters": [ { "name": "ManagedOrganizationId", "in": "header", "description": "Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "OverrideManagedOrganizationId", "in": "header", "description": "Override Managed Organization ID (GUID)", "schema": { "type": "string" } }, { "name": "UserInstance", "in": "header", "description": "User Data Instance identifier", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDownloadDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileDownloadDetailsDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FileDownloadDetailsDto" } } } }, "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "ActionLogCreatedByProcessesDto": { "type": "object", "properties": { "createdByProcess": { "type": "string", "default": "", "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ActionLogDto": { "type": "object", "properties": { "actionLogId": { "type": "integer", "format": "int64" }, "eActionLogId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "dateTime": { "type": "string", "format": "date-time" }, "dateTimeImported": { "type": "string", "format": "date-time" }, "organizationName": { "type": "string", "default": "", "nullable": true }, "hostname": { "type": "string", "default": "", "nullable": true }, "username": { "type": "string", "default": "", "nullable": true }, "fullPath": { "type": "string", "default": "", "nullable": true }, "policyName": { "type": "string", "default": "", "nullable": true }, "actionType": { "type": "string", "default": "", "nullable": true }, "actionTypeId": { "type": "integer", "format": "int32" }, "actionId": { "type": "integer", "format": "int32" }, "action": { "type": "string", "default": "", "nullable": true }, "isMonitorMode": { "type": "boolean" }, "monitorMode": { "type": "string", "default": "", "nullable": true }, "learningModeEndDate": { "type": "string", "format": "date-time" }, "policyId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "policyLocation": { "type": "string", "default": "", "nullable": true }, "policyOrganizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "processId": { "type": "integer", "format": "int32" }, "processPath": { "type": "string", "default": "", "nullable": true }, "hash": { "type": "string", "default": "", "nullable": true }, "createdByProcess": { "type": "string", "default": "", "nullable": true }, "data": { "type": "string", "default": "", "nullable": true }, "remotePresence": { "type": "boolean" }, "remotePresenceText": { "type": "string", "default": "", "nullable": true }, "remotePresenceThreatLockerDetected": { "type": "boolean" }, "deviceType": { "type": "string", "default": "", "nullable": true }, "cert": { "type": "string", "default": "", "nullable": true }, "certs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "certExists": { "type": "boolean" }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/Certificate" }, "nullable": true }, "certText": { "type": "string", "default": "", "nullable": true }, "organizationParents": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationParentsDto" }, "nullable": true }, "applicationOrganizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "applicationIsBuiltIn": { "type": "boolean", "nullable": true }, "applicationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "applicationName": { "type": "string", "default": "", "nullable": true }, "notes": { "type": "string", "default": "", "nullable": true }, "serialNumber": { "type": "string", "default": "", "nullable": true }, "encryption": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int64" }, "sha256Hash": { "type": "string", "default": "", "nullable": true }, "policyExists": { "type": "boolean" }, "policyEnabled": { "type": "boolean" }, "storagePolicyExists": { "type": "boolean" }, "nacPolicyExists": { "type": "boolean" }, "secureNetworkPolicyExists": { "type": "boolean" }, "twPolicyExists": { "type": "boolean" }, "webControlPolicyExists": { "type": "boolean" }, "cmPolicyExists": { "type": "boolean" }, "ringfencePolicyExists": { "type": "boolean" }, "optionToRequest": { "type": "boolean" }, "allowPermitVendorButton": { "type": "boolean" }, "effectiveAction": { "type": "string", "default": "", "nullable": true }, "encryptionStatus": { "type": "string", "default": "", "nullable": true }, "reportMissing": { "type": "boolean" }, "virusTotalCheckName": { "type": "string", "default": "", "nullable": true }, "virusTotalCheckArgument": { "type": "string", "default": "", "nullable": true }, "osType": { "type": "integer", "format": "int32" }, "isExtension": { "type": "boolean" }, "edgeStoreUrl": { "type": "string", "default": "", "nullable": true }, "chromeStoreUrl": { "type": "string", "default": "", "nullable": true }, "firefoxStoreUrl": { "type": "string", "default": "", "nullable": true }, "actionLogCreatedByProcesses": { "type": "array", "items": { "$ref": "#/components/schemas/ActionLogCreatedByProcessesDto" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int64" }, "lastSortValue": { "type": "integer", "format": "int64" }, "networkDirection": { "type": "integer", "format": "int32" }, "sourceIPAddress": { "type": "string", "nullable": true }, "destinationIPAddress": { "type": "string", "nullable": true }, "groupByCount": { "type": "integer", "format": "int32" }, "destinationPort": { "type": "string", "nullable": true }, "batchId": { "type": "string", "nullable": true }, "isProtectedProcess": { "type": "boolean" }, "memoryBytes": { "type": "integer", "format": "int64" }, "processName": { "type": "string", "nullable": true }, "parentProcessId": { "type": "integer", "format": "int32" }, "parentProcessName": { "type": "string", "nullable": true }, "parentProcessApplicationId": { "type": "string", "format": "uuid" }, "parentProcessApplicationName": { "type": "string", "nullable": true }, "parentProcessApplicationOrganizationId": { "type": "string", "format": "uuid" }, "processTreeApplicationNames": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "hasViewComputerPermission": { "type": "boolean" }, "allowFileUpload": { "type": "boolean" }, "canViewOnSystemLookup": { "type": "boolean" }, "systemLookupUrl": { "type": "string", "nullable": true }, "hasPolicyData": { "type": "boolean", "readOnly": true }, "threatLockerItem": { "$ref": "#/components/schemas/ThreatLockerItemDto" }, "integrationTypeId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "isCloudLog": { "type": "boolean", "readOnly": true }, "isCloudActionType": { "type": "boolean", "readOnly": true }, "threatSeverityLevel": { "type": "string", "nullable": true }, "engineRatings": { "type": "array", "items": { "$ref": "#/components/schemas/EngineRating" }, "nullable": true }, "isVirusTotalUnavailable": { "type": "boolean" }, "deleteFileRequestSent": { "type": "boolean", "readOnly": true }, "isAccessDevice": { "type": "boolean" } }, "additionalProperties": false }, "ActionLogParamsDto": { "type": "object", "properties": { "actionType": { "type": "string", "default": null, "nullable": true }, "sourceTableId": { "type": "integer", "format": "int32", "default": 1 }, "actionLogId": { "type": "integer", "format": "int64", "default": null, "nullable": true }, "policyId": { "type": "string", "format": "uuid", "default": null }, "actionId": { "type": "integer", "format": "int32", "default": null, "nullable": true }, "filter": { "type": "string", "default": null, "nullable": true }, "showChildOrganizations": { "type": "boolean", "default": false }, "simulateDeny": { "type": "boolean", "default": false }, "onlyTrueDenies": { "type": "boolean", "default": false }, "username": { "type": "string", "default": null, "nullable": true }, "hostname": { "type": "string", "default": "", "nullable": true }, "processId": { "type": "integer", "format": "int32", "default": null, "nullable": true }, "fullPath": { "type": "string", "default": "", "nullable": true }, "deviceType": { "type": "string", "default": null, "nullable": true }, "dateTime": { "type": "array", "items": { "type": "string", "format": "date-time" }, "default": null, "nullable": true }, "groupBy": { "type": "string", "default": null, "nullable": true }, "pageNumber": { "type": "integer", "format": "int32", "default": 1 }, "pageSize": { "type": "integer", "format": "int32", "default": 25 }, "paramsFieldsDto": { "type": "array", "items": { "$ref": "#/components/schemas/ParamsFieldsDto" }, "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "dateTimeLastImported": { "type": "string", "format": "date-time", "nullable": true }, "showTotalCount": { "type": "boolean" }, "getNewCount": { "type": "boolean" }, "exportMode": { "type": "boolean" }, "totalRows": { "type": "integer", "format": "int32" }, "useEId": { "type": "boolean" }, "lastSortValue": { "type": "integer", "format": "int64" }, "sortBy": { "type": "string", "default": "", "nullable": true }, "sortDescending": { "type": "boolean", "default": true }, "groupBys": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "actionTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "showKnownThreatsOnly": { "type": "boolean" }, "hasPolicyId": { "type": "boolean", "default": false }, "interval": { "$ref": "#/components/schemas/DateInterval" }, "elasticTimeZone": { "type": "string", "nullable": true }, "elasticAfterKeyLookup": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValue" }, "nullable": true }, "nullable": true }, "compositeAfterKeyLookup": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldValue" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "AdvRFPolicy": { "type": "object", "properties": { "policyId": { "type": "string", "format": "uuid" }, "hideCustomRules": { "type": "boolean" }, "restrictApplicationSpawning": { "type": "boolean" }, "restrictRegistryAccess": { "type": "boolean" }, "restrictFileAccess": { "type": "boolean" }, "restrictNetworkAccess": { "type": "boolean" }, "restrictApplication": { "type": "boolean" }, "rfFilePolicy": { "type": "array", "items": { "$ref": "#/components/schemas/FilePolicy" }, "nullable": true }, "rfNetworkPolicy": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkPolicy" }, "nullable": true }, "rfRegistryPolicy": { "type": "array", "items": { "$ref": "#/components/schemas/RegistryPolicy" }, "nullable": true }, "rfAssociatedApplicationPolicy": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatedApplicationPolicy" }, "nullable": true } }, "additionalProperties": false }, "ApplicationDto": { "type": "object", "properties": { "applicationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "format": "uuid" }, "description": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "osType": { "type": "integer", "format": "int32" }, "isHidden": { "type": "boolean" }, "isBuiltIn": { "type": "boolean", "readOnly": true }, "canEditApplication": { "type": "boolean" }, "canEditKeyFile": { "type": "boolean" }, "applicationFiles": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationFileDto" }, "nullable": true }, "applicationFileUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationFileDto" }, "nullable": true }, "removeApplicationFileIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "applicationUpdate": { "$ref": "#/components/schemas/ApplicationUpdateDto" }, "keyPaths": { "type": "array", "items": { "type": "string" }, "nullable": true }, "builtInApplications": { "type": "array", "items": { "$ref": "#/components/schemas/DropdownOption" }, "nullable": true }, "policyForApplicationDto": { "$ref": "#/components/schemas/PolicyForApplicationDto" }, "ipAddress": { "type": "string", "nullable": true }, "newPolicy": { "type": "boolean" }, "isMaintained": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "researchApplicationId": { "type": "string", "format": "uuid", "nullable": true }, "productName": { "type": "string", "nullable": true }, "clientApplicationName": { "type": "string", "nullable": true }, "productDescription": { "type": "string", "nullable": true }, "clientDescription": { "type": "string", "nullable": true }, "remediationText": { "type": "string", "nullable": true }, "potentialRiskStrategyText": { "type": "string", "nullable": true }, "reviewRating": { "type": "integer", "format": "int32", "nullable": true }, "concernRating": { "type": "integer", "format": "int32", "nullable": true }, "businessRating": { "type": "integer", "format": "int32", "nullable": true }, "countriesWhereCodeCompiled": { "type": "array", "items": { "$ref": "#/components/schemas/CountryBasicDto" }, "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "accessLevels": { "type": "array", "items": { "$ref": "#/components/schemas/ResearchAccessLevelDto" }, "nullable": true } }, "additionalProperties": false }, "ApplicationFileDto": { "type": "object", "properties": { "applicationFileId": { "type": "integer", "format": "int64" }, "applicationId": { "type": "string", "format": "uuid", "default": null }, "fullPath": { "type": "string", "default": "", "nullable": true }, "cert": { "type": "string", "default": "", "nullable": true }, "hash": { "type": "string", "default": "", "nullable": true }, "processPath": { "type": "string", "default": "", "nullable": true }, "notes": { "type": "string", "default": "", "nullable": true }, "installedBy": { "type": "string", "default": "", "nullable": true }, "customValues": { "type": "string", "default": "", "nullable": true }, "requiresElevation": { "type": "boolean", "default": false }, "name": { "type": "string", "default": "", "nullable": true }, "applicationFileDetails": { "type": "string", "default": "", "nullable": true }, "keyFile": { "type": "boolean", "default": false }, "originalFullPath": { "type": "string", "default": "", "nullable": true }, "originalCert": { "type": "string", "default": "", "nullable": true }, "originalHash": { "type": "string", "default": "", "nullable": true }, "originalProcessPath": { "type": "string", "default": "", "nullable": true }, "originalNotes": { "type": "string", "default": "", "nullable": true }, "originalInstalledBy": { "type": "string", "default": "", "nullable": true }, "originalCustomValues": { "type": "string", "default": "", "nullable": true }, "originalRequiresElevation": { "type": "boolean", "default": false }, "originalKeyFile": { "type": "boolean", "default": false }, "osType": { "type": "integer", "format": "int32", "default": 1 }, "isHashOnly": { "type": "boolean", "default": false }, "minSize": { "type": "integer", "format": "int64", "default": null, "nullable": true }, "maxSize": { "type": "integer", "format": "int64", "default": null, "nullable": true }, "updateStatus": { "$ref": "#/components/schemas/UpdateStatus" }, "createdBy": { "type": "string", "default": "", "nullable": true }, "applicationName": { "type": "string", "default": "", "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "default": null } }, "additionalProperties": false }, "ApplicationGetForApplicationOptionsDto": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "default": "" }, "osType": { "type": "integer", "format": "int32", "default": 1 }, "includeBuiltIn": { "type": "boolean", "default": false }, "searchText": { "type": "string", "default": "", "nullable": true }, "hostName": { "type": "string", "default": "", "nullable": true }, "appliesToId": { "type": "string", "format": "uuid", "default": "" }, "onlyPermitted": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ApplicationMatchParameterDto": { "type": "object", "properties": { "hash": { "type": "string", "default": "", "nullable": true }, "sha256": { "type": "string", "default": "", "nullable": true }, "path": { "type": "string", "default": "", "nullable": true }, "processPath": { "type": "string", "default": "", "nullable": true }, "organizationIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": null, "nullable": true }, "certs": { "type": "array", "items": { "$ref": "#/components/schemas/ThreatLockerCertDto" }, "nullable": true }, "createdBys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "osType": { "type": "integer", "format": "int32", "default": 1 }, "filename": { "type": "string", "default": "", "nullable": true }, "folder": { "type": "string", "default": "", "nullable": true }, "approvalRequestId": { "type": "string", "format": "uuid" }, "builtInPartialMatchingFiles": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationFileDto" }, "nullable": true }, "cmdLine": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "ApplicationOnlineDto": { "type": "object", "properties": { "name": { "type": "string", "default": "", "nullable": true }, "applicationName": { "type": "string", "default": "", "nullable": true }, "applicationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "organizationName": { "type": "string", "default": "", "nullable": true }, "osType": { "type": "integer", "format": "int32" }, "suggestedPolicyId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "isMaintained": { "type": "boolean" }, "isKeyFile": { "type": "boolean" }, "lastUpdated": { "type": "string", "format": "date-time" }, "researchApplicationId": { "type": "string", "format": "uuid", "nullable": true }, "isBuiltIn": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ApplicationUpdateDto": { "type": "object", "properties": { "applicationUpdateId": { "type": "string", "format": "uuid" }, "applicationId": { "type": "string", "format": "uuid" }, "automaticUpdateLink": { "type": "string", "nullable": true }, "automaticUpdateLinkList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "manualUpdateLink": { "type": "string", "nullable": true }, "updateInstructions": { "type": "string", "nullable": true }, "coreFileExeName": { "type": "string", "nullable": true }, "autoAppUpdateDetails": { "type": "string", "nullable": true }, "enableUpdateChecks": { "type": "boolean" }, "isCoreFileApplication": { "type": "boolean" }, "updateRequired": { "type": "boolean" }, "checkCycle": { "type": "integer", "format": "int32" }, "checkLength": { "type": "integer", "format": "int32" }, "appTeamCheckPoints": { "type": "integer", "format": "int32" }, "appTeamUpdatePoints": { "type": "integer", "format": "int32" }, "status": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ApprovalRequestAppliesToType": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "ApprovalRequestAuthorizeDto": { "type": "object", "properties": { "approvalRequestId": { "type": "string", "format": "uuid", "default": null }, "message": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "ApprovalRequestDto": { "type": "object", "properties": { "statusIdEscalatedToMSP": { "type": "integer", "format": "int32" }, "statusIdEscalatedByCustomer": { "type": "integer", "format": "int32" }, "masterOrganizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "approvedBy": { "type": "string", "default": "", "nullable": true }, "approvalRequestId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "dateTime": { "type": "string", "format": "date-time" }, "path": { "type": "string", "default": "", "nullable": true }, "hash": { "type": "string", "default": "", "nullable": true }, "username": { "type": "string", "default": "", "nullable": true }, "hostname": { "type": "string", "default": "", "nullable": true }, "statusId": { "type": "integer", "format": "int32" }, "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "organizationName": { "type": "string", "default": "", "nullable": true }, "json": { "type": "string", "default": "", "nullable": true }, "ticketId": { "type": "string", "default": "", "nullable": true }, "requestor": { "type": "string", "default": "", "nullable": true }, "requestorReason": { "type": "string", "default": "", "nullable": true }, "requestorEmailAddress": { "type": "string", "default": "", "nullable": true }, "comments": { "type": "string", "default": "", "nullable": true }, "actionDate": { "type": "string", "format": "date-time", "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "multiLevelApprovalRequestId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "approvalNumber": { "type": "integer", "format": "int32" }, "approvedByTierLevel": { "type": "integer", "format": "int32" }, "tempPolicyId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "policyId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "tempApplicationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "applicationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "multiLevelApprovalStatusId": { "type": "integer", "format": "int32" }, "initialApprovalTierLevel": { "type": "integer", "format": "int32" }, "approvalCount": { "type": "integer", "format": "int32" }, "pendingTierLevel": { "type": "integer", "format": "int32" }, "hasPendingApprovalRequest": { "type": "boolean" }, "ipAddress": { "type": "string", "default": "", "nullable": true }, "isAssigned": { "type": "boolean", "default": false, "nullable": true, "readOnly": true }, "assigneeUserId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "threatLockerDataCenterId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "instanceName": { "type": "string", "default": "", "nullable": true }, "assigneeUsername": { "type": "string", "default": "", "nullable": true }, "assigneeFirstName": { "type": "string", "default": "", "nullable": true }, "assigneeLastname": { "type": "string", "default": "", "nullable": true }, "threatLockerActionDto": { "$ref": "#/components/schemas/ThreatLockerActionDto" }, "notes": { "type": "string", "default": "", "nullable": true }, "signature": { "type": "string", "default": "", "nullable": true }, "tlInstructions": { "type": "string", "default": "", "nullable": true }, "suggestCustomRule": { "type": "boolean", "nullable": true }, "authorizeForPermit": { "type": "boolean", "nullable": true }, "portalApiUrl": { "type": "string", "default": "", "nullable": true }, "cyberHeroManagementConfigured": { "type": "boolean" }, "maxTriggeredStartDate": { "type": "string", "format": "date-time", "nullable": true }, "isEscalatedByCyberHero": { "type": "boolean", "readOnly": true }, "isEscalatedByCustomer": { "type": "boolean", "readOnly": true }, "ticketApprovalManager": { "type": "string", "default": "", "nullable": true }, "showMfaChallenge": { "type": "boolean" }, "showMfaRegistration": { "type": "boolean" }, "linkedMfaUser": { "type": "string", "nullable": true }, "serialNumber": { "type": "string", "default": "", "nullable": true }, "approvalRequestTimerDto": { "$ref": "#/components/schemas/ApprovalRequestTimerDto" }, "canRequestNewBuiltIn": { "type": "boolean", "default": false }, "isAssigneeLoggedIntoMaster": { "type": "boolean", "default": false }, "retrievedAssigneeUsername": { "type": "boolean" }, "count": { "type": "integer", "format": "int32" }, "assigneeOrganizationId": { "type": "string", "format": "uuid", "default": null, "nullable": true }, "isVIPOrganization": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ApprovalRequestMergeType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "ApprovalRequestParametersDto": { "type": "object", "properties": { "statusId": { "type": "integer", "format": "int32", "default": 1 }, "searchText": { "type": "string", "default": "", "nullable": true }, "userApprovalTierLevel": { "type": "integer", "format": "int32" }, "showCurrentTierOnly": { "type": "boolean", "default": false }, "showChildOrganizations": { "type": "boolean", "default": false }, "requestTypeId": { "type": "integer", "format": "int32" }, "orderBy": { "type": "string", "default": "datetime", "nullable": true }, "isAscending": { "type": "boolean", "default": false }, "actionType": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "default": 25 }, "pageNumber": { "type": "integer", "format": "int32", "default": 1 }, "vipOrganizationsFilter": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ApprovalRequestTimerDto": { "type": "object", "properties": { "approvalRequestId": { "type": "string", "format": "uuid" }, "requestDate": { "type": "string", "format": "date-time" }, "assignedDate": { "type": "string", "format": "date-time" }, "escalatedDate": { "type": "string", "format": "date-time" }, "returnedDate": { "type": "string", "format": "date-time" }, "reassignedDate": { "type": "string", "format": "date-time" }, "actionedDate": { "type": "string", "format": "date-time" }, "totalTimeInSeconds": { "type": "integer", "format": "int32", "default": 0 } }, "additionalProperties": false }, "ApprovalRequestUpdateParametersDto": { "type": "object", "properties": { "approvalRequestDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalRequestDto" }, "nullable": true }, "type": { "type": "string", "default": "", "nullable": true }, "ignoreSubject": { "type": "string", "default": "", "nullable": true }, "ignoreReason": { "type": "string", "default": "", "nullable": true }, "responseSubject": { "type": "string", "default": "", "nullable": true }, "responseReason": { "type": "string", "default": "", "nullable": true }, "rejectReason": { "type": "string", "default": "", "nullable": true, "deprecated": true }, "isVDI": { "type": "boolean" }, "notifyOnIgnore": { "type": "boolean" }, "notifyOnResponse": { "type": "boolean" }, "usingCustomApprovals": { "type": "boolean" }, "allowedApprovalRequestDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalRequestDto" }, "nullable": true }, "deniedApprovalRequestDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ApprovalRequestDto" }, "nullable": true } }, "additionalProperties": false }, "Assembly": { "type": "object", "properties": { "definedTypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "exportedTypes": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "codeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "entryPoint": { "$ref": "#/components/schemas/MethodInfo" }, "fullName": { "type": "string", "nullable": true, "readOnly": true }, "imageRuntimeVersion": { "type": "string", "nullable": true, "readOnly": true }, "isDynamic": { "type": "boolean", "readOnly": true }, "location": { "type": "string", "nullable": true, "readOnly": true }, "reflectionOnly": { "type": "boolean", "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "isFullyTrusted": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "escapedCodeBase": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "manifestModule": { "$ref": "#/components/schemas/Module" }, "modules": { "type": "array", "items": { "$ref": "#/components/schemas/Module" }, "nullable": true, "readOnly": true }, "globalAssemblyCache": { "type": "boolean", "readOnly": true, "deprecated": true }, "hostContext": { "type": "integer", "format": "int64", "readOnly": true }, "securityRuleSet": { "$ref": "#/components/schemas/SecurityRuleSet" } }, "additionalProperties": false }, "AssociatedApplicationPolicy": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "applicationId": { "type": "string", "nullable": true }, "osType": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BoolQuery": { "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "filter": { "type": "array", "items": { "$ref": "#/components/schemas/Query" }, "nullable": true }, "minimumShouldMatch": { "$ref": "#/components/schemas/MinimumShouldMatch" }, "must": { "type": "array", "items": { "$ref": "#/components/schemas/Query" }, "nullable": true }, "mustNot": { "type": "array", "items": { "$ref": "#/components/schemas/Query" }, "nullable": true }, "queryName": { "type": "string", "nullable": true }, "should": { "type": "array", "items": { "$ref": "#/components/schemas/Query" }, "nullable": true } }, "additionalProperties": false }, "BoostingQuery": { "required": [ "negative", "negativeBoost", "positive" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "negative": { "$ref": "#/components/schemas/Query" }, "negativeBoost": { "type": "number", "format": "double" }, "positive": { "$ref": "#/components/schemas/Query" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BoundaryScanner": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "CallingConventions": { "enum": [ 1, 2, 3, 32, 64 ], "type": "integer", "format": "int32" }, "Certificate": { "type": "object", "properties": { "subject": { "type": "string", "default": "", "nullable": true }, "sha": { "type": "string", "default": "", "nullable": true }, "value": { "type": "string", "default": "", "nullable": true }, "validCert": { "type": "boolean" } }, "additionalProperties": false }, "ChildScoreMode": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "CombinedFieldsOperator": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "CombinedFieldsQuery": { "required": [ "fields", "query" ], "type": "object", "properties": { "autoGenerateSynonymsPhraseQuery": { "type": "boolean", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "minimumShouldMatch": { "$ref": "#/components/schemas/MinimumShouldMatch" }, "operator": { "$ref": "#/components/schemas/CombinedFieldsOperator" }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "zeroTermsQuery": { "$ref": "#/components/schemas/CombinedFieldsZeroTerms" } }, "additionalProperties": false }, "CombinedFieldsZeroTerms": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "CommonTermsQuery": { "required": [ "field", "query" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "cutoffFrequency": { "type": "number", "format": "double", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "highFreqOperator": { "$ref": "#/components/schemas/Operator" }, "lowFreqOperator": { "$ref": "#/components/schemas/Operator" }, "minimumShouldMatch": { "$ref": "#/components/schemas/MinimumShouldMatch" }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ComputerAdvancedParameter": { "type": "object", "properties": { "fieldNumericValue": { "$ref": "#/components/schemas/ComputerAdvancedSearchFieldEnum" }, "filterRuleType": { "$ref": "#/components/schemas/ComputerAdvancedSearchFilterRuleEnum" }, "searchValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ComputerAdvancedSearchFieldEnum": { "enum": [ 1, 2, 4, 6, 8 ], "type": "integer", "format": "int32" }, "ComputerAdvancedSearchFilterRuleEnum": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "ComputerChannelDto": { "type": "object", "properties": { "computerDetailDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerDataForChannelDto" }, "nullable": true }, "updateChannel": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ComputerCheckinParametersDto": { "type": "object", "properties": { "computerId": { "type": "string", "format": "uuid" }, "pageSize": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "hideHeartbeat": { "type": "boolean" }, "showTotalCount": { "type": "boolean" } }, "additionalProperties": false }, "ComputerDataForChannelDto": { "type": "object", "properties": { "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "updateChannel": { "type": "integer", "format": "int32", "default": "", "nullable": true }, "computerName": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "ComputerDataForDisableProtectionDto": { "type": "object", "properties": { "action": { "type": "string", "default": "", "nullable": true }, "computerGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerName": { "type": "string", "default": "", "nullable": true }, "maintenanceEndDate": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "startDateTime": { "type": "string", "format": "date-time", "default": null, "nullable": true } }, "additionalProperties": false }, "ComputerDataForEnableProtectionDto": { "type": "object", "properties": { "appliesToType": { "type": "string", "default": "", "nullable": true }, "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerInstallDate": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "computerName": { "type": "string", "default": "", "nullable": true }, "maintenanceEndDate": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "maintenanceTypeId": { "type": "integer", "format": "int32" }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "startDateTime": { "type": "string", "format": "date-time", "default": null, "nullable": true } }, "additionalProperties": false }, "ComputerDataForRescanBaselineDto": { "type": "object", "properties": { "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerName": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "ComputerDataForTransferDto": { "type": "object", "properties": { "computerGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerName": { "type": "string", "default": "", "nullable": true }, "group": { "type": "string", "default": "", "nullable": true }, "hostname": { "type": "string", "default": "", "nullable": true }, "maintenanceTypeId": { "type": "integer", "format": "int32" }, "operatingSystem": { "type": "string", "default": "", "nullable": true }, "organization": { "type": "string", "default": "", "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "osType": { "type": "integer", "format": "int32", "default": 1 } }, "additionalProperties": false }, "ComputerDataForUpdateModeDto": { "type": "object", "properties": { "action": { "type": "string", "default": "", "nullable": true }, "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerName": { "type": "string", "default": "", "nullable": true }, "computerInstallDate": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "isIsolated": { "type": "boolean", "default": false }, "isLockedOut": { "type": "boolean", "default": false }, "lastVersionChange": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "maintenanceTypeId": { "type": "integer", "format": "int32" }, "maintenanceEndDate": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "osType": { "type": "integer", "format": "int32" }, "pendingBaseFiles": { "type": "boolean", "default": false }, "threatLockerVersion": { "type": "string", "default": "", "nullable": true }, "threatLockerVersionId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "threatLockerVersionGroup": { "type": "string", "default": "", "nullable": true }, "threatLockerVersionGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "activeMaintenanceModes": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceModeDto" }, "nullable": true }, "ticketNumber": { "type": "string", "default": "", "nullable": true }, "notes": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "ComputerDataForVersionDto": { "type": "object", "properties": { "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerName": { "type": "string", "default": "", "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "osType": { "type": "integer", "format": "int32" }, "threatLockerVersion": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "ComputerDisabledProtectionDto": { "type": "object", "properties": { "computerDetailDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerDataForDisableProtectionDto" }, "nullable": true }, "endDate": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "startDate": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "maintenanceModeType": { "type": "integer", "format": "int32", "nullable": true }, "permitEnd": { "type": "boolean", "default": false, "nullable": true }, "applicationId": { "type": "string", "default": "autocomp", "nullable": true } }, "additionalProperties": false }, "ComputerDownloadParameterDto": { "type": "object", "properties": { "platform": { "type": "string", "default": "", "nullable": true }, "apiKey": { "type": "string", "default": "", "nullable": true }, "brand": { "type": "string", "default": "Threatlocker", "nullable": true }, "groupName": { "type": "string", "default": "", "nullable": true }, "fileType": { "type": "string", "default": "", "nullable": true }, "isUpdate": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ComputerEnableProtectionDto": { "type": "object", "properties": { "computerDetailDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerDataForEnableProtectionDto" }, "nullable": true } }, "additionalProperties": false }, "ComputerGroupItemDto": { "type": "object", "properties": { "computerGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string", "default": "", "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "organizationName": { "type": "string", "default": "", "nullable": true }, "default": { "type": "boolean", "nullable": true }, "osType": { "type": "integer", "format": "int32" }, "isGlobal": { "type": "boolean" } }, "additionalProperties": false }, "ComputerParameterDto": { "type": "object", "properties": { "searchText": { "type": "string", "default": "", "nullable": true }, "computerGroup": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "orderBy": { "type": "string", "default": "computername", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "default": 25 }, "pageNumber": { "type": "integer", "format": "int32", "default": 1 }, "childOrganizations": { "type": "boolean", "default": false }, "action": { "type": "string", "default": "", "nullable": true }, "isAscending": { "type": "boolean", "default": true }, "kindOfAction": { "type": "string", "default": "", "nullable": true }, "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "showLastCheckIn": { "type": "boolean", "default": true }, "showDeleted": { "type": "boolean", "default": false }, "searchBy": { "type": "integer", "format": "int32", "nullable": true }, "threatlockerVersion": { "type": "string", "default": "All", "nullable": true }, "isExport": { "type": "boolean", "default": "false" }, "advancedSearchParameters": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerAdvancedParameter" }, "nullable": true } }, "additionalProperties": false }, "ComputerRescanBaselineDto": { "type": "object", "properties": { "computerDetailDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerDataForRescanBaselineDto" }, "nullable": true }, "enableLearning": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ComputerRestartServiceDto": { "type": "object", "properties": { "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerName": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "ComputerTransferDto": { "type": "object", "properties": { "computerDetailDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerDataForTransferDto" }, "nullable": true }, "enableLearningRescan": { "type": "boolean", "default": false }, "targetComputerGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "targetOrganizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" } }, "additionalProperties": false }, "ComputerUpdateDto": { "type": "object", "properties": { "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string", "default": "", "nullable": true }, "useProxyServer": { "type": "boolean", "default": false }, "proxyServerOption": { "type": "string", "default": "", "nullable": true }, "proxyUrlEntry": { "type": "string", "default": "", "nullable": true }, "proxyURL": { "type": "string", "default": "", "nullable": true }, "options": { "type": "array", "items": { "type": "string" }, "nullable": true }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ComputerUpdateMaintenanceModeDto": { "type": "object", "properties": { "applicationId": { "type": "string", "nullable": true }, "computerDetailDto": { "$ref": "#/components/schemas/ComputerDataForUpdateModeDto" } }, "additionalProperties": false }, "ComputerUpdateToFinishMaintenanceModeDto": { "type": "object", "properties": { "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "hostname": { "type": "string", "default": "", "nullable": true }, "isIsolated": { "type": "boolean", "default": false }, "isLockedOut": { "type": "boolean", "default": false }, "lastVersionChange": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "maintenanceTypeId": { "type": "integer", "format": "int32" }, "monitorOnlyDateTime": { "type": "string", "format": "date-time" }, "maintenanceEndDate": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "osType": { "type": "integer", "format": "int32" }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "pendingBaseFiles": { "type": "boolean", "default": false }, "threatLockerVersion": { "type": "string", "default": "", "nullable": true }, "threatLockerVersionId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "threatLockerVersionGroup": { "type": "string", "default": "", "nullable": true }, "threatLockerVersionGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true } }, "additionalProperties": false }, "ComputerVersionDto": { "type": "object", "properties": { "threatLockerVersion": { "type": "string", "default": "", "nullable": true }, "threatLockerVersionId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerDetailDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ComputerDataForVersionDto" }, "nullable": true } }, "additionalProperties": false }, "ConstantScoreQuery": { "required": [ "filter" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "filter": { "$ref": "#/components/schemas/Query" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConstructorInfo": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "type": "string", "nullable": true, "readOnly": true }, "reflectedType": { "type": "string", "nullable": true, "readOnly": true }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "CountryBasicDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "tooltip": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomAttributeData": { "type": "object", "properties": { "attributeType": { "type": "string", "nullable": true, "readOnly": true }, "constructor": { "$ref": "#/components/schemas/ConstructorInfo" }, "constructorArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "nullable": true, "readOnly": true }, "namedArguments": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeNamedArgument" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CustomAttributeNamedArgument": { "type": "object", "properties": { "memberInfo": { "$ref": "#/components/schemas/MemberInfo" }, "typedValue": { "$ref": "#/components/schemas/CustomAttributeTypedArgument" }, "memberName": { "type": "string", "nullable": true, "readOnly": true }, "isField": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CustomAttributeTypedArgument": { "type": "object", "properties": { "argumentType": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "DateInterval": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "DayOfWeek": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "DisMaxQuery": { "required": [ "queries" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "queries": { "type": "array", "items": { "$ref": "#/components/schemas/Query" }, "nullable": true }, "queryName": { "type": "string", "nullable": true }, "tieBreaker": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "DistanceUnit": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "DropdownOption": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "numericValue": { "type": "integer", "format": "int32", "nullable": true }, "entityType": { "type": "integer", "format": "int32", "nullable": true }, "parentId": { "type": "string", "format": "uuid", "nullable": true }, "disabled": { "type": "boolean" }, "tooltip": { "type": "string", "nullable": true }, "featureConfigurationIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "featureId": { "type": "integer", "format": "int32", "nullable": true }, "displayOrder": { "type": "integer", "format": "int32" }, "isSupported": { "type": "boolean", "nullable": true }, "isExpandable": { "type": "boolean", "default": false }, "extendedProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ElasticGroupOrder": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "ElasticGrouping": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "Top level fields to group by (keyword / numeric fields, e.g. \"hostname.keyword\")", "nullable": true }, "nested": { "$ref": "#/components/schemas/ElasticNestedGrouping" }, "latestField": { "type": "string", "description": "Date field that decides a group's latest document", "nullable": true }, "order": { "$ref": "#/components/schemas/ElasticGroupOrder" }, "descending": { "type": "boolean" }, "maxGroups": { "type": "integer", "description": "Most groups to read - defaults to 10,000 when paging and no limit with SkipPaging", "format": "int32", "nullable": true }, "countAllGroups": { "type": "boolean", "description": "When there are more than PortalApi.Common.ElasticSearchHelper.ElasticGrouping.MaxGroups, count them all for the total (one top level field or nested only - otherwise the total is MaxGroups)" }, "snapshotField": { "type": "string", "nullable": true }, "snapshotTime": { "type": "string", "format": "date-time", "nullable": true }, "refreshRanking": { "type": "boolean" } }, "additionalProperties": false, "description": "What to group by. Groups are ranked (key, document count and latest date only), ordered, then the latest document is fetched for just the groups being returned." }, "ElasticNestedGrouping": { "type": "object", "properties": { "path": { "type": "string", "description": "Nested object path, e.g. \"attrs\"", "nullable": true }, "valueField": { "type": "string", "description": "Value to group by, e.g. \"attrs.value.keyword\"", "nullable": true }, "filterField": { "type": "string", "description": "Only nested objects where this field is one of PortalApi.Common.ElasticSearchHelper.ElasticNestedGrouping.FilterValues, e.g. \"attrs.attributeID\"", "nullable": true }, "filterValues": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValue" }, "nullable": true } }, "additionalProperties": false }, "EngineRating": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "rating": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExistsQuery": { "required": [ "field" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Expression": { "type": "object", "properties": { "nodeType": { "$ref": "#/components/schemas/ExpressionType" }, "type": { "type": "string", "nullable": true, "readOnly": true }, "canReduce": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ExpressionType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84 ], "type": "integer", "format": "int32" }, "Field": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "expression": { "$ref": "#/components/schemas/Expression" }, "property": { "$ref": "#/components/schemas/PropertyInfo" }, "boost": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "FieldAndFormat": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/Field" }, "format": { "type": "string", "nullable": true }, "includeUnmapped": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "FieldCollapse": { "required": [ "field" ], "type": "object", "properties": { "collapse": { "$ref": "#/components/schemas/FieldCollapse" }, "field": { "$ref": "#/components/schemas/Field" }, "innerHits": { "type": "array", "items": { "$ref": "#/components/schemas/InnerHits" }, "nullable": true }, "maxConcurrentGroupSearches": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "FieldInt32KeyValuePair": { "type": "object", "properties": { "key": { "$ref": "#/components/schemas/Field" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FieldLookup": { "required": [ "id" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "index": { "$ref": "#/components/schemas/IndexName" }, "path": { "$ref": "#/components/schemas/Field" }, "routing": { "$ref": "#/components/schemas/Routing" } }, "additionalProperties": false }, "FieldSort": { "required": [ "field" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/Field" }, "format": { "type": "string", "nullable": true }, "missing": { "nullable": true }, "mode": { "$ref": "#/components/schemas/SortMode" }, "nested": { "$ref": "#/components/schemas/NestedSortValue" }, "numericType": { "$ref": "#/components/schemas/FieldSortNumericType" }, "order": { "$ref": "#/components/schemas/SortOrder" }, "unmappedType": { "$ref": "#/components/schemas/FieldType" } }, "additionalProperties": false }, "FieldSortNumericType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "FieldType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48 ], "type": "integer", "format": "int32" }, "FieldValue": { "type": "object", "properties": { "kind": { "$ref": "#/components/schemas/ValueKind" }, "value": { "nullable": true, "readOnly": true }, "isString": { "type": "boolean", "readOnly": true }, "isBool": { "type": "boolean", "readOnly": true }, "isLong": { "type": "boolean", "readOnly": true }, "isDouble": { "type": "boolean", "readOnly": true }, "isNull": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FieldValueFactorModifier": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "format": "int32" }, "FieldValueFactorScoreFunction": { "required": [ "field" ], "type": "object", "properties": { "factor": { "type": "number", "format": "double", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "missing": { "type": "number", "format": "double", "nullable": true }, "modifier": { "$ref": "#/components/schemas/FieldValueFactorModifier" } }, "additionalProperties": false }, "FileDownloadDetailsDto": { "type": "object", "properties": { "approvalRequestId": { "type": "string", "format": "uuid" }, "filename": { "type": "string", "nullable": true }, "fileUrl": { "type": "string", "nullable": true }, "eActionLogId": { "type": "string", "nullable": true }, "sourceTableId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "FileExclusionDto": { "type": "object", "properties": { "policyId": { "type": "string", "format": "uuid" }, "tagItemType": { "type": "integer", "format": "int32" }, "path": { "type": "string", "nullable": true }, "permission": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FilePolicy": { "type": "object", "properties": { "filePolicyId": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "action": { "type": "integer", "description": "1 = Permit, 2 = Deny", "format": "int32" }, "permission": { "type": "integer", "description": "1 = Read, 2 = Write", "format": "int32" } }, "additionalProperties": false }, "FunctionBoostMode": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "FunctionScore": { "type": "object", "properties": { "exp": { "$ref": "#/components/schemas/IDecayFunction" }, "fieldValueFactor": { "$ref": "#/components/schemas/FieldValueFactorScoreFunction" }, "gauss": { "$ref": "#/components/schemas/IDecayFunction" }, "linear": { "$ref": "#/components/schemas/IDecayFunction" }, "randomScore": { "$ref": "#/components/schemas/RandomScoreFunction" }, "scriptScore": { "$ref": "#/components/schemas/ScriptScoreFunction" }, "filter": { "$ref": "#/components/schemas/Query" }, "weight": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "FunctionScoreMode": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "FunctionScoreQuery": { "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "boostMode": { "$ref": "#/components/schemas/FunctionBoostMode" }, "functions": { "type": "array", "items": { "$ref": "#/components/schemas/FunctionScore" }, "nullable": true }, "maxBoost": { "type": "number", "format": "double", "nullable": true }, "minScore": { "type": "number", "format": "double", "nullable": true }, "query": { "$ref": "#/components/schemas/Query" }, "queryName": { "type": "string", "nullable": true }, "scoreMode": { "$ref": "#/components/schemas/FunctionScoreMode" } }, "additionalProperties": false }, "Fuzziness": { "type": "object", "properties": { "tag": { "$ref": "#/components/schemas/UnionTag" }, "value1": { "type": "string", "nullable": true, "readOnly": true }, "value2": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "FuzzyQuery": { "required": [ "field", "value" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "fuzziness": { "$ref": "#/components/schemas/Fuzziness" }, "maxExpansions": { "type": "integer", "format": "int32", "nullable": true }, "prefixLength": { "type": "integer", "format": "int32", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "rewrite": { "type": "string", "nullable": true }, "transpositions": { "type": "boolean", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "GeoBoundingBoxQuery": { "required": [ "boundingBox", "field" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "boundingBox": { "$ref": "#/components/schemas/GeoBounds" }, "field": { "$ref": "#/components/schemas/Field" }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/GeoExecution" }, "validationMethod": { "$ref": "#/components/schemas/GeoValidationMethod" } }, "additionalProperties": false }, "GeoBounds": { "type": "object", "properties": { "isCoordinates": { "type": "boolean", "readOnly": true }, "isTopLeftBottomRight": { "type": "boolean", "readOnly": true }, "isTopRightBottomLeft": { "type": "boolean", "readOnly": true }, "isWkt": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "GeoDistanceQuery": { "required": [ "distance", "field", "location" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "distance": { "type": "string", "nullable": true }, "distanceType": { "$ref": "#/components/schemas/GeoDistanceType" }, "field": { "$ref": "#/components/schemas/Field" }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "location": { "$ref": "#/components/schemas/GeoLocation" }, "queryName": { "type": "string", "nullable": true }, "validationMethod": { "$ref": "#/components/schemas/GeoValidationMethod" } }, "additionalProperties": false }, "GeoDistanceSort": { "required": [ "field", "location" ], "type": "object", "properties": { "distanceType": { "$ref": "#/components/schemas/GeoDistanceType" }, "field": { "$ref": "#/components/schemas/Field" }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "location": { "type": "array", "items": { "$ref": "#/components/schemas/GeoLocation" }, "nullable": true }, "mode": { "$ref": "#/components/schemas/SortMode" }, "nested": { "$ref": "#/components/schemas/NestedSortValue" }, "order": { "$ref": "#/components/schemas/SortOrder" }, "unit": { "$ref": "#/components/schemas/DistanceUnit" } }, "additionalProperties": false }, "GeoDistanceType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "GeoExecution": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "GeoGridQuery": { "required": [ "field" ], "type": "object", "properties": { "geohash": { "type": "string", "nullable": true }, "geohex": { "type": "string", "nullable": true }, "geotile": { "type": "string", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GeoLocation": { "type": "object", "properties": { "isLatitudeLongitude": { "type": "boolean", "readOnly": true }, "isGeoHash": { "type": "boolean", "readOnly": true }, "isCoordinates": { "type": "boolean", "readOnly": true }, "isText": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "GeoPolygonPoints": { "required": [ "points" ], "type": "object", "properties": { "points": { "type": "array", "items": { "$ref": "#/components/schemas/GeoLocation" }, "nullable": true } }, "additionalProperties": false }, "GeoPolygonQuery": { "required": [ "field", "polygon" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "polygon": { "$ref": "#/components/schemas/GeoPolygonPoints" }, "queryName": { "type": "string", "nullable": true }, "validationMethod": { "$ref": "#/components/schemas/GeoValidationMethod" } }, "additionalProperties": false }, "GeoShapeFieldQuery": { "type": "object", "properties": { "indexedShape": { "$ref": "#/components/schemas/FieldLookup" }, "relation": { "$ref": "#/components/schemas/GeoShapeRelation" }, "shape": { "nullable": true } }, "additionalProperties": false }, "GeoShapeQuery": { "required": [ "field", "shape" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "shape": { "$ref": "#/components/schemas/GeoShapeFieldQuery" } }, "additionalProperties": false }, "GeoShapeRelation": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "GeoValidationMethod": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "HasChildQuery": { "required": [ "query", "type" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "innerHits": { "$ref": "#/components/schemas/InnerHits" }, "maxChildren": { "type": "integer", "format": "int32", "nullable": true }, "minChildren": { "type": "integer", "format": "int32", "nullable": true }, "query": { "$ref": "#/components/schemas/Query" }, "queryName": { "type": "string", "nullable": true }, "scoreMode": { "$ref": "#/components/schemas/ChildScoreMode" }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HasParentQuery": { "required": [ "parentType", "query" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "innerHits": { "$ref": "#/components/schemas/InnerHits" }, "parentType": { "type": "string", "nullable": true }, "query": { "$ref": "#/components/schemas/Query" }, "queryName": { "type": "string", "nullable": true }, "score": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Highlight": { "required": [ "fields" ], "type": "object", "properties": { "boundaryChars": { "type": "string", "nullable": true }, "boundaryMaxScan": { "type": "integer", "format": "int32", "nullable": true }, "boundaryScanner": { "$ref": "#/components/schemas/BoundaryScanner" }, "boundaryScannerLocale": { "type": "string", "nullable": true }, "encoder": { "$ref": "#/components/schemas/HighlighterEncoder" }, "fields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/HighlightField" }, "nullable": true }, "forceSource": { "type": "boolean", "nullable": true }, "fragmenter": { "$ref": "#/components/schemas/HighlighterFragmenter" }, "fragmentSize": { "type": "integer", "format": "int32", "nullable": true }, "highlightFilter": { "type": "boolean", "nullable": true }, "highlightQuery": { "$ref": "#/components/schemas/Query" }, "maxAnalyzedOffset": { "type": "integer", "format": "int32", "nullable": true }, "maxFragmentLength": { "type": "integer", "format": "int32", "nullable": true }, "noMatchSize": { "type": "integer", "format": "int32", "nullable": true }, "numberOfFragments": { "type": "integer", "format": "int32", "nullable": true }, "options": { "type": "object", "additionalProperties": { }, "nullable": true }, "order": { "$ref": "#/components/schemas/HighlighterOrder" }, "phraseLimit": { "type": "integer", "format": "int32", "nullable": true }, "postTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "preTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "requireFieldMatch": { "type": "boolean", "nullable": true }, "tagsSchema": { "$ref": "#/components/schemas/HighlighterTagsSchema" }, "type": { "$ref": "#/components/schemas/HighlighterType" } }, "additionalProperties": false }, "HighlightField": { "type": "object", "properties": { "boundaryChars": { "type": "string", "nullable": true }, "boundaryMaxScan": { "type": "integer", "format": "int32", "nullable": true }, "boundaryScanner": { "$ref": "#/components/schemas/BoundaryScanner" }, "boundaryScannerLocale": { "type": "string", "nullable": true }, "forceSource": { "type": "boolean", "nullable": true }, "fragmenter": { "$ref": "#/components/schemas/HighlighterFragmenter" }, "fragmentOffset": { "type": "integer", "format": "int32", "nullable": true }, "fragmentSize": { "type": "integer", "format": "int32", "nullable": true }, "highlightFilter": { "type": "boolean", "nullable": true }, "highlightQuery": { "$ref": "#/components/schemas/Query" }, "matchedFields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "maxAnalyzedOffset": { "type": "integer", "format": "int32", "nullable": true }, "maxFragmentLength": { "type": "integer", "format": "int32", "nullable": true }, "noMatchSize": { "type": "integer", "format": "int32", "nullable": true }, "numberOfFragments": { "type": "integer", "format": "int32", "nullable": true }, "options": { "type": "object", "additionalProperties": { }, "nullable": true }, "order": { "$ref": "#/components/schemas/HighlighterOrder" }, "phraseLimit": { "type": "integer", "format": "int32", "nullable": true }, "postTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "preTags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "requireFieldMatch": { "type": "boolean", "nullable": true }, "tagsSchema": { "$ref": "#/components/schemas/HighlighterTagsSchema" }, "type": { "$ref": "#/components/schemas/HighlighterType" } }, "additionalProperties": false }, "HighlighterEncoder": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "HighlighterFragmenter": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "HighlighterOrder": { "enum": [ 0 ], "type": "integer", "format": "int32" }, "HighlighterTagsSchema": { "enum": [ 0 ], "type": "integer", "format": "int32" }, "HighlighterType": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ICustomAttributeProvider": { "type": "object", "additionalProperties": false }, "IDecayFunction": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IDistanceFeatureQuery": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "IRangeQuery": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Id": { "type": "object", "additionalProperties": false }, "Ids": { "type": "object", "additionalProperties": false }, "IdsQuery": { "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "values": { "$ref": "#/components/schemas/Ids" } }, "additionalProperties": false }, "IndexName": { "type": "object", "additionalProperties": false }, "InnerHits": { "type": "object", "properties": { "collapse": { "$ref": "#/components/schemas/FieldCollapse" }, "docvalueFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldAndFormat" }, "nullable": true }, "explain": { "type": "boolean", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "from": { "type": "integer", "format": "int32", "nullable": true }, "highlight": { "$ref": "#/components/schemas/Highlight" }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "name": { "$ref": "#/components/schemas/Name" }, "scriptFields": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ScriptField" }, "nullable": true }, "seqNoPrimaryTerm": { "type": "boolean", "nullable": true }, "size": { "type": "integer", "format": "int32", "nullable": true }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/SortOptions" }, "nullable": true }, "source": { "$ref": "#/components/schemas/SourceConfig" }, "storedFields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "trackScores": { "type": "boolean", "nullable": true }, "version": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Int32ObjectKeyValuePair": { "type": "object", "properties": { "key": { "type": "integer", "format": "int32" }, "value": { "nullable": true } }, "additionalProperties": false }, "Int64StringUnion": { "type": "object", "properties": { "tag": { "$ref": "#/components/schemas/UnionTag" }, "value1": { "type": "integer", "format": "int64", "readOnly": true }, "value2": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Intervals": { "type": "object", "properties": { "allOf": { "$ref": "#/components/schemas/IntervalsAllOf" }, "anyOf": { "$ref": "#/components/schemas/IntervalsAnyOf" }, "fuzzy": { "$ref": "#/components/schemas/IntervalsFuzzy" }, "match": { "$ref": "#/components/schemas/IntervalsMatch" }, "prefix": { "$ref": "#/components/schemas/IntervalsPrefix" }, "range": { "$ref": "#/components/schemas/IntervalsRange" }, "regexp": { "$ref": "#/components/schemas/IntervalsRegexp" }, "wildcard": { "$ref": "#/components/schemas/IntervalsWildcard" } }, "additionalProperties": false }, "IntervalsAllOf": { "required": [ "intervals" ], "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/IntervalsFilter" }, "intervals": { "type": "array", "items": { "$ref": "#/components/schemas/Intervals" }, "nullable": true }, "maxGaps": { "type": "integer", "format": "int32", "nullable": true }, "ordered": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "IntervalsAnyOf": { "required": [ "intervals" ], "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/IntervalsFilter" }, "intervals": { "type": "array", "items": { "$ref": "#/components/schemas/Intervals" }, "nullable": true } }, "additionalProperties": false }, "IntervalsFilter": { "type": "object", "properties": { "after": { "$ref": "#/components/schemas/Intervals" }, "before": { "$ref": "#/components/schemas/Intervals" }, "containedBy": { "$ref": "#/components/schemas/Intervals" }, "containing": { "$ref": "#/components/schemas/Intervals" }, "notContainedBy": { "$ref": "#/components/schemas/Intervals" }, "notContaining": { "$ref": "#/components/schemas/Intervals" }, "notOverlapping": { "$ref": "#/components/schemas/Intervals" }, "overlapping": { "$ref": "#/components/schemas/Intervals" }, "script": { "$ref": "#/components/schemas/Script" } }, "additionalProperties": false }, "IntervalsFuzzy": { "required": [ "term" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "fuzziness": { "$ref": "#/components/schemas/Fuzziness" }, "prefixLength": { "type": "integer", "format": "int32", "nullable": true }, "term": { "type": "string", "nullable": true }, "transpositions": { "type": "boolean", "nullable": true }, "useField": { "$ref": "#/components/schemas/Field" } }, "additionalProperties": false }, "IntervalsMatch": { "required": [ "query" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "filter": { "$ref": "#/components/schemas/IntervalsFilter" }, "maxGaps": { "type": "integer", "format": "int32", "nullable": true }, "ordered": { "type": "boolean", "nullable": true }, "query": { "type": "string", "nullable": true }, "useField": { "$ref": "#/components/schemas/Field" } }, "additionalProperties": false }, "IntervalsPrefix": { "required": [ "prefix" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "prefix": { "type": "string", "nullable": true }, "useField": { "$ref": "#/components/schemas/Field" } }, "additionalProperties": false }, "IntervalsQuery": { "required": [ "field" ], "type": "object", "properties": { "allOf": { "$ref": "#/components/schemas/IntervalsAllOf" }, "anyOf": { "$ref": "#/components/schemas/IntervalsAnyOf" }, "fuzzy": { "$ref": "#/components/schemas/IntervalsFuzzy" }, "match": { "$ref": "#/components/schemas/IntervalsMatch" }, "prefix": { "$ref": "#/components/schemas/IntervalsPrefix" }, "range": { "$ref": "#/components/schemas/IntervalsRange" }, "regexp": { "$ref": "#/components/schemas/IntervalsRegexp" }, "wildcard": { "$ref": "#/components/schemas/IntervalsWildcard" }, "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntervalsRange": { "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "gt": { "type": "string", "nullable": true }, "gte": { "type": "string", "nullable": true }, "lt": { "type": "string", "nullable": true }, "lte": { "type": "string", "nullable": true }, "useField": { "$ref": "#/components/schemas/Field" } }, "additionalProperties": false }, "IntervalsRegexp": { "required": [ "pattern" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "pattern": { "type": "string", "nullable": true }, "useField": { "$ref": "#/components/schemas/Field" } }, "additionalProperties": false }, "IntervalsWildcard": { "required": [ "pattern" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "pattern": { "type": "string", "nullable": true }, "useField": { "$ref": "#/components/schemas/Field" } }, "additionalProperties": false }, "KnnQuery": { "required": [ "field" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "filter": { "type": "array", "items": { "$ref": "#/components/schemas/Query" }, "nullable": true }, "k": { "type": "integer", "format": "int32", "nullable": true }, "numCandidates": { "type": "integer", "format": "int32", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "queryVector": { "type": "array", "items": { "type": "number", "format": "float" }, "nullable": true }, "queryVectorBuilder": { "$ref": "#/components/schemas/QueryVectorBuilder" }, "rescoreVector": { "$ref": "#/components/schemas/RescoreVector" }, "similarity": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "Like": { "type": "object", "properties": { "tag": { "$ref": "#/components/schemas/UnionTag" }, "value1": { "type": "string", "nullable": true, "readOnly": true }, "value2": { "$ref": "#/components/schemas/LikeDocument" } }, "additionalProperties": false }, "LikeDocument": { "type": "object", "properties": { "doc": { "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "id": { "$ref": "#/components/schemas/Id" }, "index": { "$ref": "#/components/schemas/IndexName" }, "perFieldAnalyzer": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "routing": { "$ref": "#/components/schemas/Routing" }, "version": { "type": "integer", "format": "int64", "nullable": true }, "versionType": { "$ref": "#/components/schemas/VersionType" } }, "additionalProperties": false }, "MaintenanceApplicationDto": { "type": "object", "properties": { "applicationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "applicationName": { "type": "string", "default": "", "nullable": true }, "createApplicationOnly": { "type": "boolean", "default": false }, "appliesToId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" } }, "additionalProperties": false }, "MaintenanceExistingApplicationDto": { "type": "object", "properties": { "applicationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "MaintenanceModeConditionsDto": { "type": "object", "properties": { "maintenanceModeConditionTypeId": { "type": "integer", "format": "int32" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MaintenanceModeDto": { "type": "object", "properties": { "maintenanceTypeId": { "type": "integer", "format": "int32" }, "startDateTime": { "type": "string", "format": "date-time" }, "endDateTime": { "type": "string", "format": "date-time" }, "computerId": { "type": "string", "format": "uuid" }, "computerGroupId": { "type": "string", "format": "uuid" }, "application": { "type": "string", "nullable": true }, "appliesToType": { "type": "integer", "format": "int32" }, "computerInstallDate": { "type": "string", "format": "date-time", "nullable": true }, "maintenanceModeId": { "type": "string", "format": "uuid" }, "addedBy": { "type": "string", "nullable": true }, "endedBy": { "type": "string", "nullable": true }, "applicationName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "permitEnd": { "type": "boolean" }, "users": { "type": "string", "nullable": true }, "allUsers": { "type": "boolean" }, "usersList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "createNewApplication": { "type": "boolean" }, "newApplication": { "$ref": "#/components/schemas/MaintenanceApplicationDto" }, "automaticApplication": { "type": "boolean" }, "automaticApplicationType": { "type": "integer", "format": "int32" }, "useExistingApplication": { "type": "boolean" }, "existingApplication": { "$ref": "#/components/schemas/ApplicationDto" }, "createdOn": { "type": "string", "format": "date-time" }, "conditionId": { "type": "integer", "format": "int32", "nullable": true }, "shouldLogTransaction": { "type": "boolean" }, "hostname": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "MaintenanceModeEndDto": { "type": "object", "properties": { "appliesToType": { "type": "integer", "format": "int32" }, "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerInstallDate": { "type": "string", "format": "date-time", "nullable": true }, "endDateTime": { "type": "string", "format": "date-time" }, "maintenanceModeId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "maintenanceTypeId": { "type": "integer", "format": "int32" }, "startDateTime": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "MaintenanceModeInsertDto": { "type": "object", "properties": { "allUsers": { "type": "boolean", "default": false }, "automaticApplication": { "type": "boolean", "default": false }, "automaticApplicationType": { "type": "integer", "format": "int32" }, "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "createNewApplication": { "type": "boolean", "default": false }, "endDateTime": { "type": "string", "format": "date-time" }, "existingApplication": { "$ref": "#/components/schemas/MaintenanceExistingApplicationDto" }, "maintenanceTypeId": { "type": "integer", "format": "int32" }, "newApplication": { "$ref": "#/components/schemas/MaintenanceApplicationDto" }, "permitEnd": { "type": "boolean", "default": false }, "startDateTime": { "type": "string", "format": "date-time" }, "useExistingApplication": { "type": "boolean", "default": false }, "usersList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "computerDateTime": { "type": "string", "format": "date-time" }, "maintenanceModeConditions": { "type": "array", "items": { "$ref": "#/components/schemas/MaintenanceModeConditionsDto" }, "nullable": true }, "ticketNumber": { "type": "string", "default": "", "nullable": true }, "notes": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "MaintenanceModeUpdateEndDateTimeDto": { "type": "object", "properties": { "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerName": { "type": "string", "default": "", "nullable": true }, "isIsolated": { "type": "boolean", "default": false }, "isLockedOut": { "type": "boolean", "default": false }, "lastVersionChange": { "type": "string", "format": "date-time", "nullable": true }, "maintenanceEndDate": { "type": "string", "format": "date-time", "nullable": true }, "maintenanceModeId": { "type": "string", "format": "uuid" }, "maintenanceTypeId": { "type": "integer", "format": "int32" }, "monitorOnlyDateTime": { "type": "string", "format": "date-time" }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "osType": { "type": "integer", "format": "int32" }, "pendingBaseFiles": { "type": "boolean", "default": false }, "threatLockerVersion": { "type": "string", "default": "", "nullable": true }, "threatLockerVersionId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "threatLockerVersionGroup": { "type": "string", "default": "", "nullable": true }, "threatLockerVersionGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true } }, "additionalProperties": false }, "MatchAllQuery": { "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MatchBoolPrefixQuery": { "required": [ "field", "query" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "fuzziness": { "$ref": "#/components/schemas/Fuzziness" }, "fuzzyRewrite": { "type": "string", "nullable": true }, "fuzzyTranspositions": { "type": "boolean", "nullable": true }, "maxExpansions": { "type": "integer", "format": "int32", "nullable": true }, "minimumShouldMatch": { "$ref": "#/components/schemas/MinimumShouldMatch" }, "operator": { "$ref": "#/components/schemas/Operator" }, "prefixLength": { "type": "integer", "format": "int32", "nullable": true }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MatchNoneQuery": { "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MatchPhrasePrefixQuery": { "required": [ "field", "query" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "maxExpansions": { "type": "integer", "format": "int32", "nullable": true }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "slop": { "type": "integer", "format": "int32", "nullable": true }, "zeroTermsQuery": { "$ref": "#/components/schemas/ZeroTermsQuery" } }, "additionalProperties": false }, "MatchPhraseQuery": { "required": [ "field", "query" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "slop": { "type": "integer", "format": "int32", "nullable": true }, "zeroTermsQuery": { "$ref": "#/components/schemas/ZeroTermsQuery" } }, "additionalProperties": false }, "MatchQuery": { "required": [ "field", "query" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "autoGenerateSynonymsPhraseQuery": { "type": "boolean", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "cutoffFrequency": { "type": "number", "format": "double", "nullable": true, "deprecated": true }, "field": { "$ref": "#/components/schemas/Field" }, "fuzziness": { "$ref": "#/components/schemas/Fuzziness" }, "fuzzyRewrite": { "type": "string", "nullable": true }, "fuzzyTranspositions": { "type": "boolean", "nullable": true }, "lenient": { "type": "boolean", "nullable": true }, "maxExpansions": { "type": "integer", "format": "int32", "nullable": true }, "minimumShouldMatch": { "$ref": "#/components/schemas/MinimumShouldMatch" }, "operator": { "$ref": "#/components/schemas/Operator" }, "prefixLength": { "type": "integer", "format": "int32", "nullable": true }, "query": { "nullable": true }, "queryName": { "type": "string", "nullable": true }, "zeroTermsQuery": { "$ref": "#/components/schemas/ZeroTermsQuery" } }, "additionalProperties": false }, "MemberInfo": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "type": "string", "nullable": true, "readOnly": true }, "reflectedType": { "type": "string", "nullable": true, "readOnly": true }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "MemberTypes": { "enum": [ 1, 2, 4, 8, 16, 32, 64, 128, 191 ], "type": "integer", "format": "int32" }, "MethodAttributes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 53248 ], "type": "integer", "format": "int32" }, "MethodImplAttributes": { "enum": [ 0, 1, 2, 3, 4, 8, 16, 32, 64, 128, 256, 512, 4096, 65535 ], "type": "integer", "format": "int32" }, "MethodInfo": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "returnParameter": { "$ref": "#/components/schemas/ParameterInfo" }, "returnType": { "type": "string", "nullable": true, "readOnly": true }, "returnTypeCustomAttributes": { "$ref": "#/components/schemas/ICustomAttributeProvider" }, "attributes": { "$ref": "#/components/schemas/MethodAttributes" }, "methodImplementationFlags": { "$ref": "#/components/schemas/MethodImplAttributes" }, "callingConvention": { "$ref": "#/components/schemas/CallingConventions" }, "isAbstract": { "type": "boolean", "readOnly": true }, "isConstructor": { "type": "boolean", "readOnly": true }, "isFinal": { "type": "boolean", "readOnly": true }, "isHideBySig": { "type": "boolean", "readOnly": true }, "isSpecialName": { "type": "boolean", "readOnly": true }, "isStatic": { "type": "boolean", "readOnly": true }, "isVirtual": { "type": "boolean", "readOnly": true }, "isAssembly": { "type": "boolean", "readOnly": true }, "isFamily": { "type": "boolean", "readOnly": true }, "isFamilyAndAssembly": { "type": "boolean", "readOnly": true }, "isFamilyOrAssembly": { "type": "boolean", "readOnly": true }, "isPrivate": { "type": "boolean", "readOnly": true }, "isPublic": { "type": "boolean", "readOnly": true }, "isConstructedGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethod": { "type": "boolean", "readOnly": true }, "isGenericMethodDefinition": { "type": "boolean", "readOnly": true }, "containsGenericParameters": { "type": "boolean", "readOnly": true }, "methodHandle": { "$ref": "#/components/schemas/RuntimeMethodHandle" }, "isSecurityCritical": { "type": "boolean", "readOnly": true }, "isSecuritySafeCritical": { "type": "boolean", "readOnly": true }, "isSecurityTransparent": { "type": "boolean", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "type": "string", "nullable": true, "readOnly": true }, "reflectedType": { "type": "string", "nullable": true, "readOnly": true }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "MinimumShouldMatch": { "type": "object", "properties": { "tag": { "$ref": "#/components/schemas/UnionTag" }, "value1": { "type": "integer", "format": "int32", "readOnly": true }, "value2": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Module": { "type": "object", "properties": { "assembly": { "$ref": "#/components/schemas/Assembly" }, "fullyQualifiedName": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true }, "moduleVersionId": { "type": "string", "format": "uuid", "readOnly": true }, "scopeName": { "type": "string", "nullable": true, "readOnly": true }, "moduleHandle": { "$ref": "#/components/schemas/ModuleHandle" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ModuleHandle": { "type": "object", "properties": { "mdStreamVersion": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "MoreLikeThisQuery": { "required": [ "like" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "boostTerms": { "type": "number", "format": "double", "nullable": true }, "failOnUnsupportedField": { "type": "boolean", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "include": { "type": "boolean", "nullable": true }, "like": { "type": "array", "items": { "$ref": "#/components/schemas/Like" }, "nullable": true }, "maxDocFreq": { "type": "integer", "format": "int32", "nullable": true }, "maxQueryTerms": { "type": "integer", "format": "int32", "nullable": true }, "maxWordLength": { "type": "integer", "format": "int32", "nullable": true }, "minDocFreq": { "type": "integer", "format": "int32", "nullable": true }, "minimumShouldMatch": { "$ref": "#/components/schemas/MinimumShouldMatch" }, "minTermFreq": { "type": "integer", "format": "int32", "nullable": true }, "minWordLength": { "type": "integer", "format": "int32", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "routing": { "$ref": "#/components/schemas/Routing" }, "stopWords": { "$ref": "#/components/schemas/StopWordLanguageStringICollectionUnion" }, "unlike": { "type": "array", "items": { "$ref": "#/components/schemas/Like" }, "nullable": true }, "version": { "type": "integer", "format": "int64", "nullable": true }, "versionType": { "$ref": "#/components/schemas/VersionType" } }, "additionalProperties": false }, "MultiMatchQuery": { "required": [ "query" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "autoGenerateSynonymsPhraseQuery": { "type": "boolean", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "cutoffFrequency": { "type": "number", "format": "double", "nullable": true, "deprecated": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "fuzziness": { "$ref": "#/components/schemas/Fuzziness" }, "fuzzyRewrite": { "type": "string", "nullable": true }, "fuzzyTranspositions": { "type": "boolean", "nullable": true }, "lenient": { "type": "boolean", "nullable": true }, "maxExpansions": { "type": "integer", "format": "int32", "nullable": true }, "minimumShouldMatch": { "$ref": "#/components/schemas/MinimumShouldMatch" }, "operator": { "$ref": "#/components/schemas/Operator" }, "prefixLength": { "type": "integer", "format": "int32", "nullable": true }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "slop": { "type": "integer", "format": "int32", "nullable": true }, "tieBreaker": { "type": "number", "format": "double", "nullable": true }, "type": { "$ref": "#/components/schemas/TextQueryType" }, "zeroTermsQuery": { "$ref": "#/components/schemas/ZeroTermsQuery" } }, "additionalProperties": false }, "Name": { "type": "object", "additionalProperties": false }, "NestedQuery": { "required": [ "path", "query" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "innerHits": { "$ref": "#/components/schemas/InnerHits" }, "path": { "$ref": "#/components/schemas/Field" }, "query": { "$ref": "#/components/schemas/Query" }, "queryName": { "type": "string", "nullable": true }, "scoreMode": { "$ref": "#/components/schemas/ChildScoreMode" } }, "additionalProperties": false }, "NestedSortValue": { "required": [ "path" ], "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/Query" }, "maxChildren": { "type": "integer", "format": "int32", "nullable": true }, "nested": { "$ref": "#/components/schemas/NestedSortValue" }, "path": { "$ref": "#/components/schemas/Field" } }, "additionalProperties": false }, "NetworkExclusionDto": { "type": "object", "properties": { "policyId": { "type": "string", "format": "uuid" }, "tagPrefixTypeId": { "type": "integer", "format": "int32" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NetworkPolicy": { "type": "object", "properties": { "networkPolicyId": { "type": "string", "nullable": true }, "server": { "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32" }, "action": { "type": "integer", "description": "1 = Permit, 2 = Deny", "format": "int32" }, "serverDisplayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OSVersionDto": { "type": "object", "properties": { "osType": { "type": "integer", "format": "int32" }, "majorVersion": { "type": "integer", "format": "int32" }, "minorVersion": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Operator": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "OrganizationChildDto": { "type": "object", "properties": { "searchText": { "type": "string", "nullable": true }, "pageSize": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "isRemoved": { "type": "boolean" }, "orderBy": { "type": "string", "default": "name", "nullable": true }, "isAscending": { "type": "boolean", "default": true }, "maintenanceTypeIdMonitorOnly": { "type": "integer", "format": "int32" }, "maintenanceTypeIdLearning": { "type": "integer", "format": "int32" }, "includeProductBundles": { "type": "boolean" }, "includeAllChildren": { "type": "boolean" }, "isExport": { "type": "boolean" } }, "additionalProperties": false }, "OrganizationParentsDto": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParameterAttributes": { "enum": [ 0, 1, 2, 4, 8, 16, 4096, 8192, 16384, 32768, 61440 ], "type": "integer", "format": "int32" }, "ParameterInfo": { "type": "object", "properties": { "attributes": { "$ref": "#/components/schemas/ParameterAttributes" }, "member": { "$ref": "#/components/schemas/MemberInfo" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "parameterType": { "type": "string", "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "isIn": { "type": "boolean", "readOnly": true }, "isLcid": { "type": "boolean", "readOnly": true }, "isOptional": { "type": "boolean", "readOnly": true }, "isOut": { "type": "boolean", "readOnly": true }, "isRetval": { "type": "boolean", "readOnly": true }, "defaultValue": { "nullable": true, "readOnly": true }, "rawDefaultValue": { "nullable": true, "readOnly": true }, "hasDefaultValue": { "type": "boolean", "readOnly": true }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ParamsFieldsDto": { "type": "object", "properties": { "name": { "type": "string", "default": "filter", "nullable": true }, "filterType": { "type": "integer", "format": "int32", "default": 1 }, "fieldType": { "type": "integer", "format": "int32", "default": 1 }, "value": { "type": "string", "default": "Remove White Noise", "nullable": true }, "label": { "type": "string", "default": "Filter", "nullable": true }, "dropdownLabel": { "type": "string", "default": "Remove White Noise", "nullable": true }, "isDropDown": { "type": "boolean", "default": true }, "guidValue": { "type": "string", "format": "uuid", "default": null, "nullable": true }, "numericValue": { "type": "integer", "format": "int32", "default": null, "nullable": true }, "longValue": { "type": "integer", "format": "int64", "default": null, "nullable": true }, "boolValue": { "type": "boolean", "default": null, "nullable": true }, "dateTimeValue": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "fieldAttributeId": { "type": "integer", "format": "int32", "default": null, "nullable": true }, "listValue": { "type": "array", "items": { "type": "string" }, "default": null, "nullable": true }, "listGuidValue": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": null, "nullable": true }, "listNumericValue": { "type": "array", "items": { "type": "integer", "format": "int32" }, "default": null, "nullable": true }, "listLongValue": { "type": "array", "items": { "type": "integer", "format": "int64" }, "default": null, "nullable": true }, "dateTimeInterval": { "type": "array", "items": { "type": "string", "format": "date-time" }, "default": null, "nullable": true } }, "additionalProperties": false }, "ParentIdQuery": { "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "id": { "$ref": "#/components/schemas/Id" }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PercolateQuery": { "required": [ "field" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "document": { "nullable": true }, "documents": { "type": "array", "items": { }, "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "id": { "$ref": "#/components/schemas/Id" }, "index": { "$ref": "#/components/schemas/IndexName" }, "name": { "type": "string", "nullable": true }, "preference": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "routing": { "$ref": "#/components/schemas/Routing" }, "version": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "PermitAdminNotes": { "type": "object", "properties": { "ticket": { "type": "string", "default": "", "nullable": true }, "requestorEmail": { "type": "string", "default": "", "nullable": true }, "comments": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "PermitApplicationDto": { "type": "object", "properties": { "computerId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "computerGroupId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "organizationIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": "[]", "nullable": true }, "osType": { "type": "integer", "format": "int32" }, "userInstance": { "type": "string", "default": "", "nullable": true }, "approvalRequest": { "$ref": "#/components/schemas/ApprovalRequestDto" }, "isFromApproval": { "type": "boolean", "readOnly": true }, "actionLog": { "$ref": "#/components/schemas/ActionLogDto" }, "isFromActionLog": { "type": "boolean", "readOnly": true }, "actionType": { "type": "string", "default": "", "nullable": true }, "isElevationRequest": { "type": "boolean" }, "isExtensionRequest": { "type": "boolean" }, "edgeStoreUrl": { "type": "string", "default": "", "nullable": true }, "chromeStoreUrl": { "type": "string", "default": "", "nullable": true }, "canViewOnSystemLookup": { "type": "boolean" }, "systemLookupUrl": { "type": "string", "default": "", "nullable": true }, "canViewVirusTotal": { "type": "boolean" }, "virusTotalUrl": { "type": "string", "default": "", "nullable": true }, "fileHistoryChecked": { "type": "boolean" }, "suggestCustomRule": { "type": "boolean", "nullable": true }, "fileDetails": { "$ref": "#/components/schemas/PermitFileDetails" }, "matchingApplications": { "$ref": "#/components/schemas/PermitMatchingApplications" }, "matchingApplicationList": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationOnlineDto" }, "nullable": true }, "policyConditions": { "$ref": "#/components/schemas/PermitPolicyConditions" }, "policyExpirationDate": { "type": "string", "format": "date-time", "nullable": true }, "ringfencingOptions": { "$ref": "#/components/schemas/AdvRFPolicy" }, "networkExclusions": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkExclusionDto" }, "nullable": true }, "ringfenceActionId": { "type": "integer", "format": "int32" }, "isRingfenced": { "type": "boolean", "readOnly": true }, "hasRingfencingAsProduct": { "type": "boolean" }, "hasElevation": { "type": "boolean" }, "organizationHasElevation": { "type": "boolean" }, "elevationStatus": { "type": "integer", "format": "int32" }, "elevationExpiration": { "type": "integer", "format": "int32" }, "elevationExpirationDate": { "type": "string", "format": "date-time", "nullable": true }, "policyLevel": { "$ref": "#/components/schemas/PermitPolicyLevel" }, "adminNotes": { "$ref": "#/components/schemas/PermitAdminNotes" }, "applicationList": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationOnlineDto" }, "nullable": true }, "systemAudits": { "type": "array", "items": { "$ref": "#/components/schemas/SystemAuditItem" }, "nullable": true }, "allowTMM": { "type": "boolean" }, "fileExclusions": { "type": "array", "items": { "$ref": "#/components/schemas/FileExclusionDto" }, "nullable": true }, "applicationId": { "type": "string", "format": "uuid", "nullable": true }, "policyId": { "type": "string", "format": "uuid", "nullable": true }, "elevationPolicyId": { "type": "string", "format": "uuid", "nullable": true }, "hasOriginApprovalCenter": { "type": "boolean", "nullable": true }, "responseSubject": { "type": "string", "nullable": true }, "responseReason": { "type": "string", "nullable": true }, "notifyOnResponse": { "type": "boolean" }, "isExecutionRequest": { "type": "boolean" }, "temporarySettings": { "$ref": "#/components/schemas/TemporaryPolicySettings" }, "allUserGroups": { "type": "boolean" }, "userGroups": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyUserGroupDto" }, "nullable": true }, "matchingRingfencePolicies": { "type": "array", "items": { "$ref": "#/components/schemas/RingfencePolicyMatchDto" }, "nullable": true, "readOnly": true }, "useLegacyRingfencing": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PermitFileDetails": { "type": "object", "properties": { "fullPath": { "type": "string", "default": "", "nullable": true }, "processPath": { "type": "string", "default": "", "nullable": true }, "hash": { "type": "string", "default": "", "nullable": true }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/ThreatLockerCertDto" }, "nullable": true }, "createdByProcesses": { "type": "array", "items": { "type": "string" }, "default": "[]", "nullable": true }, "filename": { "type": "string", "default": "", "nullable": true }, "sha256": { "type": "string", "default": "", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "originalHostname": { "type": "string", "default": "", "nullable": true }, "hostname": { "type": "string", "default": "", "nullable": true }, "username": { "type": "string", "default": "", "nullable": true }, "organizationName": { "type": "string", "default": "", "nullable": true }, "policyName": { "type": "string", "default": "", "nullable": true }, "applicationName": { "type": "string", "default": "", "nullable": true }, "requestorReason": { "type": "string", "default": "", "nullable": true }, "approvalStatus": { "type": "string", "default": "", "nullable": true }, "approvalBy": { "type": "string", "default": "", "nullable": true }, "size": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "PermitMatchingApplications": { "type": "object", "properties": { "useMatchingApplication": { "type": "boolean" }, "matchingApplication": { "$ref": "#/components/schemas/ApplicationOnlineDto" }, "useExistingApplication": { "type": "boolean" }, "existingApplication": { "$ref": "#/components/schemas/ApplicationOnlineDto" }, "useNewApplication": { "type": "boolean" }, "newApplicationName": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "PermitPolicyConditions": { "type": "object", "properties": { "useExistingPolicy": { "type": "boolean" }, "createManualPolicy": { "type": "boolean" }, "manualOptions": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyManualOption" }, "nullable": true }, "ruleId": { "type": "integer", "format": "int32" }, "certSubjects": { "type": "array", "items": { "type": "string" }, "default": "[]", "nullable": true }, "createdByProcesses": { "type": "array", "items": { "type": "string" }, "default": "[]", "nullable": true }, "disableProtection": { "type": "boolean", "readOnly": true }, "includedAdditionalFiles": { "type": "array", "items": { "$ref": "#/components/schemas/ActionLogDto" }, "nullable": true } }, "additionalProperties": false }, "PermitPolicyLevel": { "type": "object", "properties": { "canUseEntireOrganization": { "type": "boolean" }, "toEntireOrganization": { "type": "boolean" }, "toComputerGroup": { "type": "boolean" }, "selectedComputerGroup": { "$ref": "#/components/schemas/ComputerGroupItemDto" }, "toComputer": { "type": "boolean" } }, "additionalProperties": false }, "PermitRingfencingOptions": { "type": "object", "properties": { "ringfence": { "type": "boolean", "readOnly": true }, "ringfenceActionId": { "type": "integer", "format": "int32" }, "restrictNetwork": { "type": "boolean" }, "blockRegistryWrites": { "type": "boolean" }, "blockProtectedFiles": { "type": "boolean" }, "blockHighRiskApps": { "type": "boolean" }, "blockPowerShell": { "type": "boolean" }, "blockCommandPrompt": { "type": "boolean" }, "blockRunDLL": { "type": "boolean" }, "blockRegSRV": { "type": "boolean" }, "blockWscriptCscript": { "type": "boolean" } }, "additionalProperties": false }, "PinnedDoc": { "required": [ "id", "index" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "index": { "$ref": "#/components/schemas/IndexName" } }, "additionalProperties": false }, "PinnedQuery": { "required": [ "organic" ], "type": "object", "properties": { "docs": { "type": "array", "items": { "$ref": "#/components/schemas/PinnedDoc" }, "nullable": true }, "ids": { "type": "array", "items": { "$ref": "#/components/schemas/Id" }, "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "organic": { "$ref": "#/components/schemas/Query" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PolicyForApplicationDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "osType": { "type": "integer", "format": "int32" }, "policyActionId": { "type": "integer", "format": "int32" }, "killRunningProcesses": { "type": "boolean" }, "computerGroupId": { "type": "string", "format": "uuid" }, "allUserGroups": { "type": "boolean" }, "userGroups": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyUserGroupDto" }, "nullable": true }, "endDate": { "type": "string", "format": "date-time" }, "neverExpires": { "type": "boolean" }, "policySchedules": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyScheduleDto" }, "nullable": true }, "elevationStatus": { "type": "integer", "format": "int32", "nullable": true }, "monitorMode": { "type": "integer", "format": "int32" }, "allowRequest": { "type": "boolean" }, "requestEmailAddressesList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "notifyOnRequest": { "type": "boolean" }, "policyScheduleStatus": { "type": "integer", "format": "int32" }, "ringfence": { "type": "boolean" }, "ringfencingOptions": { "$ref": "#/components/schemas/AdvRFPolicy" }, "permitRingfencingOptions": { "$ref": "#/components/schemas/PermitRingfencingOptions" }, "elevationEndDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PolicyManualOption": { "type": "object", "properties": { "fullPath": { "type": "string", "default": "", "nullable": true }, "processPath": { "type": "string", "default": "", "nullable": true }, "cert": { "type": "string", "default": "", "nullable": true }, "hash": { "type": "string", "default": "", "nullable": true }, "sha256": { "type": "string", "default": "", "nullable": true }, "createdBy": { "type": "string", "default": "", "nullable": true }, "isDefaultOption": { "type": "boolean" }, "disabled": { "type": "boolean" } }, "additionalProperties": false }, "PolicySchedule": { "type": "object", "properties": { "day": { "$ref": "#/components/schemas/DayOfWeek" }, "startMinute": { "type": "integer", "format": "int32" }, "duration": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PolicyScheduleDto": { "type": "object", "properties": { "dayoftheWeekId": { "type": "string", "format": "uuid" }, "schedule": { "$ref": "#/components/schemas/PolicySchedule" }, "dayoftheWeek": { "$ref": "#/components/schemas/DayOfWeek" }, "startTime": { "type": "string", "format": "date-time" }, "durationHours": { "type": "integer", "format": "int32" }, "durationMinutes": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PolicyUserGroupDto": { "type": "object", "properties": { "text": { "type": "string", "default": "", "nullable": true }, "value": { "type": "string", "default": "", "nullable": true }, "isExpandable": { "type": "boolean", "default": false } }, "additionalProperties": false }, "PrefixQuery": { "required": [ "field", "value" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "caseInsensitive": { "type": "boolean", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "queryName": { "type": "string", "nullable": true }, "rewrite": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PropertyAttributes": { "enum": [ 0, 512, 1024, 4096, 8192, 16384, 32768, 62464 ], "type": "integer", "format": "int32" }, "PropertyInfo": { "type": "object", "properties": { "memberType": { "$ref": "#/components/schemas/MemberTypes" }, "propertyType": { "type": "string", "nullable": true, "readOnly": true }, "attributes": { "$ref": "#/components/schemas/PropertyAttributes" }, "isSpecialName": { "type": "boolean", "readOnly": true }, "canRead": { "type": "boolean", "readOnly": true }, "canWrite": { "type": "boolean", "readOnly": true }, "getMethod": { "$ref": "#/components/schemas/MethodInfo" }, "setMethod": { "$ref": "#/components/schemas/MethodInfo" }, "name": { "type": "string", "nullable": true, "readOnly": true }, "declaringType": { "type": "string", "nullable": true, "readOnly": true }, "reflectedType": { "type": "string", "nullable": true, "readOnly": true }, "module": { "$ref": "#/components/schemas/Module" }, "customAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAttributeData" }, "nullable": true, "readOnly": true }, "isCollectible": { "type": "boolean", "readOnly": true }, "metadataToken": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Query": { "type": "object", "properties": { "bool": { "$ref": "#/components/schemas/BoolQuery" }, "boosting": { "$ref": "#/components/schemas/BoostingQuery" }, "combinedFields": { "$ref": "#/components/schemas/CombinedFieldsQuery" }, "common": { "$ref": "#/components/schemas/CommonTermsQuery" }, "constantScore": { "$ref": "#/components/schemas/ConstantScoreQuery" }, "disMax": { "$ref": "#/components/schemas/DisMaxQuery" }, "distanceFeature": { "$ref": "#/components/schemas/IDistanceFeatureQuery" }, "exists": { "$ref": "#/components/schemas/ExistsQuery" }, "functionScore": { "$ref": "#/components/schemas/FunctionScoreQuery" }, "fuzzy": { "$ref": "#/components/schemas/FuzzyQuery" }, "geoBoundingBox": { "$ref": "#/components/schemas/GeoBoundingBoxQuery" }, "geoDistance": { "$ref": "#/components/schemas/GeoDistanceQuery" }, "geoGrid": { "$ref": "#/components/schemas/GeoGridQuery" }, "geoPolygon": { "$ref": "#/components/schemas/GeoPolygonQuery" }, "geoShape": { "$ref": "#/components/schemas/GeoShapeQuery" }, "hasChild": { "$ref": "#/components/schemas/HasChildQuery" }, "hasParent": { "$ref": "#/components/schemas/HasParentQuery" }, "ids": { "$ref": "#/components/schemas/IdsQuery" }, "intervals": { "$ref": "#/components/schemas/IntervalsQuery" }, "knn": { "$ref": "#/components/schemas/KnnQuery" }, "match": { "$ref": "#/components/schemas/MatchQuery" }, "matchAll": { "$ref": "#/components/schemas/MatchAllQuery" }, "matchBoolPrefix": { "$ref": "#/components/schemas/MatchBoolPrefixQuery" }, "matchNone": { "$ref": "#/components/schemas/MatchNoneQuery" }, "matchPhrase": { "$ref": "#/components/schemas/MatchPhraseQuery" }, "matchPhrasePrefix": { "$ref": "#/components/schemas/MatchPhrasePrefixQuery" }, "moreLikeThis": { "$ref": "#/components/schemas/MoreLikeThisQuery" }, "multiMatch": { "$ref": "#/components/schemas/MultiMatchQuery" }, "nested": { "$ref": "#/components/schemas/NestedQuery" }, "parentId": { "$ref": "#/components/schemas/ParentIdQuery" }, "percolate": { "$ref": "#/components/schemas/PercolateQuery" }, "pinned": { "$ref": "#/components/schemas/PinnedQuery" }, "prefix": { "$ref": "#/components/schemas/PrefixQuery" }, "queryString": { "$ref": "#/components/schemas/QueryStringQuery" }, "range": { "$ref": "#/components/schemas/IRangeQuery" }, "rankFeature": { "$ref": "#/components/schemas/RankFeatureQuery" }, "regexp": { "$ref": "#/components/schemas/RegexpQuery" }, "rule": { "$ref": "#/components/schemas/RuleQuery" }, "script": { "$ref": "#/components/schemas/ScriptQuery" }, "scriptScore": { "$ref": "#/components/schemas/ScriptScoreQuery" }, "semantic": { "$ref": "#/components/schemas/SemanticQuery" }, "shape": { "$ref": "#/components/schemas/ShapeQuery" }, "simpleQueryString": { "$ref": "#/components/schemas/SimpleQueryStringQuery" }, "spanContaining": { "$ref": "#/components/schemas/SpanContainingQuery" }, "spanFieldMasking": { "$ref": "#/components/schemas/SpanFieldMaskingQuery" }, "spanFirst": { "$ref": "#/components/schemas/SpanFirstQuery" }, "spanMulti": { "$ref": "#/components/schemas/SpanMultiTermQuery" }, "spanNear": { "$ref": "#/components/schemas/SpanNearQuery" }, "spanNot": { "$ref": "#/components/schemas/SpanNotQuery" }, "spanOr": { "$ref": "#/components/schemas/SpanOrQuery" }, "spanTerm": { "$ref": "#/components/schemas/SpanTermQuery" }, "spanWithin": { "$ref": "#/components/schemas/SpanWithinQuery" }, "sparseVector": { "$ref": "#/components/schemas/SparseVectorQuery" }, "term": { "$ref": "#/components/schemas/TermQuery" }, "terms": { "$ref": "#/components/schemas/TermsQuery" }, "termsSet": { "$ref": "#/components/schemas/TermsSetQuery" }, "textExpansion": { "$ref": "#/components/schemas/TextExpansionQuery" }, "type": { "$ref": "#/components/schemas/TypeQuery" }, "weightedTokens": { "$ref": "#/components/schemas/WeightedTokensQuery" }, "wildcard": { "$ref": "#/components/schemas/WildcardQuery" }, "wrapper": { "$ref": "#/components/schemas/WrapperQuery" }, "variantName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "QueryStringQuery": { "required": [ "query" ], "type": "object", "properties": { "allowLeadingWildcard": { "type": "boolean", "nullable": true }, "analyzer": { "type": "string", "nullable": true }, "analyzeWildcard": { "type": "boolean", "nullable": true }, "autoGenerateSynonymsPhraseQuery": { "type": "boolean", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "defaultField": { "$ref": "#/components/schemas/Field" }, "defaultOperator": { "$ref": "#/components/schemas/Operator" }, "enablePositionIncrements": { "type": "boolean", "nullable": true }, "escape": { "type": "boolean", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "fuzziness": { "$ref": "#/components/schemas/Fuzziness" }, "fuzzyMaxExpansions": { "type": "integer", "format": "int32", "nullable": true }, "fuzzyPrefixLength": { "type": "integer", "format": "int32", "nullable": true }, "fuzzyRewrite": { "type": "string", "nullable": true }, "fuzzyTranspositions": { "type": "boolean", "nullable": true }, "lenient": { "type": "boolean", "nullable": true }, "maxDeterminizedStates": { "type": "integer", "format": "int32", "nullable": true }, "minimumShouldMatch": { "$ref": "#/components/schemas/MinimumShouldMatch" }, "phraseSlop": { "type": "number", "format": "double", "nullable": true }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "quoteAnalyzer": { "type": "string", "nullable": true }, "quoteFieldSuffix": { "type": "string", "nullable": true }, "rewrite": { "type": "string", "nullable": true }, "tieBreaker": { "type": "number", "format": "double", "nullable": true }, "timeZone": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/TextQueryType" } }, "additionalProperties": false }, "QueryVectorBuilder": { "type": "object", "properties": { "textEmbedding": { "$ref": "#/components/schemas/TextEmbedding" } }, "additionalProperties": false }, "RandomScoreFunction": { "type": "object", "properties": { "field": { "$ref": "#/components/schemas/Field" }, "seed": { "$ref": "#/components/schemas/Int64StringUnion" } }, "additionalProperties": false }, "RankFeatureFunctionLinear": { "type": "object", "additionalProperties": false }, "RankFeatureFunctionLogarithm": { "required": [ "scalingFactor" ], "type": "object", "properties": { "scalingFactor": { "type": "number", "format": "float" } }, "additionalProperties": false }, "RankFeatureFunctionSaturation": { "type": "object", "properties": { "pivot": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "RankFeatureFunctionSigmoid": { "required": [ "exponent", "pivot" ], "type": "object", "properties": { "exponent": { "type": "number", "format": "float" }, "pivot": { "type": "number", "format": "float" } }, "additionalProperties": false }, "RankFeatureQuery": { "required": [ "field" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "linear": { "$ref": "#/components/schemas/RankFeatureFunctionLinear" }, "log": { "$ref": "#/components/schemas/RankFeatureFunctionLogarithm" }, "queryName": { "type": "string", "nullable": true }, "saturation": { "$ref": "#/components/schemas/RankFeatureFunctionSaturation" }, "sigmoid": { "$ref": "#/components/schemas/RankFeatureFunctionSigmoid" } }, "additionalProperties": false }, "RegexpQuery": { "required": [ "field", "value" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "caseInsensitive": { "type": "boolean", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "flags": { "type": "string", "nullable": true }, "maxDeterminizedStates": { "type": "integer", "format": "int32", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "rewrite": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegistryPolicy": { "type": "object", "properties": { "registryPolicyId": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "action": { "type": "integer", "description": "1 = Permit, 2 = Deny", "format": "int32" }, "permission": { "type": "integer", "description": "1 = Read, 2 = Write", "format": "int32" } }, "additionalProperties": false }, "ReportParams": { "type": "object", "properties": { "reportId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "startDate": { "type": "string", "format": "date-time", "default": null }, "endDate": { "type": "string", "format": "date-time", "default": null }, "data": { "type": "string", "default": "", "nullable": true }, "offsetInMinutes": { "type": "integer", "format": "int32" }, "id": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "includeChildOrganizations": { "type": "boolean" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/ReportParamsOption" }, "nullable": true } }, "additionalProperties": false }, "ReportParamsOption": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "nullable": true } }, "additionalProperties": false }, "RescoreVector": { "required": [ "oversample" ], "type": "object", "properties": { "oversample": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ResearchAccessLevelDto": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "isProtected": { "type": "boolean", "nullable": true }, "orderBy": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RingfencePolicyLegacyMatchRequest": { "type": "object", "properties": { "ringfencePolicyIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "applicationIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "organizationId": { "type": "string", "format": "uuid", "readOnly": true } }, "additionalProperties": false }, "RingfencePolicyMatchDto": { "type": "object", "properties": { "ringfencePolicyId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "applicationId": { "type": "string", "format": "uuid" }, "ringfencePolicyTypeId": { "$ref": "#/components/schemas/RingfencePolicyType" } }, "additionalProperties": false }, "RingfencePolicyType": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Routing": { "type": "object", "additionalProperties": false }, "RuleQuery": { "required": [ "matchCriteria", "organic" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "matchCriteria": { "nullable": true }, "organic": { "$ref": "#/components/schemas/Query" }, "queryName": { "type": "string", "nullable": true }, "rulesetId": { "type": "string", "nullable": true }, "rulesetIds": { "type": "array", "items": { "$ref": "#/components/schemas/Id" }, "nullable": true } }, "additionalProperties": false }, "RuntimeMethodHandle": { "type": "object", "properties": { "value": { "readOnly": true } }, "additionalProperties": false }, "SaveSearchDto": { "type": "object", "properties": { "searchData": { "nullable": true }, "saveSearchId": { "type": "string", "format": "uuid" }, "saveSearchPageId": { "type": "integer", "format": "int32" }, "searchName": { "type": "string", "nullable": true }, "saveParameters": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "format": "uuid" }, "searchCount": { "type": "integer", "format": "int64", "nullable": true }, "datetime": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SaveSearchesDto": { "type": "object", "properties": { "saveSearchPageId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ScheduledAgentActionAbortDto": { "type": "object", "properties": { "scheduledId": { "type": "string", "format": "uuid" }, "appliesTo": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledAgentActionAppliesTo" }, "nullable": true }, "abortAll": { "type": "boolean" }, "applyAll": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ScheduledAgentActionAppliesTo": { "type": "object", "properties": { "appliesToId": { "type": "string", "format": "uuid" }, "appliesToTypeId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ScheduledAgentActionInsertDto": { "type": "object", "properties": { "scheduledType": { "type": "integer", "format": "int32" }, "scheduledTypePayload": { "type": "string", "nullable": true }, "appliesTo": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledAgentActionAppliesTo" }, "nullable": true }, "batchAmount": { "type": "integer", "format": "int32", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "windowStartTime": { "type": "string", "nullable": true }, "windowEndTime": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScheduledAgentActionParametersDto": { "type": "object", "properties": { "scheduledId": { "type": "string", "format": "uuid" }, "orderBy": { "type": "string", "default": "scheduleddatetime", "nullable": true }, "isAscending": { "type": "boolean" }, "searchText": { "maxLength": 255, "type": "string", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "default": 25 }, "pageNumber": { "type": "integer", "format": "int32", "default": 1 }, "organizationIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "computerGroupIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "ScheduledAgentActionUpdateDto": { "type": "object", "properties": { "scheduledId": { "type": "string", "format": "uuid" }, "appliesTo": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledAgentActionAppliesTo" }, "nullable": true }, "applyAll": { "type": "boolean" } }, "additionalProperties": false }, "ScoreSort": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/SortOrder" } }, "additionalProperties": false }, "Script": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "lang": { "$ref": "#/components/schemas/ScriptLanguage" }, "options": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "params": { "type": "object", "additionalProperties": { }, "nullable": true }, "source": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScriptField": { "required": [ "script" ], "type": "object", "properties": { "ignoreFailure": { "type": "boolean", "nullable": true }, "script": { "$ref": "#/components/schemas/Script" } }, "additionalProperties": false }, "ScriptLanguage": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScriptQuery": { "required": [ "script" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "script": { "$ref": "#/components/schemas/Script" } }, "additionalProperties": false }, "ScriptScoreFunction": { "required": [ "script" ], "type": "object", "properties": { "script": { "$ref": "#/components/schemas/Script" } }, "additionalProperties": false }, "ScriptScoreQuery": { "required": [ "query", "script" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "minScore": { "type": "number", "format": "float", "nullable": true }, "query": { "$ref": "#/components/schemas/Query" }, "queryName": { "type": "string", "nullable": true }, "script": { "$ref": "#/components/schemas/Script" } }, "additionalProperties": false }, "ScriptSort": { "required": [ "script" ], "type": "object", "properties": { "mode": { "$ref": "#/components/schemas/SortMode" }, "nested": { "$ref": "#/components/schemas/NestedSortValue" }, "order": { "$ref": "#/components/schemas/SortOrder" }, "script": { "$ref": "#/components/schemas/Script" }, "type": { "$ref": "#/components/schemas/ScriptSortType" } }, "additionalProperties": false }, "ScriptSortType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "SecurityRuleSet": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "SemanticQuery": { "required": [ "field", "query" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "type": "string", "nullable": true }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShapeFieldQuery": { "type": "object", "properties": { "indexedShape": { "$ref": "#/components/schemas/FieldLookup" }, "relation": { "$ref": "#/components/schemas/GeoShapeRelation" }, "shape": { "nullable": true } }, "additionalProperties": false }, "ShapeQuery": { "required": [ "field", "shape" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "ignoreUnmapped": { "type": "boolean", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "shape": { "$ref": "#/components/schemas/ShapeFieldQuery" } }, "additionalProperties": false }, "SimpleQueryStringFlags": { "enum": [ 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096 ], "type": "integer", "format": "int32" }, "SimpleQueryStringQuery": { "required": [ "query" ], "type": "object", "properties": { "analyzer": { "type": "string", "nullable": true }, "analyzeWildcard": { "type": "boolean", "nullable": true }, "autoGenerateSynonymsPhraseQuery": { "type": "boolean", "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "defaultOperator": { "$ref": "#/components/schemas/Operator" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "flags": { "$ref": "#/components/schemas/SimpleQueryStringFlags" }, "fuzzyMaxExpansions": { "type": "integer", "format": "int32", "nullable": true }, "fuzzyPrefixLength": { "type": "integer", "format": "int32", "nullable": true }, "fuzzyTranspositions": { "type": "boolean", "nullable": true }, "lenient": { "type": "boolean", "nullable": true }, "minimumShouldMatch": { "$ref": "#/components/schemas/MinimumShouldMatch" }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "quoteFieldSuffix": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SortMode": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "SortOptions": { "type": "object", "properties": { "doc": { "$ref": "#/components/schemas/ScoreSort" }, "field": { "$ref": "#/components/schemas/FieldSort" }, "geoDistance": { "$ref": "#/components/schemas/GeoDistanceSort" }, "score": { "$ref": "#/components/schemas/ScoreSort" }, "script": { "$ref": "#/components/schemas/ScriptSort" } }, "additionalProperties": false }, "SortOrder": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "SourceConfig": { "type": "object", "properties": { "hasBoolValue": { "type": "boolean", "readOnly": true }, "hasSourceFilterValue": { "type": "boolean", "readOnly": true }, "tag": { "$ref": "#/components/schemas/UnionTag" }, "value1": { "type": "boolean", "readOnly": true }, "value2": { "$ref": "#/components/schemas/SourceFilter" } }, "additionalProperties": false }, "SourceFilter": { "type": "object", "properties": { "excludes": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true }, "excludeVectors": { "type": "boolean", "nullable": true }, "includes": { "type": "array", "items": { "$ref": "#/components/schemas/Field" }, "nullable": true } }, "additionalProperties": false }, "SpanContainingQuery": { "required": [ "big", "little" ], "type": "object", "properties": { "big": { "$ref": "#/components/schemas/SpanQuery" }, "boost": { "type": "number", "format": "float", "nullable": true }, "little": { "$ref": "#/components/schemas/SpanQuery" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpanFieldMaskingQuery": { "required": [ "field", "query" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "query": { "$ref": "#/components/schemas/SpanQuery" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpanFirstQuery": { "required": [ "end", "match" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "end": { "type": "integer", "format": "int32" }, "match": { "$ref": "#/components/schemas/SpanQuery" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpanMultiTermQuery": { "required": [ "match" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "match": { "$ref": "#/components/schemas/Query" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpanNearQuery": { "required": [ "clauses" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "clauses": { "type": "array", "items": { "$ref": "#/components/schemas/SpanQuery" }, "nullable": true }, "inOrder": { "type": "boolean", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "slop": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SpanNotQuery": { "required": [ "exclude", "include" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "dist": { "type": "integer", "format": "int32", "nullable": true }, "exclude": { "$ref": "#/components/schemas/SpanQuery" }, "include": { "$ref": "#/components/schemas/SpanQuery" }, "post": { "type": "integer", "format": "int32", "nullable": true }, "pre": { "type": "integer", "format": "int32", "nullable": true }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpanOrQuery": { "required": [ "clauses" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "clauses": { "type": "array", "items": { "$ref": "#/components/schemas/SpanQuery" }, "nullable": true }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpanQuery": { "type": "object", "properties": { "spanContaining": { "$ref": "#/components/schemas/SpanContainingQuery" }, "spanFieldMasking": { "$ref": "#/components/schemas/SpanFieldMaskingQuery" }, "spanFirst": { "$ref": "#/components/schemas/SpanFirstQuery" }, "spanGap": { "$ref": "#/components/schemas/FieldInt32KeyValuePair" }, "spanMulti": { "$ref": "#/components/schemas/SpanMultiTermQuery" }, "spanNear": { "$ref": "#/components/schemas/SpanNearQuery" }, "spanNot": { "$ref": "#/components/schemas/SpanNotQuery" }, "spanOr": { "$ref": "#/components/schemas/SpanOrQuery" }, "spanTerm": { "$ref": "#/components/schemas/SpanTermQuery" }, "spanWithin": { "$ref": "#/components/schemas/SpanWithinQuery" }, "variantName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "SpanTermQuery": { "required": [ "field", "value" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "queryName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpanWithinQuery": { "required": [ "big", "little" ], "type": "object", "properties": { "big": { "$ref": "#/components/schemas/SpanQuery" }, "boost": { "type": "number", "format": "float", "nullable": true }, "little": { "$ref": "#/components/schemas/SpanQuery" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SparseVectorQuery": { "required": [ "field" ], "type": "object", "properties": { "inferenceId": { "$ref": "#/components/schemas/Id" }, "queryVector": { "type": "object", "additionalProperties": { "type": "number", "format": "float" }, "nullable": true }, "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "prune": { "type": "boolean", "nullable": true }, "pruningConfig": { "$ref": "#/components/schemas/TokenPruningConfig" }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StopWordLanguage": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36 ], "type": "integer", "format": "int32" }, "StopWordLanguageStringICollectionUnion": { "type": "object", "properties": { "tag": { "$ref": "#/components/schemas/UnionTag" }, "value1": { "$ref": "#/components/schemas/StopWordLanguage" }, "value2": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "StorageApprovalDto": { "type": "object", "properties": { "approvalRequest": { "$ref": "#/components/schemas/ApprovalRequestDto" }, "addDeviceToExisting": { "type": "boolean" }, "existingStoragePolicy": { "$ref": "#/components/schemas/StoragePolicyBasicDto" }, "addDeviceName": { "type": "string", "default": "", "nullable": true }, "policyName": { "type": "string", "default": "", "nullable": true }, "entityType": { "type": "integer", "format": "int32" }, "appliesToId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "policyType": { "type": "string", "default": "", "nullable": true }, "allStorageDevices": { "type": "boolean" }, "newStorageDevice": { "$ref": "#/components/schemas/StorageDeviceDto" }, "deviceExists": { "type": "boolean" }, "allFilePaths": { "type": "boolean" }, "selectedPath": { "type": "string", "default": "", "nullable": true }, "deviceType": { "type": "string", "default": "", "nullable": true }, "encryptionStatus": { "type": "integer", "format": "int32" }, "json": { "type": "string", "default": "", "nullable": true }, "allUserGroups": { "type": "boolean" }, "users": { "type": "string", "default": "", "nullable": true }, "usersList": { "type": "array", "items": { "type": "string" }, "default": "[]", "nullable": true }, "userGroups": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyUserGroupDto" }, "nullable": true }, "expirationDate": { "type": "string", "format": "date-time", "nullable": true }, "responseSubject": { "type": "string", "nullable": true }, "responseReason": { "type": "string", "nullable": true }, "notifyOnResponse": { "type": "boolean" }, "processesList": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StorageDeviceDto": { "type": "object", "properties": { "storageDeviceId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string", "default": "", "nullable": true }, "serialNumber": { "type": "string", "default": "", "nullable": true }, "owner": { "type": "string", "default": "", "nullable": true }, "manufacturer": { "type": "string", "default": "", "nullable": true }, "storagePolicyId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "storagePolicyIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": "[]", "nullable": true } }, "additionalProperties": false }, "StoragePolicyBasicDto": { "type": "object", "properties": { "storagePolicyId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string", "default": "", "nullable": true }, "processesList": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SystemAuditDetails": { "type": "object", "properties": { "page": { "type": "string", "default": "", "nullable": true }, "function": { "type": "string", "default": "", "nullable": true }, "objectId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "details": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "SystemAuditHealthCenterParams": { "type": "object", "properties": { "days": { "type": "integer", "format": "int32", "default": 30 }, "searchText": { "type": "string", "default": "", "nullable": true }, "isLoggedIn": { "type": "boolean", "default": false }, "emailAddress": { "type": "string", "nullable": true }, "ipAddresses": { "type": "string", "nullable": true }, "afterKeys": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValue" }, "nullable": true }, "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "default": 10 }, "pageNumber": { "type": "integer", "format": "int32", "default": 1 } }, "additionalProperties": false }, "SystemAuditItem": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "userId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "username": { "type": "string", "default": "", "nullable": true }, "action": { "type": "string", "default": "", "nullable": true }, "ipAddress": { "type": "string", "default": "", "nullable": true }, "effectiveAction": { "type": "string", "default": "", "nullable": true }, "details": { "$ref": "#/components/schemas/SystemAuditDetails" }, "masterViewOnly": { "type": "boolean" }, "dateTime": { "type": "string", "format": "date-time" }, "systemAuditId": { "type": "string", "format": "uuid" }, "systemAuditObjectTypeId": { "type": "integer", "format": "int32", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "documentId": { "type": "string", "nullable": true }, "groupCount": { "type": "integer", "format": "int32" }, "groupValue": { "nullable": true }, "ticketNumber": { "type": "string", "default": "", "nullable": true }, "notes": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "SystemAuditItemQueryDescriptorAction": { "type": "object", "properties": { "target": { "nullable": true, "readOnly": true }, "method": { "$ref": "#/components/schemas/MethodInfo" } }, "additionalProperties": false }, "SystemAuditParametersDto": { "type": "object", "properties": { "emailAddress": { "type": "string", "default": "", "nullable": true }, "action": { "type": "string", "default": "", "nullable": true }, "ipAddress": { "type": "string", "default": "", "nullable": true }, "effectiveAction": { "type": "string", "default": "", "nullable": true }, "details": { "type": "string", "default": "", "nullable": true }, "searchText": { "type": "string", "nullable": true }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "objectTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "viewChildOrganizations": { "type": "boolean", "default": false }, "objectId": { "type": "string", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000" }, "actions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "function": { "type": "string", "default": "", "nullable": true }, "page": { "type": "string", "default": "", "nullable": true }, "emailAddresses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "afterKeys": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValue" }, "nullable": true }, "description": "Paging keys for results past the first 10,000 - send back the afterKeyLookup from the previous response's pagination header.\r\n(Public API field name, kept from before the Elasticsearch client upgrade.)", "nullable": true }, "indexName": { "type": "string", "nullable": true }, "query": { "$ref": "#/components/schemas/SystemAuditItemQueryDescriptorAction" }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/SortOptions" }, "nullable": true }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalRows": { "type": "integer", "format": "int64" }, "estimateTotal": { "type": "boolean" }, "skipPaging": { "type": "boolean" }, "maxDocuments": { "type": "integer", "format": "int32", "nullable": true }, "timeLimit": { "type": "string", "format": "date-span", "nullable": true }, "maxIterations": { "type": "integer", "format": "int32" }, "overflowPageLookup": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValue" }, "nullable": true }, "nullable": true }, "searchAfter": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValue" }, "nullable": true }, "grouping": { "$ref": "#/components/schemas/ElasticGrouping" } }, "additionalProperties": false }, "TagDto": { "type": "object", "properties": { "tagId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "active": { "type": "boolean" }, "tagType": { "type": "integer", "format": "int32" }, "tagItemsText": { "type": "array", "items": { "$ref": "#/components/schemas/DropdownOption" }, "nullable": true }, "tagItemsIPv4": { "type": "array", "items": { "$ref": "#/components/schemas/DropdownOption" }, "nullable": true }, "tagItemsIPv6": { "type": "array", "items": { "$ref": "#/components/schemas/DropdownOption" }, "nullable": true }, "tagItemsReadablePath": { "type": "array", "items": { "$ref": "#/components/schemas/DropdownOption" }, "nullable": true }, "tagItemsWritablePath": { "type": "array", "items": { "$ref": "#/components/schemas/DropdownOption" }, "nullable": true }, "allTagItems": { "type": "array", "items": { "$ref": "#/components/schemas/TagItemDto" }, "nullable": true } }, "additionalProperties": false }, "TagItemDto": { "type": "object", "properties": { "tagId": { "type": "string", "format": "uuid" }, "tagItemId": { "type": "integer", "format": "int64" }, "tagPrefixTypeId": { "type": "integer", "format": "int32" }, "tagItemType": { "type": "integer", "format": "int32" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TemporaryCompleteApprovalRequest": { "type": "object", "properties": { "approvalRequestId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "comment": { "type": "string", "nullable": true }, "useBuiltIn": { "type": "boolean", "nullable": true }, "isApproved": { "type": "boolean" }, "mergeType": { "$ref": "#/components/schemas/ApprovalRequestMergeType" }, "appliesToType": { "$ref": "#/components/schemas/ApprovalRequestAppliesToType" }, "expirationMinutes": { "type": "integer", "format": "int32", "nullable": true }, "useElevation": { "type": "boolean", "nullable": true }, "elevationMinutes": { "type": "integer", "format": "int32", "nullable": true }, "reviewer": { "type": "string", "nullable": true }, "notifyUser": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TemporaryPolicySettings": { "type": "object", "properties": { "tempPolicyDuration": { "type": "integer", "format": "int32" }, "allowedAppliesToRequestComputer": { "type": "boolean" }, "allowedAppliesToRequestGroup": { "type": "boolean" }, "allowedAppliesToEntireOrg": { "type": "boolean" }, "enableUseBuiltIns": { "type": "boolean" }, "requireBuiltInMatch": { "type": "boolean" }, "fileHashCustomRuleTempApprovalAllowed": { "type": "boolean" }, "installModeTempApprovalAllowed": { "type": "boolean" }, "enableTriggeredInstallationMode": { "type": "boolean" }, "triggeredInstallationModeDurationHours": { "type": "integer", "format": "int32" }, "learningModeTempApprovalAllowed": { "type": "boolean" }, "allowElevationKnownApplications": { "type": "boolean" }, "elevationPolicyDurationKnownApplications": { "type": "integer", "format": "int32" }, "allowElevationUnknownApplications": { "type": "boolean" }, "elevationPolicyDurationUnknownApplications": { "type": "integer", "format": "int32" }, "allowedToRejectRequests": { "type": "boolean" }, "allowedToSendResponseNotification": { "type": "boolean" } }, "additionalProperties": false }, "TermQuery": { "required": [ "field", "value" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "caseInsensitive": { "type": "boolean", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "queryName": { "type": "string", "nullable": true }, "value": { "$ref": "#/components/schemas/FieldValue" } }, "additionalProperties": false }, "TermsLookup": { "required": [ "id", "index", "path" ], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "index": { "$ref": "#/components/schemas/IndexName" }, "path": { "$ref": "#/components/schemas/Field" }, "routing": { "$ref": "#/components/schemas/Routing" } }, "additionalProperties": false }, "TermsQuery": { "required": [ "field", "terms" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "queryName": { "type": "string", "nullable": true }, "terms": { "$ref": "#/components/schemas/TermsQueryField" } }, "additionalProperties": false }, "TermsQueryField": { "type": "object", "properties": { "tag": { "$ref": "#/components/schemas/UnionTag" }, "value1": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValue" }, "nullable": true, "readOnly": true }, "value2": { "$ref": "#/components/schemas/TermsLookup" } }, "additionalProperties": false }, "TermsSetQuery": { "required": [ "field", "terms" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "minimumShouldMatch": { "$ref": "#/components/schemas/MinimumShouldMatch" }, "minimumShouldMatchField": { "$ref": "#/components/schemas/Field" }, "minimumShouldMatchScript": { "$ref": "#/components/schemas/Script" }, "queryName": { "type": "string", "nullable": true }, "terms": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TextEmbedding": { "required": [ "modelText" ], "type": "object", "properties": { "modelId": { "type": "string", "nullable": true }, "modelText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TextExpansionQuery": { "required": [ "field", "modelId", "modelText" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "modelId": { "type": "string", "nullable": true }, "modelText": { "type": "string", "nullable": true }, "pruningConfig": { "$ref": "#/components/schemas/TokenPruningConfig" }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TextQueryType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "ThreatLockerActionDto": { "type": "object", "properties": { "fullpath": { "type": "string", "default": "", "nullable": true }, "policyid": { "type": "string", "default": "", "nullable": true }, "username": { "type": "string", "default": "", "nullable": true }, "actionid": { "type": "integer", "format": "int32" }, "hash": { "type": "string", "default": "", "nullable": true }, "processName": { "type": "string", "default": "", "nullable": true }, "certs": { "type": "array", "items": { "$ref": "#/components/schemas/ThreatLockerCertDto" }, "nullable": true }, "applicationId": { "type": "string", "default": "", "nullable": true }, "datetime": { "type": "string", "format": "date-time" }, "logAction": { "type": "boolean" }, "SerialNumber": { "type": "string", "default": "", "nullable": true }, "deviceType": { "type": "string", "default": "", "nullable": true }, "actionType": { "type": "string", "default": "", "nullable": true }, "size": { "type": "integer", "format": "int64" }, "processId": { "type": "integer", "format": "int32" }, "ringFence": { "type": "boolean" }, "policyName": { "type": "string", "default": "", "nullable": true }, "applicationName": { "type": "string", "default": "", "nullable": true }, "encryptionStatus": { "type": "integer", "format": "int32" }, "installedBy": { "type": "array", "items": { "type": "string" }, "default": "[]", "nullable": true }, "monitorOnly": { "type": "boolean" }, "notes": { "type": "string", "default": "", "nullable": true }, "sha256": { "type": "string", "default": "", "nullable": true }, "ringfencePolicyId": { "type": "string", "default": "", "nullable": true }, "remotePresence": { "type": "boolean" }, "organizationId": { "type": "string", "default": "", "nullable": true }, "hostname": { "type": "string", "default": "", "nullable": true }, "computerId": { "type": "string", "default": "", "nullable": true }, "manufacturer": { "type": "string", "default": "", "nullable": true }, "osType": { "type": "integer", "format": "int32" }, "destinationIP": { "type": "string", "default": "", "nullable": true }, "DomainName": { "type": "string", "default": "", "nullable": true }, "organizationName": { "type": "string", "default": "", "nullable": true }, "cmdLine": { "type": "string", "default": "", "nullable": true } }, "additionalProperties": false }, "ThreatLockerCertDto": { "type": "object", "properties": { "sha": { "type": "string", "default": "", "nullable": true }, "subject": { "type": "string", "default": "", "nullable": true }, "validCert": { "type": "boolean" }, "digestmismatch": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ThreatLockerItemDto": { "type": "object", "properties": { "d": { "type": "string", "format": "date-time" }, "u": { "type": "string", "description": "Username", "default": "", "nullable": true }, "pid": { "type": "string", "description": "PolicyID", "format": "uuid", "default": "00000000-0000-0000-0000-000000000000", "nullable": true }, "pn": { "type": "string", "description": "PolicyName", "default": "", "nullable": true }, "at": { "type": "integer", "description": "ActionType", "format": "int32" }, "aid": { "type": "integer", "description": "ActionID", "format": "int32" }, "a": { "type": "array", "items": { "$ref": "#/components/schemas/Int32ObjectKeyValuePair" }, "description": "Attribute", "nullable": true } }, "additionalProperties": false }, "TokenPruningConfig": { "type": "object", "properties": { "onlyScorePrunedTokens": { "type": "boolean", "nullable": true }, "tokensFreqRatioThreshold": { "type": "integer", "format": "int32", "nullable": true }, "tokensWeightThreshold": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "TypeQuery": { "required": [ "value" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "queryName": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UnionTag": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "UpdateStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "UploadRequestDto": { "type": "object", "properties": { "uploadRequestId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "computerId": { "type": "string", "format": "uuid" }, "shA256": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "filename": { "type": "string", "nullable": true }, "filepath": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValueKind": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "VersionType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "WeightedTokensQuery": { "required": [ "field", "tokens" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "pruningConfig": { "$ref": "#/components/schemas/TokenPruningConfig" }, "queryName": { "type": "string", "nullable": true }, "tokens": { "type": "object", "additionalProperties": { "type": "number", "format": "float" }, "nullable": true } }, "additionalProperties": false }, "WildcardQuery": { "required": [ "field" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "caseInsensitive": { "type": "boolean", "nullable": true }, "field": { "$ref": "#/components/schemas/Field" }, "queryName": { "type": "string", "nullable": true }, "rewrite": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "wildcard": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WrapperQuery": { "required": [ "query" ], "type": "object", "properties": { "boost": { "type": "number", "format": "float", "nullable": true }, "query": { "type": "string", "nullable": true }, "queryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ZeroTermsQuery": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" } }, "securitySchemes": { "Authorization": { "type": "apiKey", "description": "Please insert Standard Authorization header.", "name": "Authorization", "in": "header" }, "ManagedOrganizationId": { "type": "apiKey", "description": "Please insert Managed Organization Id.", "name": "ManagedOrganizationId", "in": "header" }, "OverrideManagedOrganizationId": { "type": "apiKey", "description": "Please insert Managed Organization Id.", "name": "OverrideManagedOrganizationId", "in": "header" } } }, "security": [ { "Authorization": [ ], "ManagedOrganizationId": [ ], "OverrideManagedOrganizationId": [ ] } ] }