Sample response:
The UUID4 of the job created for the operation
\nWhen used with the /get/{jobId} API, returns the job's status and payload, as defined by schema `JobStatus`","format":"^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$","default":"0ba2a3cd-166d-46f6-945b-c67a9037abc7"}},"required":["jobId"],"type":"object","additionalProperties":false},"JobOrResult_IComputerList_":{"description":"Either an object containing a Job ID *OR* schema 'IComputerList'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type IComputerList
","oneOf":[{"$ref":"#/components/schemas/IComputerList"},{"$ref":"#/components/schemas/JobCreationResult"}]},"RunAsJobON.On":{"enum":["on"],"type":"string"},"ComputerColumnNames":{"description":"Defines a union of all known fields that can be used to filter computers","enum":["emonJsonDataColumns","computerId","computerName","computerCapabilities","computerInactiveCapabilities","computerDeploymentStatus","computerIP","computerClientVersion","osName","osVersion","daInstalled","computerDeployTime","computerDeployTimeFrom","computerDeployTimeTo","computerLastErrorCode","computerLastErrorDescription","computerLastConnection","computerLastConnectionFrom","computerLastConnectionTo","computerSyncedonTo","computerSyncedon","computerSyncedonFrom","syncedOn","computerLastLoggedInUser","computerLastLoggedInPrebootUser","computerFdeStatus","computerFdeVersion","computerFdeLastRecoveryDate","computerFdeLastRecoveryDateFrom","computerFdeLastRecoveryDateTo","computerFdeWilWolStatus","computerFdeTpmId","computerFdeTpmStatus","computerFdeTpmVersion","computerFdeWilWolStatusUpdatedOn","computerFdeWilWolStatusUpdatedOnFrom","computerFdeWilWolStatusUpdatedOnTo","computerFdeProgress","computerFdeProgressFrom","computerFdeProgressTo","computerType","endpointType","amUpdatedOn","amUpdatedOnFrom","amUpdatedOnTo","amStatus","isolated","isDeleted","complianceStatus","amUpdatedIntervalStatus","isInDomain","domainName","o_x","devices_emon_status_data_selector","deleted_devices_emon_status_data_selector","computerAmDatVersion","computerAmDatDate","computerAmDatDateFrom","computerAmDatDateTo","computerAmLicExpirationDate","computerAmProviderBrandReport","computerAmLicExpirationDateFrom","computerAmLicExpirationDateTo","computerAmTotalInfected","computerAmTotalInfectedFrom","computerAmTotalInfectedTo","computerAmInfections","computerSdPackageName","computerSdPolicyName","computerSdPolicyVersion","computerAbState","computerAbStatusBotNames","computerAmScannedon","computerAmScannedonFrom","computerAmScannedonTo","computerAmTotalQuarantined","computerAmTotalQuarantinedFrom","computerAmTotalQuarantinedTo","computerLastContactedPolicyServerIp","computerLastContactedPolicyServerName","computerSdPackageVersion","computerComplianceViolationIds","computerSmartCardStatus","fdeRemoteUnlockOperation","fdeRemoteUnlockStatus","computerCanonicalName","stoppedBlades","enforcedModifiedOn","enforcedPolicyMalware20","enforcedPolicyTe130","enforcedPolicyEfr120","enforcedPolicyAntibot100","enforcedPolicyMe30","enforcedPolicyFdeDevice35","enforcedPolicyFdeUser36","enforcedPolicyFw10","enforcedPolicyCompliance60","enforcedPolicyApplicationControl22","enforcedPolicySaAccessZones11","enforcedPolicyCommonClientSettings51","enforcedPolicyDocSecPolicy91","enforcedVersionPolicyMalware20","enforcedVersionPolicyTe130","enforcedVersionPolicyEfr120","enforcedVersionPolicyAntibot100","enforcedVersionPolicyMe30","enforcedVersionPolicyFdeDevice35","enforcedVersionPolicyFdeUser36","enforcedVersionPolicyFw10","enforcedVersionPolicyCompliance60","enforcedVersionPolicyApplicationControl22","enforcedVersionPolicySaAccessZones11","enforcedVersionPolicyCommonClientSettings51","enforcedVersionPolicyDocSecPolicy91","enforcedNamePolicyMalware20","enforcedNamePolicyTe130","enforcedNamePolicyEfr120","enforcedNamePolicyAntibot100","enforcedNamePolicyMe30","enforcedNamePolicyFdeDevice35","enforcedNamePolicyFdeUser36","enforcedNamePolicyFw10","enforcedNamePolicyCompliance60","enforcedNamePolicyApplicationControl22","enforcedNamePolicySaAccessZones11","enforcedNamePolicyCommonClientSettings51","enforcedNamePolicyDocSecPolicy91","deployedModifiedOn","deployedPolicyMalware20","deployedPolicyTe130","deployedPolicyEfr120","deployedPolicyAntibot100","deployedPolicyMe30","deployedPolicyFdeDevice35","deployedPolicyFdeUser36","deployedPolicyFw10","deployedPolicyCompliance60","deployedPolicyApplicationControl22","deployedPolicySaAccessZones11","deployedPolicyCommonClientSettings51","deployedPolicyDocSecPolicy91","deployedVersionPolicyMalware20","deployedVersionPolicyTe130","deployedVersionPolicyEfr120","deployedVersionPolicyAntibot100","deployedVersionPolicyMe30","deployedVersionPolicyFdeDevice35","deployedVersionPolicyFdeUser36","deployedVersionPolicyFw10","deployedVersionPolicyCompliance60","deployedVersionPolicyApplicationControl22","deployedVersionPolicySaAccessZones11","deployedVersionPolicyCommonClientSettings51","deployedVersionPolicyDocSecPolicy91","deployedNamePolicyMalware20","deployedNamePolicyTe130","deployedNamePolicyEfr120","deployedNamePolicyAntibot100","deployedNamePolicyMe30","deployedNamePolicyFdeDevice35","deployedNamePolicyFdeUser36","deployedNamePolicyFw10","deployedNamePolicyCompliance60","deployedNamePolicyApplicationControl22","deployedNamePolicySaAccessZones11","deployedNamePolicyCommonClientSettings51","deployedNamePolicyDocSecPolicy91","computerCpuLoadCategory","computerTotalCpuLoadCategory","computerCpuRank","computerTotalCpuRank","deviceComment","computerGroups","computerOrUsers","filterAndThoseComputers","filterAndThoseComputersOrUsers","filterComplianceStatus","computerFreeSearch","computerEnforcedInstalledPolicyName","computerEnforcedInstalledPolicyVersion","computerStoppedBlades","Is_Device_In_Group","global","permission"],"type":"string"},"FilterType":{"enum":["Contains","StartsWith","EndsWith","Exact","Grater","Smaller","BitOr","BitAnd","IsNull","NotNull","Not","JsonbExact","JsonbContainsAnd","JsonbContainsOr","NestedJsonbContainsAnd","NestedJsonbContainsOr","NestedJsonbExactAnd","NestedJsonbExactOr","NestedJsonbDateRange","ArrayContains","Between"],"type":"string"},"IFilter":{"description":"A filter by which to select which devices are to be affected by the operation","properties":{"columnName":{"$ref":"#/components/schemas/ComputerColumnNames"},"filterValues":{"items":{"type":"string"},"type":"array"},"filterType":{"$ref":"#/components/schemas/FilterType"},"isJson":{"type":"boolean"}},"required":["columnName","filterValues"],"type":"object","additionalProperties":false},"Paging":{"properties":{"pageSize":{"type":"number","format":"double","description":"The number of entities to return in the result","minimum":1},"offset":{"type":"number","format":"double","description":"An offset from the start of the results from which to fetch entities. For example, \\'Fetch 10 computers from offset 15\\' will return computers 10 through 25","minimum":0}},"required":["pageSize","offset"],"type":"object","additionalProperties":false},"EmonView":{"description":"An enum specifying possible EMON Views","enum":["AllDevices","Devices","DeletedDevices"],"type":"string"},"ComputersByUnlimitedFilterArgs":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/IFilter"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging","description":"Control's the query's pagination\n\nAsset management queries can result in a large amount of data and take a non-negligible amount of time to complete.\nAs such, queries are 'paged', that is, split at the source- instead of a single monolithic query/response, the consumer calls the API\nmultiple times to get a different part of the result each time"},"viewType":{"$ref":"#/components/schemas/EmonView","description":"The 'view' from which the data should be drawn.\n
View 'Devices' contains Active Endpoints (i.e. Endpoints that have recently communicated with the server)
\nView 'AllDevices' contains all known Endpoints which may include 'dead' devices such as computers that have been uninstalled
\nView 'DeletedDevices' contains only deleted Endpoint. A query for deleted Endpoints can also be made by querying the `ComputerColumnNames.IsDeleted` field
"}},"required":["filters"],"type":"object","additionalProperties":false,"example":{"filters":[{"columnName":"computerName","filterValues":["A Name"],"filterType":"Contains"}],"paging":{"pageSize":10,"offset":0}}},"ComputersByFilterPaging":{"properties":{"pageSize":{"type":"integer","format":"int32","description":"The number of entities to return in the result","default":"10","minimum":1,"maximum":50},"offset":{"type":"integer","format":"int32","description":"An offset from the start of the results from which to fetch entities. For example, \\'Fetch 10 computers from offset 15\\' will return computers 10 through 25","default":"0","minimum":0}},"required":["pageSize","offset"],"type":"object","additionalProperties":false},"AssetView":{"enum":["ALL_DEVICES","DEVICES","DELETED_DEVICES"],"type":"string"},"ComputersByFilterArgs":{"properties":{"filters":{"items":{"$ref":"#/components/schemas/IFilter"},"type":"array"},"paging":{"$ref":"#/components/schemas/ComputersByFilterPaging","description":"Control's the query's pagination\n\nAsset management queries can result in a large amount of data and take a non-negligible amount of time to complete.\nAs such, queries are 'paged', that is, split at the source- instead of a single monolithic query/response, the consumer calls the API\nmultiple times to get a different part of the result each time"},"viewType":{"$ref":"#/components/schemas/AssetView","description":"The 'view' from which the data should be drawn.\n
View 'DEVICES' contains Active Endpoints (i.e. Endpoints that have recently communicated with the server)
\nView 'ALL_DEVICES' contains all known Endpoints which may include 'dead' devices such as computers that have been uninstalled
\nView 'DELETED_DEVICES' contains only deleted Endpoint. A query for deleted Endpoints can also be made by querying the `ComputerColumnNames.IsDeleted` field
"}},"type":"object","additionalProperties":false,"example":{"filters":[{"columnName":"computerName","filterValues":["A Name"],"filterType":"Contains"}],"paging":{"pageSize":10,"offset":0}}},"RunAsJob":{"description":"Depicts values that, when used in the header specified by RestHeaders.USE_JOB, determines whether a given operation will run as a job (asynchronously)","enum":["on","off"],"type":"string"},"AcknowledgeResponse":{"description":"A response indicating the request has been processed by the server","properties":{"acknowledged":{"type":"boolean","description":"Indicates whether the server acknowledged the operation\n\nFor synchronous requests, this indicates the server has processed the request and has returned a response
"},"utcEpoch":{"type":"number","format":"double","description":"The millisecond UTC epoch on which the request was acknowledged\nSee documentation for the acknowledged field for more information"}},"required":["acknowledged","utcEpoch"],"type":"object","additionalProperties":false},"JobOrResult_AcknowledgeResponse_":{"description":"Either an object containing a Job ID *OR* schema 'AcknowledgeResponse'\n
The actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type AcknowledgeResponse
","oneOf":[{"$ref":"#/components/schemas/AcknowledgeResponse"},{"$ref":"#/components/schemas/JobCreationResult"}]},"IocType":{"enum":["Domain","IP","URL","MD5","SHA1"],"type":"string"},"IndicatorOfCompromise":{"description":"An indicator that can be used to globally and laterally define and mitigate potential threats","properties":{"type":{"$ref":"#/components/schemas/IocType"},"value":{"type":"string"},"comment":{"type":"string"},"id":{"type":"string"},"modifiedOn":{"type":"string","format":"date-time"}},"required":["type","value","comment","id","modifiedOn"],"type":"object","additionalProperties":false},"PageOfIoc":{"description":"A \\'page\\' of Indicators of Compromise","properties":{"content":{"items":{"$ref":"#/components/schemas/IndicatorOfCompromise"},"type":"array"},"total":{"type":"number","format":"double"}},"required":["content","total"],"type":"object","additionalProperties":false},"JobOrResult_PageOfIoc_":{"description":"Either an object containing a Job ID *OR* schema 'PageOfIoc'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type PageOfIoc
","oneOf":[{"$ref":"#/components/schemas/PageOfIoc"},{"$ref":"#/components/schemas/JobCreationResult"}]},"IocFieldsValue":{"enum":["iocValue"],"type":"string"},"IocFieldsComment":{"enum":["iocComment"],"type":"string"},"SortDirection":{"enum":["ASC","DESC"],"type":"string"},"LimitedIocSorting":{"properties":{"field":{"anyOf":[{"$ref":"#/components/schemas/IocFieldsValue"},{"$ref":"#/components/schemas/IocFieldsComment"}],"description":"The Indicator of Compromise field to search by"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"required":["field","direction"],"type":"object","additionalProperties":false},"IocPagedRequest":{"properties":{"filter":{"type":"string","description":"The indicator value or comment to search for. The filter functions as a case-insensitive \\'Contains\\'. Example i.e. filter \\'efg\\' will match IoCs \\'abcdEFG\\', \\'efGGG\\' and \\'yEfG\\'"},"page":{"type":"integer","format":"int32","description":"A multiplicative offset. When fetching, for example page *3* with size *10*, will cause the query to return IoCs 30-40"},"size":{"type":"integer","format":"int32","description":"The number of matches to return"},"sort":{"items":{"$ref":"#/components/schemas/LimitedIocSorting"},"type":"array","description":"The ways in which to sort the results"}},"type":"object","additionalProperties":false},"JobOrResult_IndicatorOfCompromise-Array_":{"description":"Either an object containing a Job ID *OR* schema 'IndicatorOfCompromise-Array'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type IndicatorOfCompromise-Array
","oneOf":[{"items":{"$ref":"#/components/schemas/IndicatorOfCompromise"},"type":"array"},{"$ref":"#/components/schemas/JobCreationResult"}]},"UpdateIoc":{"properties":{"type":{"$ref":"#/components/schemas/IocType"},"value":{"type":"string"},"comment":{"type":"string"},"id":{"type":"string"}},"required":["type","value","comment","id"],"type":"object","additionalProperties":false},"IndicatorOfCompromiseDto":{"properties":{"type":{"$ref":"#/components/schemas/IocType"},"value":{"type":"string"},"comment":{"type":"string"}},"required":["type","value","comment"],"type":"object","additionalProperties":false},"JobState":{"description":"Depicts possible states a job can be in","enum":["IN_PROGRESS","NOT_FOUND","DONE","FAILED"],"type":"string"},"JobStatus":{"properties":{"status":{"$ref":"#/components/schemas/JobState"},"statusCode":{"$ref":"#/components/schemas/StatusCodes"},"statusType":{"type":"integer","format":"int32","description":"The type of HTTP code (i.e. 2xx, 3xx, 4xx) specified as a single digit","minimum":0,"maximum":5},"data":{"description":"The data returned by the job. To determine the expected schema, consult the request\\'s schema"}},"required":["status","statusCode","statusType"],"type":"object","additionalProperties":false},"EntityType":{"enum":["ORGANIZATION_ROOT","GROUP","VIRTUAL_GROUP","USER","COMPUTER","IP_RANGE","GATEWAY","OTHER_USERS_AND_COMPUTERS","DIRECTORIES_ROOT","IP_RANGES_ROOT","VIRTUAL_GROUPS_ROOT","WORKGROUPS_ROOT","DELETED_USERS_AND_COMPUTERS_ROOT","DEPLOYMENT_ROOT","OFFLINE_GROUPS_ROOT","OFFLINE_GROUP","DUMMY"],"type":"string"},"SlimEntity":{"properties":{"id":{"type":"string","description":"A unique ID"},"name":{"type":"string","description":"The entity\\'s name"},"type":{"$ref":"#/components/schemas/EntityType"}},"required":["id","type"],"type":"object","additionalProperties":false},"JobOrResult_SlimEntity-Array_":{"description":"Either an object containing a Job ID *OR* schema 'SlimEntity-Array'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type SlimEntity-Array
","oneOf":[{"items":{"$ref":"#/components/schemas/SlimEntity"},"type":"array"},{"$ref":"#/components/schemas/JobCreationResult"}]},"FreeSearchFilterType":{"enum":["STARTS_WITH","EXACT","CONTAINS","ENDS_WITH"],"type":"string"},"SearchableEntityTypes":{"enum":["GROUP","VIRTUAL_GROUP","USER","COMPUTER","OFFLINE_GROUP"],"type":"string"},"SearchInOrganizationRequest":{"properties":{"searchTerm":{"type":"string"},"searchType":{"$ref":"#/components/schemas/FreeSearchFilterType"},"paging":{"$ref":"#/components/schemas/Paging"},"entityTypesToSearch":{"items":{"$ref":"#/components/schemas/SearchableEntityTypes"},"type":"array"}},"required":["searchTerm"],"type":"object","additionalProperties":false},"Id":{"type":"string","format":"^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-\\b[0-9a-fA-F]{12}$","description":"A unique ID"},"JobOrResult_Id_":{"description":"Either an object containing a Job ID *OR* schema 'Id'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type Id
","oneOf":[{"$ref":"#/components/schemas/Id"},{"$ref":"#/components/schemas/JobCreationResult"}]},"VirtualGroupMembers":{"properties":{"userIds":{"items":{"type":"string"},"type":"array","description":"A list of User IDs","minItems":0},"computerIds":{"items":{"type":"string"},"type":"array","description":"A list of Computer IDs","minItems":0},"groupIds":{"items":{"type":"string"},"type":"array","description":"A list of Group IDs","minItems":0}},"type":"object","additionalProperties":false},"CreateVirtualGroupRequest":{"properties":{"name":{"type":"string"},"description":{"type":"string"},"members":{"$ref":"#/components/schemas/VirtualGroupMembers"}},"required":["name"],"type":"object","additionalProperties":false},"RunAsJob.On":{"enum":["on"],"type":"string"},"ConnectionState":{"enum":["CONNECTED","DISCONNECTED","RESTRICTED"],"type":"string"},"BladeFamily":{"enum":["General Settings","Threat Prevention","Data Protection","OneCheck","Deployment","Remote Access VPN","Capsule Docs","Access","Agent Settings"],"type":"string"},"LegacyBladeFamily":{"enum":["Anti Bot","Anti Malware","Threat Emulation","Forensics","Full Disk Encryption","Full Disk Encryption Global","OneCheck","Common Client Settings","Deployment","EncryptedAccessRules","VPN","Capsule Docs","Media Encryption","Firewall","Access Zones","Application Control","Compliance"],"type":"string"},"AnyFamily":{"anyOf":[{"$ref":"#/components/schemas/BladeFamily"},{"$ref":"#/components/schemas/LegacyBladeFamily"}]},"StandardizedTimestamp":{"description":"A timestamp composite field as defined by the CPM API","properties":{"posix":{"type":"number","format":"double"},"iso-8601":{"type":"string","format":"date-time"}},"required":["posix","iso-8601"],"type":"object","additionalProperties":false},"RuleSettingsModifications":{"description":"Settings modifications made to a rule","properties":{"modified":{"type":"boolean"}},"required":["modified"],"type":"object","additionalProperties":false},"RuleOrderModification":{"description":"An order modification made to a rule","properties":{"modified":{"type":"boolean"},"from":{"type":"integer","format":"int32","description":"The index within the rulebase the rule was moved from/created onThis field will be null when order was not changed or the rule is pending first installation after being created
"},"to":{"type":"integer","format":"int32","description":"The index within the rulebase the rule was moved to"}},"required":["modified"],"type":"object","additionalProperties":false},"RuleAssignment":{"properties":{"id":{"type":"string","description":"A unique ID"},"name":{"type":"string","description":"The entity\\'s name"},"type":{"$ref":"#/components/schemas/EntityType"}},"required":["id","type"],"type":"object","additionalProperties":false},"RuleAssignmentsModification":{"description":"Assignment modifications made to a rule","properties":{"modified":{"type":"boolean"},"added":{"items":{"$ref":"#/components/schemas/RuleAssignment"},"type":"array","description":"A list of assignments added to the rule"},"removed":{"items":{"$ref":"#/components/schemas/RuleAssignment"},"type":"array","description":"A list of assignments removed from the rule"}},"required":["modified"],"type":"object","additionalProperties":false},"RuleModifications":{"description":"Modifications made to a rule","properties":{"settings":{"$ref":"#/components/schemas/RuleSettingsModifications"},"order":{"$ref":"#/components/schemas/RuleOrderModification"},"assignments":{"$ref":"#/components/schemas/RuleAssignmentsModification"}},"required":["settings","order","assignments"],"type":"object","additionalProperties":false},"ModifiedRule":{"description":"A rule that has been modified since it was last installed","properties":{"id":{"type":"string"},"connectionState":{"$ref":"#/components/schemas/ConnectionState"},"name":{"type":"string"},"family":{"$ref":"#/components/schemas/AnyFamily"},"lastModifiedOn":{"$ref":"#/components/schemas/StandardizedTimestamp"},"lastModifiedBy":{"type":"string"},"modified":{"$ref":"#/components/schemas/RuleModifications"}},"required":["id","connectionState","name","family","modified"],"type":"object","additionalProperties":false},"BlockBitLockerOptions":{"enum":["DEFAULT","ON","OFF"],"type":"string"},"JobOrResult_RuleAssignment-Array_":{"description":"Either an object containing a Job ID *OR* schema 'RuleAssignment-Array'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type RuleAssignment-Array
","oneOf":[{"items":{"$ref":"#/components/schemas/RuleAssignment"},"type":"array"},{"$ref":"#/components/schemas/JobCreationResult"}]},"RuleId":{"type":"string","format":"^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-\\b[0-9a-fA-F]{12}(?:@[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-\\b[0-9a-fA-F]{12})*$","description":"A Unified Rule's unique ID"},"JobOrResult_ModifiedRule_":{"description":"Either an object containing a Job ID *OR* schema 'ModifiedRule'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type ModifiedRule
","oneOf":[{"$ref":"#/components/schemas/ModifiedRule"},{"$ref":"#/components/schemas/JobCreationResult"}]},"CloneRulePositionTop":{"enum":["TOP"],"type":"string"},"RulePositionTop":{"properties":{"type":{"$ref":"#/components/schemas/CloneRulePositionTop"}},"required":["type"],"type":"object","additionalProperties":false},"CloneRulePositionBelow":{"enum":["BELOW"],"type":"string"},"CloneRulePositionAbove":{"enum":["ABOVE"],"type":"string"},"RulePositionRelative":{"properties":{"type":{"anyOf":[{"$ref":"#/components/schemas/CloneRulePositionBelow"},{"$ref":"#/components/schemas/CloneRulePositionAbove"}]},"ruleId":{"type":"string","description":"A Unified Rule\\'s unique ID"}},"required":["type","ruleId"],"type":"object","additionalProperties":false},"ConnectionStates":{"enum":["CONNECTED","DISCONNECTED","RESTRICTED"],"type":"string"},"Sections":{"enum":["USER","DEVICE"],"type":"string"},"ICloneRuleInput":{"properties":{"name":{"type":"string"},"assignments":{"items":{"type":"string"},"type":"array"},"order":{"anyOf":[{"$ref":"#/components/schemas/RulePositionTop"},{"$ref":"#/components/schemas/RulePositionRelative"}]},"connectionState":{"$ref":"#/components/schemas/ConnectionStates"},"section":{"$ref":"#/components/schemas/Sections"}},"required":["name","assignments","order"],"type":"object","additionalProperties":false},"PolicyOrientation":{"enum":["USER","DEVICE"],"type":"string"},"TemplateAssignmentState":{"enum":["Created","InProcess","Failed","Success"],"type":"string"},"RuleTemplateAssignment":{"properties":{"id":{"type":"string"},"ruleId":{"type":"string"},"templateId":{"type":"string"},"templateVersion":{"type":"number","format":"double"},"state":{"$ref":"#/components/schemas/TemplateAssignmentState"}},"required":["id","ruleId","templateId","templateVersion","state"],"type":"object","additionalProperties":false},"RuleMetadata":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"comment":{"type":"string"},"assignments":{"items":{"$ref":"#/components/schemas/RuleAssignment"},"type":"array"},"connectionState":{"$ref":"#/components/schemas/ConnectionState"},"family":{"$ref":"#/components/schemas/AnyFamily"},"isDefaultRule":{"type":"boolean"},"order":{"type":"number","format":"double"},"orientation":{"$ref":"#/components/schemas/PolicyOrientation"},"msspTemplate":{"$ref":"#/components/schemas/RuleTemplateAssignment"}},"required":["id","name","comment","assignments","connectionState","family","isDefaultRule","order","orientation"],"type":"object","additionalProperties":false},"JobOrResult_RuleMetadata_":{"description":"Either an object containing a Job ID *OR* schema 'RuleMetadata'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type RuleMetadata
","oneOf":[{"$ref":"#/components/schemas/RuleMetadata"},{"$ref":"#/components/schemas/JobCreationResult"}]},"JobOrResult_RuleMetadata-Array_":{"description":"Either an object containing a Job ID *OR* schema 'RuleMetadata-Array'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type RuleMetadata-Array
","oneOf":[{"items":{"$ref":"#/components/schemas/RuleMetadata"},"type":"array"},{"$ref":"#/components/schemas/JobCreationResult"}]},"ServerOptimizationTemplate":{"properties":{"templateId":{"type":"string"},"templateName":{"type":"string"},"templateDescription":{"type":"string"},"templateHash":{"type":"string"}},"required":["templateId","templateName","templateDescription","templateHash"],"type":"object","additionalProperties":false},"PolicyTemplateName":{"enum":["TUNING","STRICT","DETECT","CUSTOM"],"type":"string"},"BladeAntiBot":{"enum":["ANTI_BOT"],"type":"string"},"PolicySettingsIUrlFilteringProtectionBladeAntiBotMetadata":{"properties":{"blade":{"$ref":"#/components/schemas/BladeAntiBot"}},"required":["blade"],"type":"object","additionalProperties":false},"CapabilityMode":{"enum":["PREVENT","DETECT","OFF","CUSTOM"],"type":"string"},"UrlFilteringCategoryNames":{"enum":["ALCOHOL_AND_TOBACCO","ANONYMIZER","ART_AND_CULTURE","BOTNETS","BUSINESS_AND_ECONOMY","CHAT_AND_INSTANT_MESSAGING","COMPUTERS_AND_INTERNET","EDUCATION","EMAIL","ENTERTAINMENT","FASHION","FILE_STORAGE_AND_SHARING","FINANCIAL_SERVICES","GAMBLING","GAMES","GOVERNMENT_AND_MILITARY","GREETING_CARDS","HACKING","HATE_AND_RACISM","HEALTH","ILLEGAL_AND_QUESTIONABLE","ILLEGAL_DRUGS","INACTIVE_SITES","INSTANT_CHAT","INSTANT_MESSAGING","JOB_SEARCH_AND_CAREERS","MEDIA_SHARING","MEDIA_STREAMS","NEWS_AND_MEDIA","NEWSGROUPS_AND_FORUMS","NON_PROFIT_AND_NGO","NUDITY","PEER_TO_PEER_FILE_SHARING","PERSONALS_AND_DATING","PHISHING","POLITICAL_AND_ACTIVIST_GROUPS","PORNOGRAPHY","REAL_ESTATE","RECREATION","RELIGION","RESTAURANTS_AND_DINING_AND_FOOD","SEARCH_ENGINES_AND_PORTALS","SEX","SEX_EDUCATION","SHOPPING","SOCIAL_NETWORKING","SOFTWARE_DOWNLOADS","SPAM","SPORTS","SPYWARE_AND_MALICIOUS_SITES","TASTELESS","TRANSLATION","TRAVEL","UN_CATEGORIZED","VEHICLES","VIOLENCE","WEAPONS","WEB_ADVERTISEMENTS","HIGH_RISK","BLOGS_AND_PERSONAL_PAGES","CHILD_ABUSE","CRITICAL_RISK","GENERAL","LIFESTYLE","LINGERIE_SWIMSUIT_AND_SUGGESTIVE","LOW_RISK","MARIJUANA","MEDIUM_RISK","NATURE_AND_CONSERVATION","SUSPICIOUS_CONTENT","VERY_LOW_RISK","ARTIFICIAL_INTELLIGENCE","OCCULT","HOSTING_SITES","DYNAMIC_DNS","KEYLOGGERS"],"type":"string"},"UrlFilteringCategoryAction":{"enum":["BLOCK","ALLOW"],"type":"string"},"UrlFilteringCategoryRule":{"properties":{"name":{"$ref":"#/components/schemas/UrlFilteringCategoryNames"},"action":{"$ref":"#/components/schemas/UrlFilteringCategoryAction"}},"required":["name","action"],"type":"object","additionalProperties":false},"IUrlFilteringProtectionUserOverridesRules":{"properties":{"blockedUrls":{"items":{"type":"string"},"type":"array"},"categories":{"items":{"$ref":"#/components/schemas/UrlFilteringCategoryRule"},"type":"array"}},"type":"object","additionalProperties":false},"IUrlFilteringProtectionUserOverrides":{"properties":{"rules":{"$ref":"#/components/schemas/IUrlFilteringProtectionUserOverridesRules"},"allowDismissUrlFilteringAlert":{"type":"boolean"},"allowDismissMaliciousScriptAlert":{"type":"boolean"}},"type":"object","additionalProperties":false},"LogsMode":{"enum":["ENABLED","DISABLED"],"type":"string"},"IUrlFilteringProtection":{"properties":{"mode":{"$ref":"#/components/schemas/CapabilityMode"},"enableNetworkLevelFiltering":{"type":"boolean"},"blockMaliciousScripts":{"type":"boolean"},"userOverrides":{"$ref":"#/components/schemas/IUrlFilteringProtectionUserOverrides"},"allowLogsForVisitedSites":{"$ref":"#/components/schemas/LogsMode"}},"type":"object","additionalProperties":false},"PolicySettingsIUrlFilteringProtectionBladeAntiBot":{"properties":{"metadata":{"$ref":"#/components/schemas/PolicySettingsIUrlFilteringProtectionBladeAntiBotMetadata"},"settings":{"$ref":"#/components/schemas/IUrlFilteringProtection"}},"required":["settings"],"type":"object","additionalProperties":false},"BladeThreatEmulation":{"enum":["THREAT_EMULATION"],"type":"string"},"PolicySettingsIFilesProtectionBladeThreatEmulationMetadata":{"properties":{"blade":{"$ref":"#/components/schemas/BladeThreatEmulation"}},"required":["blade"],"type":"object","additionalProperties":false},"FileReputationState":{"properties":{"mode":{"$ref":"#/components/schemas/CapabilityMode"}},"required":["mode"],"type":"object","additionalProperties":false},"OfflineReputationState":{"properties":{"mode":{"$ref":"#/components/schemas/CapabilityMode"}},"required":["mode"],"type":"object","additionalProperties":false},"CustomIocState":{"properties":{"mode":{"$ref":"#/components/schemas/CapabilityMode"}},"required":["mode"],"type":"object","additionalProperties":false},"StaticAnalysisFileTypes":{"properties":{"office":{"$ref":"#/components/schemas/CapabilityMode"},"exe":{"$ref":"#/components/schemas/CapabilityMode"},"dll":{"$ref":"#/components/schemas/CapabilityMode"}},"type":"object","additionalProperties":false},"StaticAnalysisState":{"properties":{"enabled":{"type":"boolean"},"fileTypes":{"$ref":"#/components/schemas/StaticAnalysisFileTypes"}},"type":"object","additionalProperties":false},"ThreatPreventionSensors":{"properties":{"enabled":{"type":"boolean"},"fileReputation":{"$ref":"#/components/schemas/FileReputationState"},"offlineReputation":{"$ref":"#/components/schemas/OfflineReputationState"},"customIoc":{"$ref":"#/components/schemas/CustomIocState"},"staticAnalysis":{"$ref":"#/components/schemas/StaticAnalysisState"}},"type":"object","additionalProperties":false},"FailCloseMode":{"enum":["ALLOW","BLOCK"],"type":"string"},"NotificationsMode":{"enum":["ENABLED","DISABLED"],"type":"string"},"DomainPermission":{"enum":["ALLOW","BLOCK"],"type":"string"},"IFilesProtectionEmulationUploadFileProtectionDomainsActions":{"properties":{"uploadAction":{"$ref":"#/components/schemas/DomainPermission"},"domain":{"type":"string"}},"required":["uploadAction","domain"],"type":"object","additionalProperties":false},"ProtectedNetworkResourceIpRange":{"properties":{"firstIp":{"type":"string"},"lastIp":{"type":"string"}},"required":["firstIp","lastIp"],"type":"object","additionalProperties":false},"ProtectedNetworkResourceDomain":{"properties":{"value":{"type":"string"}},"required":["value"],"type":"object","additionalProperties":false},"UploadFileTypeActions":{"enum":["DEFAULT","EMULATE_SUSPEND","EMULATE_BACKGROUND_BLOCK_KNOWN_FILES","EMULATE_BACKGROUND","ALLOW_UPLOAD","BLOCK_UPLOAD"],"type":"string"},"IFilesProtectionEmulationUploadFileActionsFileTypeOverrides":{"properties":{"fileAction":{"$ref":"#/components/schemas/UploadFileTypeActions"},"fileType":{"type":"string"}},"required":["fileAction","fileType"],"type":"object","additionalProperties":false},"FileUploadUnsupportedFilesMode":{"enum":["ALLOW_UPLOAD","BLOCK_UPLOAD"],"type":"string"},"FileUploadSupportedFilesMode":{"enum":["EMULATE_SUSPEND","EMULATE_BACKGROUND_BLOCK_KNOWN_FILES","EMULATE_BACKGROUND","ALLOW_UPLOAD"],"type":"string"},"IFilesProtectionEmulationUploadFileActions":{"properties":{"fileTypeOverrides":{"items":{"$ref":"#/components/schemas/IFilesProtectionEmulationUploadFileActionsFileTypeOverrides"},"type":"array"},"unsupported":{"$ref":"#/components/schemas/FileUploadUnsupportedFilesMode"},"supported":{"$ref":"#/components/schemas/FileUploadSupportedFilesMode"}},"type":"object","additionalProperties":false},"IFilesProtectionEmulationUpload":{"properties":{"encryptionFailCloseMode":{"$ref":"#/components/schemas/FailCloseMode"},"failCloseMode":{"$ref":"#/components/schemas/FailCloseMode"},"notificationsMode":{"$ref":"#/components/schemas/NotificationsMode"},"fileProtectionDomainsActions":{"items":{"$ref":"#/components/schemas/IFilesProtectionEmulationUploadFileProtectionDomainsActions"},"type":"array"},"protectedIPs":{"items":{"$ref":"#/components/schemas/ProtectedNetworkResourceIpRange"},"type":"array"},"protectedDomains":{"items":{"$ref":"#/components/schemas/ProtectedNetworkResourceDomain"},"type":"array"},"maxFileSize":{"type":"number","format":"double"},"fileActions":{"$ref":"#/components/schemas/IFilesProtectionEmulationUploadFileActions"},"mode":{"$ref":"#/components/schemas/CapabilityMode"}},"type":"object","additionalProperties":false},"RiskLevel":{"description":"Describes possible risk levels","enum":["CRITICAL","HIGH","MEDIUM","LOW","VERY_LOW"],"type":"string"},"IFilesProtectionEmulationDownloadThreatExtractionElements":{"properties":{"description":{"type":"string"},"risk":{"$ref":"#/components/schemas/RiskLevel"},"name":{"type":"string"},"active":{"type":"boolean"}},"required":["description","risk","name","active"],"type":"object","additionalProperties":false},"DownloadProtectionExtractMode":{"enum":["CONVERT_PDF","EXTRACT_ELEMENTS"],"type":"string"},"IFilesProtectionEmulationDownloadThreatExtraction":{"properties":{"elements":{"items":{"$ref":"#/components/schemas/IFilesProtectionEmulationDownloadThreatExtractionElements"},"type":"array"},"mode":{"$ref":"#/components/schemas/DownloadProtectionExtractMode"}},"type":"object","additionalProperties":false},"FileTypeActions":{"enum":["DEFAULT","EXTRACT_SUSPEND","EMULATE_SUSPEND","EMULATE_BACKGROUND","ALLOW_DOWNLOAD","BLOCK_DOWNLOAD"],"type":"string"},"ExtractionMode":{"enum":["DEFAULT","CONVERT_PDF","EXTRACT_ELEMENTS"],"type":"string"},"IFilesProtectionEmulationDownloadFileActionsFileTypeOverrides":{"properties":{"action":{"$ref":"#/components/schemas/FileTypeActions"},"extractionMode":{"$ref":"#/components/schemas/ExtractionMode"},"defaultExtractionMode":{"$ref":"#/components/schemas/ExtractionMode"},"defaultAction":{"$ref":"#/components/schemas/FileTypeActions"},"description":{"type":"string"},"name":{"type":"string"}},"required":["action","extractionMode","defaultExtractionMode","defaultAction","description","name"],"type":"object","additionalProperties":false},"IFilesProtectionEmulationDownloadFileActions":{"properties":{"fileTypeOverrides":{"items":{"$ref":"#/components/schemas/IFilesProtectionEmulationDownloadFileActionsFileTypeOverrides"},"type":"array"},"emulatedOnly":{"$ref":"#/components/schemas/FileTypeActions"},"unsupported":{"$ref":"#/components/schemas/FileTypeActions"},"supported":{"$ref":"#/components/schemas/FileTypeActions"}},"type":"object","additionalProperties":false},"IFilesProtectionEmulationDownload":{"properties":{"encryptionFailCloseMode":{"$ref":"#/components/schemas/FailCloseMode"},"failCloseMode":{"$ref":"#/components/schemas/FailCloseMode"},"notificationsMode":{"$ref":"#/components/schemas/NotificationsMode"},"threatExtraction":{"$ref":"#/components/schemas/IFilesProtectionEmulationDownloadThreatExtraction"},"fileActions":{"$ref":"#/components/schemas/IFilesProtectionEmulationDownloadFileActions"}},"type":"object","additionalProperties":false},"TeUnsupportedFileAction":{"enum":["ALLOW","BLOCK"],"type":"string"},"IFilesProtectionEmulationUnsupportedFileTypeActions":{"properties":{"uploadAction":{"$ref":"#/components/schemas/TeUnsupportedFileAction"},"downloadAction":{"$ref":"#/components/schemas/TeUnsupportedFileAction"},"comment":{"type":"string"},"fileType":{"type":"string"}},"required":["uploadAction","downloadAction","comment","fileType"],"type":"object","additionalProperties":false},"FileTypeOverrideActions":{"enum":["DEFAULT","IGNORE","EMULATE"],"type":"string"},"IFilesProtectionEmulationFileSystemFileTypesOverrides":{"properties":{"action":{"$ref":"#/components/schemas/FileTypeOverrideActions"},"defaultAction":{"$ref":"#/components/schemas/FileTypeOverrideActions"},"description":{"type":"string"},"name":{"type":"string"}},"required":["action","defaultAction","description","name"],"type":"object","additionalProperties":false},"IFilesProtectionEmulationEmulationEnvironmentImages":{"properties":{"name":{"type":"string"},"id":{"type":"string"}},"required":["name","id"],"type":"object","additionalProperties":false},"ThreatEmulationAppliance":{"properties":{"apiKey":{"type":"string"},"ipAddress":{"type":"string"},"certificateName":{"type":"string"},"certificatePublicKey":{"type":"string"}},"required":["apiKey","ipAddress","certificateName","certificatePublicKey"],"type":"object","additionalProperties":false},"ApplianceEmulationEnvironment":{"properties":{"fallbackToCloud":{"type":"boolean"},"appliances":{"items":{"$ref":"#/components/schemas/ThreatEmulationAppliance"},"type":"array"}},"required":["fallbackToCloud","appliances"],"type":"object","additionalProperties":false},"EmulationEnvironmentType":{"enum":["CLOUD","APPLIANCE"],"type":"string"},"EmulationEnvironmentMode":{"enum":["RECOMMEND","SPECIFIC"],"type":"string"},"IFilesProtectionEmulationEmulationEnvironment":{"properties":{"images":{"items":{"$ref":"#/components/schemas/IFilesProtectionEmulationEmulationEnvironmentImages"},"type":"array"},"applianceSettings":{"$ref":"#/components/schemas/ApplianceEmulationEnvironment"},"type":{"$ref":"#/components/schemas/EmulationEnvironmentType"},"environmentMode":{"$ref":"#/components/schemas/EmulationEnvironmentMode"}},"required":["type","environmentMode"],"type":"object","additionalProperties":false},"IFilesProtectionEmulation":{"properties":{"sensors":{"$ref":"#/components/schemas/ThreatPreventionSensors"},"upload":{"$ref":"#/components/schemas/IFilesProtectionEmulationUpload"},"download":{"$ref":"#/components/schemas/IFilesProtectionEmulationDownload"},"unsupportedFileTypeActions":{"items":{"$ref":"#/components/schemas/IFilesProtectionEmulationUnsupportedFileTypeActions"},"type":"array"},"fileSystemFileTypesOverrides":{"items":{"$ref":"#/components/schemas/IFilesProtectionEmulationFileSystemFileTypesOverrides"},"type":"array"},"emulationEnvironment":{"$ref":"#/components/schemas/IFilesProtectionEmulationEmulationEnvironment"},"mode":{"$ref":"#/components/schemas/CapabilityMode"}},"type":"object","additionalProperties":false},"IFilesProtectionBrowserExtension":{"properties":{"pinToToolbar":{"type":"boolean"}},"type":"object","additionalProperties":false},"IFilesProtectionBrowser":{"properties":{"extension":{"$ref":"#/components/schemas/IFilesProtectionBrowserExtension"}},"type":"object","additionalProperties":false},"IFilesProtection":{"properties":{"emulation":{"$ref":"#/components/schemas/IFilesProtectionEmulation"},"browser":{"$ref":"#/components/schemas/IFilesProtectionBrowser"}},"type":"object","additionalProperties":false},"PolicySettingsIFilesProtectionBladeThreatEmulation":{"properties":{"metadata":{"$ref":"#/components/schemas/PolicySettingsIFilesProtectionBladeThreatEmulationMetadata"},"settings":{"$ref":"#/components/schemas/IFilesProtection"}},"required":["settings"],"type":"object","additionalProperties":false},"StandardToggleState":{"description":"A standard \\'toggle\\' with 3 states- ON, OFF and DEFAULT (i.e. unset)","enum":["ON","OFF","DEFAULT"],"type":"string"},"IPhishingProtection":{"properties":{"protectionMode":{"$ref":"#/components/schemas/CapabilityMode"},"allowDismissAlert":{"type":"boolean","description":"Allow user to dismiss the phishing alert and access the websiteNote: this value is effective only when Zero-Phishing mode is set to Prevent
"},"sendLogForEachScannedSite":{"type":"boolean"},"allowUserToCancelScan":{"type":"boolean"},"scanLocalHtmlFiles":{"$ref":"#/components/schemas/StandardToggleState"},"enableNotifications":{"type":"boolean"},"protectedDomains":{"items":{"$ref":"#/components/schemas/ProtectedNetworkResourceDomain"},"type":"array"},"protectedIPs":{"items":{"$ref":"#/components/schemas/ProtectedNetworkResourceIpRange"},"type":"array"}},"type":"object","additionalProperties":false},"PolicySettingsIPhishingProtectionBladeThreatEmulation":{"properties":{"metadata":{"$ref":"#/components/schemas/PolicySettingsIFilesProtectionBladeThreatEmulationMetadata"},"settings":{"$ref":"#/components/schemas/IPhishingProtection"}},"required":["settings"],"type":"object","additionalProperties":false},"IPasswordReuseProtection":{"properties":{"protectionMode":{"$ref":"#/components/schemas/CapabilityMode"},"allowDismissAlert":{"type":"boolean"},"enablePasswordManagement":{"type":"boolean"},"protectedDomains":{"items":{"$ref":"#/components/schemas/ProtectedNetworkResourceDomain"},"type":"array"},"protectedIPs":{"items":{"$ref":"#/components/schemas/ProtectedNetworkResourceIpRange"},"type":"array"}},"type":"object","additionalProperties":false},"PolicySettingsIPasswordReuseProtectionBladeThreatEmulation":{"properties":{"metadata":{"$ref":"#/components/schemas/PolicySettingsIFilesProtectionBladeThreatEmulationMetadata"},"settings":{"$ref":"#/components/schemas/IPasswordReuseProtection"}},"required":["settings"],"type":"object","additionalProperties":false},"ISearchProtection":{"properties":{"enableReputationServices":{"type":"boolean"},"forceSafeSearch":{"type":"boolean"}},"type":"object","additionalProperties":false},"PolicySettingsISearchProtectionBladeAntiBot":{"properties":{"metadata":{"$ref":"#/components/schemas/PolicySettingsIUrlFilteringProtectionBladeAntiBotMetadata"},"settings":{"$ref":"#/components/schemas/ISearchProtection"}},"required":["settings"],"type":"object","additionalProperties":false},"IThreatPreventionProtectionsNetwork":{"properties":{"urlFiltering":{"$ref":"#/components/schemas/PolicySettingsIUrlFilteringProtectionBladeAntiBot"},"files":{"$ref":"#/components/schemas/PolicySettingsIFilesProtectionBladeThreatEmulation"},"phishing":{"$ref":"#/components/schemas/PolicySettingsIPhishingProtectionBladeThreatEmulation"},"passwordReuse":{"$ref":"#/components/schemas/PolicySettingsIPasswordReuseProtectionBladeThreatEmulation"},"search":{"$ref":"#/components/schemas/PolicySettingsISearchProtectionBladeAntiBot"}},"type":"object","additionalProperties":false},"BladeAntiMalware":{"enum":["ANTI_MALWARE"],"type":"string"},"PolicySettingsIMalwareProtectionBladeAntiMalwareMetadata":{"properties":{"blade":{"$ref":"#/components/schemas/BladeAntiMalware"}},"required":["blade"],"type":"object","additionalProperties":false},"IMalwareProtectionScanScanTargets":{"properties":{"fileSizeLimitMb":{"type":"number","format":"double"},"limitScanBySize":{"type":"boolean"},"skipNonExecutables":{"type":"boolean"},"scanMailMessagesOnAccess":{"type":"boolean"},"mailMessages":{"type":"boolean"},"other":{"type":"boolean"},"networkDrives":{"type":"boolean"},"criticalSector":{"type":"boolean"},"removableDrives":{"type":"boolean"},"localDrives":{"type":"boolean"},"opticalDrives":{"type":"boolean"}},"type":"object","additionalProperties":false},"IMalwareProtectionScanRandomizedScan":{"properties":{"scanHourTo":{"type":"number","format":"double"},"scanHourFrom":{"type":"number","format":"double"},"enabled":{"type":"boolean"}},"type":"object","additionalProperties":false},"WeekDay":{"enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"],"type":"string"},"IntervalPeriod":{"enum":["MINUTE","HOUR","DAY","WEEK","MONTH"],"type":"string"},"IMalwareProtectionScanScheduledScan":{"properties":{"scanStartHour":{"type":"number","format":"double"},"scanDayOfMonth":{"type":"number","format":"double"},"scanDayOfWeek":{"$ref":"#/components/schemas/WeekDay"},"interval":{"$ref":"#/components/schemas/IntervalPeriod"},"enabled":{"type":"boolean"}},"type":"object","additionalProperties":false},"IMalwareProtectionScanOnAccessScanReputationServices":{"properties":{"connectionTimeoutMs":{"type":"number","format":"double"},"enabled":{"type":"boolean"}},"type":"object","additionalProperties":false},"IMalwareProtectionScanOnAccessScan":{"properties":{"reputationServices":{"$ref":"#/components/schemas/IMalwareProtectionScanOnAccessScanReputationServices"},"enableWebProtection":{"type":"boolean"},"detectUnusualActivity":{"type":"boolean"}},"type":"object","additionalProperties":false},"IMalwareProtectionScanScanOnIdle":{"properties":{"idleTimeMins":{"type":"number","format":"double"},"enabled":{"type":"boolean"}},"type":"object","additionalProperties":false},"IMalwareProtectionScan":{"properties":{"scanTargets":{"$ref":"#/components/schemas/IMalwareProtectionScanScanTargets"},"randomizedScan":{"$ref":"#/components/schemas/IMalwareProtectionScanRandomizedScan"},"scheduledScan":{"$ref":"#/components/schemas/IMalwareProtectionScanScheduledScan"},"onAccessScan":{"$ref":"#/components/schemas/IMalwareProtectionScanOnAccessScan"},"scanOnIdle":{"$ref":"#/components/schemas/IMalwareProtectionScanScanOnIdle"},"prohibitCancelScan":{"type":"boolean"},"setMaxScanCancelDays":{"type":"boolean"},"maxScanCancelDays":{"type":"number","format":"double"},"enableScanOptimization":{"type":"boolean"},"forceInitialScan":{"type":"boolean"}},"type":"object","additionalProperties":false},"CleaningMode":{"enum":["SKIP","CLEAN","DELETE","CLEAN_AND_DELETE"],"type":"string"},"IMalwareProtectionTreatmentTreatmentRiskware":{"properties":{"createBackup":{"type":"boolean"},"cleaningMode":{"$ref":"#/components/schemas/CleaningMode"}},"type":"object","additionalProperties":false},"AmTreatment":{"enum":["QUARANTINE","DELETE"],"type":"string"},"IMalwareProtectionTreatment":{"properties":{"sendInfectionDataSample":{"type":"boolean"},"sendInfectionData":{"type":"boolean"},"treatmentRiskware":{"$ref":"#/components/schemas/IMalwareProtectionTreatmentTreatmentRiskware"},"treatmentMethod":{"$ref":"#/components/schemas/AmTreatment"}},"type":"object","additionalProperties":false},"NonePrimarySignatureServerType":{"enum":["EXTERNAL_CHECKPOINT_SIGNATURES_SERVER","LOCAL_ENDPOINT_SERVERS","OTHER_EXTERNAL_SOURCE"],"type":"string"},"SignatureServerType":{"enum":["EXTERNAL_CHECKPOINT_SIGNATURES_SERVER","LOCAL_ENDPOINT_SERVERS","OTHER_EXTERNAL_SOURCE","SHARED_SIGNATURES_SERVER"],"type":"string"},"IMalwareProtectionSignaturesSignatureServers":{"properties":{"sharedSignaturesServer":{"type":"string","description":"Shared signature server path, not required if primary server not choose SharedSignaturesServer as the server type"},"externalSignaturesServer":{"type":"string","description":"External signature server path, not required if no server (primary, secondary, tertiary) choose OtherExternalSource as the server type"},"internalSignatureServerPath":{"type":"string"},"setAsSharedSignaturesServer":{"type":"boolean"},"tertiaryServerType":{"$ref":"#/components/schemas/NonePrimarySignatureServerType"},"enableTertiaryServer":{"type":"boolean","description":"A tertiary signature serverNote this setting takes effect only if enableSecondaryServer is also true
This field is a concatenation of the CVE\\'s ID and version
"},"cvssScore":{"type":"number","format":"double","description":"The vulnerability severity as per the Common Vulnerability Scoring SystemThis value is CVSS v3, if the vulnerability has been designated one, CVSS v2 otherwise
"},"lastScanned":{"type":"string","format":"date-time","description":"The date/time at which the vulnerability was last detected"},"firstScanned":{"type":"string","format":"date-time","description":"The date/time at which the vulnerability was first detected"},"affectedDevicesCount":{"type":"integer","format":"int32","description":"The number of devices affected by the vulnerability"},"comment":{"type":"string","description":"A comment regarding the vulnerability"},"description":{"type":"string","description":"A textual description of the vulnerability"}},"required":["cveId","versionId","cveIdVersionId","cvssScore","lastScanned","firstScanned","affectedDevicesCount","comment","description"],"type":"object","additionalProperties":false},"VulnerabilityPatchStatusEnum":{"description":"A vulnerability patch\\'s overall status","enum":["IN_PROGRESS","UPDATE_AVAILABLE","UPDATE_NOT_AVAILABLE","UPDATED","FAILED","END_USER_APPROVAL"],"type":"string"},"DeviceVulnerabilityPatchInfo":{"description":"Describes a patch operation\\'s information and status for a given vulnerability","properties":{"fileNames":{"items":{"type":"string"},"type":"array","description":"The names of the files comprising the patch"},"status":{"$ref":"#/components/schemas/VulnerabilityPatchStatusEnum"},"fileSizeMegabyteSum":{"type":"number","format":"double","description":"The total size, in megabytes of patch files to be installed"}},"required":["fileNames","status","fileSizeMegabyteSum"],"type":"object","additionalProperties":false},"VulnerabilityAffectedDevice":{"properties":{"application":{"$ref":"#/components/schemas/VulnerableApplicationInfoSlim"},"device":{"$ref":"#/components/schemas/VulnerabilityAffectedDeviceInfo"},"vulnerability":{"$ref":"#/components/schemas/DeviceVulnerabilityInfo"},"patch":{"$ref":"#/components/schemas/DeviceVulnerabilityPatchInfo"}},"required":["application","device","vulnerability","patch"],"type":"object","additionalProperties":false},"VulnerableDeviceSearchResults":{"description":"The result of a search request for vulnerable devices","properties":{"count":{"type":"integer","format":"int32","description":"The actual number of records returned for by the query."},"pageOffset":{"type":"integer","format":"int32","description":"An offset from the start of the results from which to fetch entities"},"pageSize":{"type":"integer","format":"int32","description":"The requested page size"},"data":{"items":{"$ref":"#/components/schemas/VulnerabilityAffectedDevice"},"type":"array","description":"The data returned by the query"}},"required":["count","pageOffset","pageSize","data"],"type":"object","additionalProperties":false},"JobOrResult_VulnerableDeviceSearchResults_":{"description":"Either an object containing a Job ID *OR* schema 'VulnerableDeviceSearchResults'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type VulnerableDeviceSearchResults
","oneOf":[{"$ref":"#/components/schemas/VulnerableDeviceSearchResults"},{"$ref":"#/components/schemas/JobCreationResult"}]},"PageSizePosture":{"type":"number","format":"double","minimum":1,"maximum":1000},"OffsetPosture":{"type":"number","format":"double","minimum":0},"PosturePaging":{"description":"Control\\'s the query\\'s pagination Posture queries can result in a large amount of data and take a non-negligible amount of time to complete. As such, queries are \\'paged\\', that is, split at the source- instead of a single monolithic query/response, the consumer calls the API multiple times to get a different part of the result each time","properties":{"pageSize":{"type":"integer","format":"int32","description":"The number of entities to return in the result","minimum":1,"maximum":1000},"offset":{"type":"integer","format":"int32","description":"An offset from the start of the results from which to fetch entities.
For example, \\'Fetch 10 devices from offset 15\\' will return devices 10 through 25","minimum":0}},"required":["pageSize","offset"],"type":"object","additionalProperties":false},"VulnerableDevicesByIdPagedRequest":{"description":"A request for retrieval of vulnerability information for given devices","properties":{"deviceIds":{"items":{"type":"string"},"type":"array","description":"A list of device ID\\'s who\\'s vulnerability data should be retrieved","minItems":1},"paging":{"$ref":"#/components/schemas/PosturePaging"}},"required":["deviceIds","paging"],"type":"object","additionalProperties":false},"PushOperationId":{"type":"string","description":"The UUID4 of a Remediation Operation"},"JobOrResult_PushOperationId_":{"description":"Either an object containing a Job ID *OR* schema 'PushOperationId'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type PushOperationId
","oneOf":[{"$ref":"#/components/schemas/PushOperationId"},{"$ref":"#/components/schemas/JobCreationResult"}]},"PushOperationCreationResult":{"$ref":"#/components/schemas/JobOrResult_PushOperationId_"},"JobOrResult_PushOperationCreationResult_":{"description":"Either an object containing a Job ID *OR* schema 'PushOperationCreationResult'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type PushOperationCreationResult
","oneOf":[{"$ref":"#/components/schemas/PushOperationCreationResult"},{"$ref":"#/components/schemas/JobCreationResult"}]},"VulnerabilityScanRequestPaging":{"description":"Controls pagination for the vulnerability scan operation.Only devices included in the given page will be affected
","properties":{"offset":{"type":"integer","format":"int32","description":"An offset from the start of the results from which to fetch entities.
For example, \\'Fetch 10 devices from offset 15\\' will return devices 10 through 25","minimum":0},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of entities to be included in the scan","minimum":1,"maximum":5000}},"required":["offset","pageSize"],"type":"object","additionalProperties":false},"VulnerabilityScanRequest":{"description":"A request to initiate a vulnerability scan on devices matching the given filters","properties":{"filters":{"items":{"$ref":"#/components/schemas/IFilter"},"type":"array"},"paging":{"$ref":"#/components/schemas/VulnerabilityScanRequestPaging"}},"type":"object","additionalProperties":false},"DeviceVulnerabilityScanStatus":{"description":"Describes a device\\'s posture","properties":{"deviceId":{"type":"string","description":"The device\\'s ID"},"scanStatus":{"$ref":"#/components/schemas/DeviceVulnerabilityScanStatusEnum"}},"required":["deviceId","scanStatus"],"type":"object","additionalProperties":false},"VulnerabilityScanStatusRequest":{"description":"A request to retrieve information about a device\\'s vulnerability scan","properties":{"filters":{"items":{"$ref":"#/components/schemas/IFilter"},"type":"array"},"paging":{"$ref":"#/components/schemas/PosturePaging"}},"type":"object","additionalProperties":false},"VulnerabilityPatchRequestFilter":{"properties":{"deviceIds":{"items":{"type":"string"},"type":"array","description":"An optional list ov device IDs to filter for","maxItems":5000},"cveIdVersionIds":{"items":{"type":"string"},"type":"array","description":"An optional list of vulnerabilities to filter for","maxItems":5000}},"type":"object","additionalProperties":false},"VulnerabilityPatchStatusDevice":{"description":"The device being referred to","properties":{"id":{"type":"string","description":"A unique ID"}},"required":["id"],"type":"object","additionalProperties":false},"VulnerabilityPatchStatusVulnerability":{"description":"The vulnerability being referred to","properties":{"cveIdVersionId":{"type":"string","description":"A unique ID for the CVE.This field is a concatenation of the CVE\\'s ID and version
"}},"required":["cveIdVersionId"],"type":"object","additionalProperties":false},"DetailedVulnerabilityPatchStatusEnum":{"description":"A patch operation\\'s detailed status","enum":["EXECUTING","CANCELED","UPDATE_AVAILABLE","UPDATE_NOT_AVAILABLE","CHECKING","DOWNLOADING","DOWNLOAD_FAILED","READY","PENDING_USER_CONFIRMATION","PENDING_EXECUTION","PENDING_SCAN","PENDING_REBOOT","UPDATED","FAILED","NOT_INSTALLED","REPLACED","INTERRUPTED","TIMEOUT","DOWNLOADED","PENDING"],"type":"string"},"VulnerabilityPatchStatusPatch":{"description":"The patch being referred to","properties":{"detailedStatuses":{"items":{"$ref":"#/components/schemas/DetailedVulnerabilityPatchStatusEnum"},"type":"array","description":"The patch operation\\'s details statuses"},"status":{"$ref":"#/components/schemas/VulnerabilityPatchStatusEnum"}},"required":["detailedStatuses","status"],"type":"object","additionalProperties":false},"VulnerabilityPatchStatus":{"description":"Describes patch process\\'s status for a given vulnerability on a given device","properties":{"device":{"$ref":"#/components/schemas/VulnerabilityPatchStatusDevice"},"vulnerability":{"$ref":"#/components/schemas/VulnerabilityPatchStatusVulnerability"},"patch":{"$ref":"#/components/schemas/VulnerabilityPatchStatusPatch"}},"required":["device","vulnerability","patch"],"type":"object","additionalProperties":false},"JobOrResult_VulnerabilityPatchStatus-Array_":{"description":"Either an object containing a Job ID *OR* schema 'VulnerabilityPatchStatus-Array'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type VulnerabilityPatchStatus-Array
","oneOf":[{"items":{"$ref":"#/components/schemas/VulnerabilityPatchStatus"},"type":"array"},{"$ref":"#/components/schemas/JobCreationResult"}]},"VulnerabilityPosturePatchStatusRequest":{"properties":{"filters":{"$ref":"#/components/schemas/VulnerabilityPatchRequestFilter"},"paging":{"$ref":"#/components/schemas/PosturePaging"}},"required":["filters","paging"],"type":"object","additionalProperties":false},"PushOperationTiming":{"description":"Defines a Push Operation\\'s general timing options","properties":{"expirationSeconds":{"type":"number","format":"double","description":"The time, in seconds, the operation will be valid for. When the specified time has elapsed, the operation will expire and will not be pushed to any more client If not specified, defaults to 86400 seconds (24 hours)","minimum":1},"schedulingDateTime":{"type":"string","format":"date-time","description":"Start the operation on a given date and time If not specified, defaults to \\'Now\\' (i.e. immediate execution)"}},"type":"object","additionalProperties":false},"ComputersQuery":{"properties":{"filter":{"items":{"$ref":"#/components/schemas/IFilter"},"type":"array","description":"A filter by which to select which computers are to be affected by the operation"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["filter"],"type":"object","additionalProperties":false},"TargetingExclusions":{"properties":{"groupsIds":{"items":{"type":"string"},"type":"array","description":"IDs of groups to exclude from the operation"},"computerIds":{"items":{"type":"string"},"type":"array","description":"IDs of computers to exclude from the operation"}},"type":"object","additionalProperties":false},"TargetComputer":{"properties":{"id":{"type":"string"}},"required":["id"],"type":"object","additionalProperties":false},"TargetingInclusions":{"properties":{"computers":{"items":{"$ref":"#/components/schemas/TargetComputer"},"type":"array","description":"Computers to include"}},"type":"object","additionalProperties":false},"PushOperationTargeting":{"description":"Defines a Push Operation\\'s targeting, i.e. what computers the operation would apply to","properties":{"query":{"$ref":"#/components/schemas/ComputersQuery"},"exclude":{"$ref":"#/components/schemas/TargetingExclusions"},"include":{"$ref":"#/components/schemas/TargetingInclusions"}},"type":"object","additionalProperties":false},"AgentRebootOrShutdownParameters":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"forceAppsShutdown":{"type":"boolean"}},"type":"object","additionalProperties":false},"PushOperationRequestAgentRebootOrShutdownParameters":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/AgentRebootOrShutdownParameters"}},"required":["targets"],"type":"object","additionalProperties":false},"BasePushOperationParameters":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"}},"type":"object","additionalProperties":false},"PushOperationRequestBasePushOperationParameters":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/BasePushOperationParameters"}},"required":["targets"],"type":"object","additionalProperties":false},"AgentCollectLogsDetailsLevel":{"enum":["Basic","General","Extended"],"type":"string"},"AgentCollectLogsOperationProtocol":{"enum":["ftp","sftp"],"type":"string"},"AgentCollectLogsParameters":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"detailLevel":{"$ref":"#/components/schemas/AgentCollectLogsDetailsLevel"},"protocol":{"$ref":"#/components/schemas/AgentCollectLogsOperationProtocol"},"uploadToCP":{"type":"boolean"},"uploadToS3":{"type":"boolean"},"uploadToCorporate":{"type":"boolean"},"serverFingerprint":{"type":"string"},"serverAddress":{"type":"string"},"pathOnServer":{"type":"string"},"specificCredentials":{"type":"boolean"},"login":{"type":"string"},"password":{"type":"string"}},"type":"object","additionalProperties":false},"PushOperationRequestAgentCollectLogsParameters":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/AgentCollectLogsParameters"}},"required":["targets"],"type":"object","additionalProperties":false},"RegistryHive":{"description":"Defines known Windows Registry HivesFor more information, see Predefined Keys (Microsoft)
","enum":["HKEY_CURRENT_USER","HKEY_LOCAL_MACHINE","HKEY_CLASSES_ROOT","HKEY_USERS","HKEY_CURRENT_CONFIG"],"type":"string"},"RegistryValueType":{"description":"A registry value\\'s type","enum":["DWORD","STRING"],"type":"string"},"AddRegistryKeyParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"hive":{"$ref":"#/components/schemas/RegistryHive"},"key":{"type":"string","description":"The full path path of the key to create or add a value to.Example: \\'SOFTWARE\\\\Node.js\\\\Components\\'
"},"valueName":{"type":"string","description":"The name of the value to be added to the specified registry key"},"valueType":{"$ref":"#/components/schemas/RegistryValueType"},"valueData":{"type":"string","description":"The actual value to be added the the specified registry key"},"isRedirected":{"type":"boolean","description":"Determines if the key should reside under WOW6432Node.Keys intended for 64bit versions of Windows may target 32bit versions by using setting \\'true\\' here
thus specifying that the registry key/value be added under under the WOW6432Node
"}},"required":["hive","key","valueName","valueType","valueData"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsAddRegistryKeyParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/AddRegistryKeyParams"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"RemoveRegistryKeyParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"hive":{"$ref":"#/components/schemas/RegistryHive"},"key":{"type":"string","description":"The full path path of the key to delete or remove a value from.Example: \\'SOFTWARE\\\\Node.js\\\\Components\\'
"},"valueName":{"type":"string","description":"The value to remove from the keyIf not provided, the entire key will be deleted
"},"isRedirected":{"type":"boolean","description":"Determines if the key should reside under WOW6432Node.Keys intended for 64bit versions of Windows may target 32bit versions by using setting \\'true\\' here
thus specifying that the registry key/value be added under under the WOW6432Node
"}},"required":["hive","key"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsRemoveRegistryKeyParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/RemoveRegistryKeyParams"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"BaseFileRelocationParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"sourceAbsolutePath":{"type":"string","description":"The absolute, full source path","minLength":1},"destinationAbsolutePath":{"type":"string","description":"The absolute, full destination pathNote: The provided path must include the target file\\'s name (e.g. c:\\\\backup\\\\backup1.txt)
","minLength":1}},"required":["sourceAbsolutePath","destinationAbsolutePath"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsBaseFileRelocationParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/BaseFileRelocationParams"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"DeleteFileParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"targetAbsolutePath":{"type":"string","description":"The absolute, full path of the file to remove"}},"required":["targetAbsolutePath"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsDeleteFileParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/DeleteFileParams"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"ProcessProperties":{"enum":["SI","Handles","VM","WS","PM","NPM","Path","CPU","ExitCode","ExitTime","Handle","HandleCount","HasExited","Id","MachineName","MainModule","MainWindowHandle","MainWindowTitle","MaxWorkingSet","MinWorkingSet","Modules","NonpagedSystemMemorySize","NonpagedSystemMemorySize64","PagedMemorySize","PagedMemorySize64","PagedSystemMemorySize","PagedSystemMemorySize64","PeakPagedMemorySize","PeakPagedMemorySize64","PeakVirtualMemorySize","PeakVirtualMemorySize64","PeakWorkingSet","PeakWorkingSet64","PriorityBoostEnabled","PriorityClass","PrivateMemorySize","PrivateMemorySize64","PrivilegedProcessorTime","ProcessName","ProcessorAffinity","Responding","SafeHandle","SessionId","StandardError","StandardInput","StandardOutput","StartInfo","StartTime","SynchronizingObject","Threads","TotalProcessorTime","UserProcessorTime","VirtualMemorySize","VirtualMemorySize64","WorkingSet","WorkingSet64"],"type":"string"},"CollectProcessInformationParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"processName":{"type":"string","description":"The name of the process to collect information onIf not provided, all running processes will be collected
"},"additionalFields":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProcessProperties"},"type":"array"},{"items":{"type":"string"},"type":"array"}],"description":"Additional process properties to collectIf not provided, only the process\\'s name and ID will be collected
"}},"type":"object","additionalProperties":false},"PushOperationRequestCollectProcessInformationParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/CollectProcessInformationParams"}},"required":["targets"],"type":"object","additionalProperties":false},"TerminateProcessParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"pid":{"type":"integer","format":"int32","description":"The Process ID (PID) of the process to terminateWhen used in conjunction with the name field, the PID must match the named process.
If both name and PID are provided but the process matching the PID does not match the provided name, the operation will be ignored by the agent
If set to 0 or not provided, the agent will seek to terminate the process or processes as indicated by the name field
","minimum":0},"name":{"type":"string","description":"The name of the process to terminate","minLength":1},"terminateAllInstances":{"type":"boolean","description":"Indicates whether to terminate all processes matching the given name.If set to true while a non-zero pid is given, only a single process with the given name AND PID may be matched
If set to false or not provided, will terminate only the first matching process
"}},"required":["name"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsTerminateProcessParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/TerminateProcessParams"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"VpnSiteAuthMethod":{"description":"Authentication methods used in conjunction with VPN Site Standard Login","enum":["CERTIFICATE","P12_CERTIFICATE","USERNAME_PASSWORD","SECURID_KEY_FOB","SECURID_PIN_PAD","SOFTID","CHALLENGE_RESPONSE"],"type":"string"},"VpnSiteAuth":{"properties":{"method":{"$ref":"#/components/schemas/VpnSiteAuthMethod"}},"required":["method"],"type":"object","additionalProperties":false},"VpnSiteCustomAuthMethod":{"description":"Authentication methods used in conjunction with VPN Site Custom Login","enum":["CERTIFICATE","P12_CERTIFICATE","OTHER"],"type":"string"},"VpnSiteCustomAuth":{"properties":{"loginOption":{"type":"string"},"method":{"$ref":"#/components/schemas/VpnSiteCustomAuthMethod"}},"required":["loginOption","method"],"type":"object","additionalProperties":false},"AddVpnSiteParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"host":{"type":"string","description":"The target site\\'s host name or IP address"},"displayName":{"type":"string","description":"The VPN Site\\'s Display Name"},"authentication":{"anyOf":[{"$ref":"#/components/schemas/VpnSiteAuth"},{"$ref":"#/components/schemas/VpnSiteCustomAuth"}],"description":"An authentication configuration used to connect to the VPN Site"},"fingerprint":{"type":"string","description":"The remote gateway\\'s certificate fingerprintFingerprints are used to verify the authenticity of the gateway
"},"remoteAccessGatewayName":{"type":"string","description":"The remote gateway\\'s name"}},"required":["host","authentication","fingerprint","remoteAccessGatewayName"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsAddVpnSiteParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/AddVpnSiteParams"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"RemoveVpnSiteParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"displayName":{"type":"string","description":"The Display Name of the VPN Site to removeIf a Display Name was not provided during the site\\'s creation, the host name/IP should be used instead
"}},"required":["displayName"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsRemoveVpnSiteParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/RemoveVpnSiteParams"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"AmScanParameters":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"scanCritical":{"type":"boolean"},"scanLocalDrives":{"type":"boolean"},"scanCdRom":{"type":"boolean"},"scanRemovable":{"type":"boolean"},"scanNetwork":{"type":"boolean"},"scanOther":{"type":"boolean"},"limitScanBySize":{"type":"boolean","description":"Indicates whether only files smaller than the size set in fileSizeLimit should be scanned"},"fileSizeLimit":{"type":"number","format":"double","description":"The maximum scanned file size, in megabytes. Larger files will be skippedRequires limitScanBySize to be true
","minimum":1},"skipNonExecutables":{"type":"boolean"}},"type":"object","additionalProperties":false},"PushOperationRequestAmScanParameters":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/AmScanParameters"}},"required":["targets"],"type":"object","additionalProperties":false},"AmUpdateParameters":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"updaterTimeoutSeconds":{"type":"number","format":"double"},"updateFromExternalServer":{"type":"boolean"},"updateFromCpServer":{"type":"boolean"},"updateFromEpServer":{"type":"boolean"},"amExternalSource":{"type":"string"}},"type":"object","additionalProperties":false},"PushOperationRequestAmUpdateParameters":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/AmUpdateParameters"}},"required":["targets"],"type":"object","additionalProperties":false},"AmRestoreParameters":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"files":{"items":{"type":"string"},"type":"array","description":"A list of file paths to restore"}},"required":["files"],"type":"object","additionalProperties":false},"PushOperationRequestAmRestoreParameters":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/AmRestoreParameters"}},"required":["targets"],"type":"object","additionalProperties":false},"ForensicsAnalyzeByIndicatorParameters":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"indicator":{"type":"string","description":"A URL, IP, Path, File or MD5 that, when accessed or executed will trigger a forensics report"},"generateActivityLogs":{"type":"boolean","description":"Generate detailed activity logs"}},"required":["indicator"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsForensicsAnalyzeByIndicatorParameters":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/ForensicsAnalyzeByIndicatorParameters"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"ForensicsQuarantineItemType":{"enum":["PATH","INCIDENT_ID","MD5"],"type":"string"},"ForensicsQuarantineItem":{"properties":{"type":{"$ref":"#/components/schemas/ForensicsQuarantineItemType"},"value":{"type":"string"}},"required":["type","value"],"type":"object","additionalProperties":false},"ForensicsQuarantineOperationParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"items":{"items":{"$ref":"#/components/schemas/ForensicsQuarantineItem"},"type":"array"}},"required":["items"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsForensicsQuarantineOperationParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/ForensicsQuarantineOperationParams"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"BasePushOperationRequest":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"}},"required":["targets"],"type":"object","additionalProperties":false},"PushOperationType":{"enum":["DA_REBOOT","DA_SHUTDOWN","DA_REPAIR_CLIENT","DA_COLLECT_LOGS","DA_DEPLOY_PACKAGE","COMP_TEMP_SET_COMPLIANT","COMP_TEMP_SET_RESTRICTED","AM_SCAN","AM_UPDATE","AM_REMOVE_FROM_QUARANTINE","EFR_EVENT_BY_INCIDENT","EFR_EVENT_BY_URL","EFR_EVENT_BY_PROC_OR_FILE","EFR_FILE_REMEDIATION","PUSH_CERTIFICATE","HOST_ISOLATION","HOST_DEISOLATION","DA_UNINSTALL_CLIENT","DA_KILL_PROCESS","DA_SERVICES_MANIP","DA_REMOTE_EXECUTION","DA_APPLICATION_SCAN","DA_SEARCH_AND_FETCH_FILES","DA_DIAGNOSTICS","FILE_ACTIONS","REGISTRY_ACTIONS","COLLECT_PROCESS","VPN_SITE","COMP_VM_SCAN","COMP_VM_PATCH","QUARANTINE_RESTORE_FILE","QUARANTINE_FETCH_FILE"],"type":"string"},"PushOperationSchedulingType":{"enum":["IMMEDIATE","SCHEDULED"],"type":"string"},"ForensicsRemediationItem":{"properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"],"type":"object","additionalProperties":false},"PossibleOperationParams":{"properties":{"informUser":{"type":"boolean"},"allowPostpone":{"type":"boolean"},"schedulingType":{"$ref":"#/components/schemas/PushOperationSchedulingType"},"schedulingDateTime":{"type":"string","format":"date-time"},"updateFromEpServer":{"type":"boolean"},"updateFromCpServer":{"type":"boolean"},"amExternalSource":{"type":"string"},"generateActivityLogs":{"type":"boolean"},"indicator":{"type":"string"},"filesToRestore":{"items":{"type":"string"},"type":"array"},"forensicsRemediationItems":{"items":{"$ref":"#/components/schemas/ForensicsRemediationItem"},"type":"array"},"forceAppsShutdown":{"type":"boolean"},"restoreFromQuarantine":{"type":"boolean"},"moveToQuarantine":{"type":"boolean"},"packageVersion":{"type":"string"},"originalTimeoutSeconds":{"type":"number","format":"double"}},"type":"object","additionalProperties":false},"PushOperationOverallStatus":{"enum":["ABORTED","NOT_STARTED","COMPLETED","COMPLETED_WITH_WARNINGS","IN_PROGRESS"],"type":"string"},"PushOperationStatus":{"description":"Describes a Push Operation\\'s status and progress","properties":{"id":{"type":"string","description":"The operation\\'s ID"},"createdOn":{"type":"string","format":"date-time","description":"The date and time the operation was created on"},"comment":{"type":"string","description":"A comment provided during the operation\\'s creation"},"type":{"$ref":"#/components/schemas/PushOperationType"},"numberOfAffectedEntities":{"type":"number","format":"double","description":"The total number of entities affected by the operation"},"remainingTimeoutSeconds":{"type":"number","format":"double","description":"The time, in seconds, the operation will remain active. When elapsed, no more entities will be affected","minimum":0},"aborted":{"type":"boolean","description":"Indicated whether the operation was aborted by an administrator"},"adminName":{"type":"string","description":"The name of the administrator that initiated the operation"},"operationParameters":{"$ref":"#/components/schemas/PossibleOperationParams"},"overallStatus":{"$ref":"#/components/schemas/PushOperationOverallStatus"}},"required":["id","createdOn","type","numberOfAffectedEntities","remainingTimeoutSeconds","aborted","adminName","overallStatus"],"type":"object","additionalProperties":false},"JobOrResult_PushOperationStatus-Array_":{"description":"Either an object containing a Job ID *OR* schema 'PushOperationStatus-Array'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type PushOperationStatus-Array
","oneOf":[{"items":{"$ref":"#/components/schemas/PushOperationStatus"},"type":"array"},{"$ref":"#/components/schemas/JobCreationResult"}]},"JobOrResult_PushOperationStatus_":{"description":"Either an object containing a Job ID *OR* schema 'PushOperationStatus'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type PushOperationStatus
","oneOf":[{"$ref":"#/components/schemas/PushOperationStatus"},{"$ref":"#/components/schemas/JobCreationResult"}]},"PushOperationClientMachineInfoSlim":{"description":"A Push Operation\\'s (a.k.a Remediation Operation) status in regards to a single client device (i.e. computer)","properties":{"id":{"type":"string","description":"The client device\\'s unique ID"},"name":{"type":"string","description":"The client device\\'s nameNote that device names are not necessarily unique
"},"ipAddress":{"type":"string","description":"The client device\\'s IPv4 Address"}},"required":["id","name","ipAddress"],"type":"object","additionalProperties":false},"PushOperationClientStatus":{"description":"Describes possible states in which a Push Operation may be in regards to a specific device","enum":["ABORTED","DA_NOT_INSTALLED","TIMED_OUT","WAITING_FOR_CLIENT","PUSHED_TO_CLIENT","VERSION_NOT_SUPPORTED","BLADE_NOT_INSTALLED","SCHEDULED","USER_POSTPONED","USER_CANCELLED","IN_PROGRESS","SUCCEEDED","FAILED"],"type":"string"},"PushOperationClientOperationStatusSlimResponse":{"properties":{"output":{"type":"string","description":"The operation\\'s output/result as reported by the client"},"status":{"type":"string","description":"The operation\\'s progress statusNote, this is a text field that contains an operation status as reported by the client; This is different than the root level field status in that it may pertain to operation specific information, for example, Anti-Malware may report a scan stage
"}},"type":"object","additionalProperties":false},"PushOperationClientOperationStatusSlim":{"properties":{"status":{"$ref":"#/components/schemas/PushOperationClientStatus"},"response":{"allOf":[{"$ref":"#/components/schemas/PushOperationClientOperationStatusSlimResponse"}],"nullable":true}},"required":["status","response"],"type":"object","additionalProperties":false},"PushOperationClientResultSlim":{"description":"A Remediation Operation\\'s results in regards to a particular client deviceThis is a \\'Slim\\' structure, containing only the most useful fields; This allows for larger pages to be processed at once
","properties":{"machine":{"$ref":"#/components/schemas/PushOperationClientMachineInfoSlim"},"operation":{"$ref":"#/components/schemas/PushOperationClientOperationStatusSlim"}},"required":["machine","operation"],"type":"object","additionalProperties":false},"PagedResponseMetadata":{"description":"A standard paged request\\'s response metadata","properties":{"from":{"type":"integer","format":"int32","description":"The 0-based index of the first item in the page (inclusive)","minimum":0},"to":{"type":"integer","format":"int32","description":"The 0-based index of the last item in the page (exclusive)","minimum":0},"count":{"type":"integer","format":"int32","description":"The number of items returned","minimum":0}},"required":["from","to","count"],"type":"object","additionalProperties":false},"PushOperationClientResultSlimResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PushOperationClientResultSlim"},"type":"array","description":"The operation\\'s per-client-device responses"},"metadata":{"$ref":"#/components/schemas/PagedResponseMetadata"}},"required":["data","metadata"],"type":"object","additionalProperties":false},"JobOrResult_PushOperationClientResultSlimResponse_":{"description":"Either an object containing a Job ID *OR* schema 'PushOperationClientResultSlimResponse'\nThe actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type PushOperationClientResultSlimResponse
","oneOf":[{"$ref":"#/components/schemas/PushOperationClientResultSlimResponse"},{"$ref":"#/components/schemas/JobCreationResult"}]},"PushOperationResultsRequestFilters":{"properties":{"freeText":{"type":"string","description":"Optional free text search in any of the potential response fields excluding \\\"id\\\"Can be used to search for specific results, devices or IPs, for example
"}},"type":"object","additionalProperties":false},"PushOperationSlimResultsRequestPaging":{"properties":{"pageSize":{"type":"integer","format":"int32","description":"The number of entities to return in the result","minimum":1,"maximum":150},"offset":{"type":"integer","format":"int32","description":"An offset from the start of the results from which to fetch entities. For example, \\'Fetch 10 computers from offset 15\\' will return computers 10 through 25","minimum":0}},"required":["pageSize","offset"],"type":"object","additionalProperties":false},"PushOperationResultsRequestSlim":{"description":"A request to obtain the per-client-device results of a given Push Operation (a.k.a Remediation Operation)","properties":{"filters":{"$ref":"#/components/schemas/PushOperationResultsRequestFilters"},"paging":{"$ref":"#/components/schemas/PushOperationSlimResultsRequestPaging"}},"type":"object","additionalProperties":false},"RemediationType":{"enum":["GENERIC","SCHEDULED_TASK","REGISTRY","FILE","ARCHIVE","STREAM"],"type":"string"},"EndpointClientSensorType":{"enum":["THREAT_EMULATION","FORENSICS","ANTI_BOT","COMPLIANCE","ACCESS_ZONES","COMMON_CLIENT","DOCUMENT_SECURITY","ANTI_MALWARE","WEBCHECK","FULL_DISK_ENCRYPTION","MEDIA_ENCRYPTION_AND_PORT_PROTECTION","FIREWALL","ONECHECK","URL_FILTERING","OTHER"],"type":"string"},"QuarantinedFileMetadata":{"properties":{"remediationType":{"$ref":"#/components/schemas/RemediationType"},"sensor":{"$ref":"#/components/schemas/EndpointClientSensorType"},"incidentId":{"type":"string","description":"A unique ID"}},"required":["remediationType","sensor","incidentId"],"type":"object","additionalProperties":false},"StandardTimestamp":{"description":"A timestamp","properties":{"utcEpoch":{"type":"number","format":"double","description":"The UTC epoch, in milliseconds","minimum":0,"maximum":9007199254740991},"iso8601":{"type":"string","format":"date-time","description":"An ISO-8601 date-time string"}},"required":["utcEpoch","iso8601"],"type":"object","additionalProperties":false},"QuarantinedFileFile":{"properties":{"deletedOn":{"allOf":[{"$ref":"#/components/schemas/StandardTimestamp"}],"nullable":true},"restoredOn":{"allOf":[{"$ref":"#/components/schemas/StandardTimestamp"}],"nullable":true},"lastModifiedOn":{"$ref":"#/components/schemas/StandardTimestamp"},"quarantinedOn":{"$ref":"#/components/schemas/StandardTimestamp"},"md5":{"type":"string"},"archiveSizeBytes":{"type":"number","format":"double"},"sizeBytes":{"type":"number","format":"double"},"archivePath":{"type":"string"},"originalPath":{"type":"string"},"id":{"type":"string"}},"required":["lastModifiedOn","quarantinedOn","md5","archiveSizeBytes","sizeBytes","archivePath","originalPath","id"],"type":"object","additionalProperties":false},"QuarantinedFileDevice":{"properties":{"domainName":{"type":"string"},"commonName":{"type":"string"},"id":{"type":"string","description":"A unique ID"}},"required":["domainName","commonName","id"],"type":"object","additionalProperties":false},"QuarantinedFile":{"properties":{"metadata":{"$ref":"#/components/schemas/QuarantinedFileMetadata"},"file":{"$ref":"#/components/schemas/QuarantinedFileFile"},"device":{"$ref":"#/components/schemas/QuarantinedFileDevice"}},"required":["metadata","file","device"],"type":"object","additionalProperties":false},"JobOrResult_QuarantinedFile-Array_":{"description":"Either an object containing a Job ID *OR* schema 'QuarantinedFile-Array'\n
The actual return value varies depending on whether the request specified header x-mgmt-run-as-job 'ON' or 'OFF'.
\nWhen set to 'ON', operations will run asynchronously and return the JobCreationResult schema
\nWhen set to 'OFF', operations will run synchronously and return a concrete response of type QuarantinedFile-Array
","oneOf":[{"items":{"$ref":"#/components/schemas/QuarantinedFile"},"type":"array"},{"$ref":"#/components/schemas/JobCreationResult"}]},"PageSizeQuarantine":{"type":"integer","format":"int32","minimum":1,"maximum":1000},"OffsetQuarantine":{"type":"integer","format":"int32","minimum":0},"QuarantineManagementFileByDeviceNameRequestDevice":{"properties":{"commonName":{"type":"string"},"domainName":{"type":"string"},"id":{"type":"string","description":"A unique ID"}},"type":"object","additionalProperties":false},"QuarantinePaging":{"properties":{"pageSize":{"type":"integer","format":"int32","description":"The number of entities to return in the result","minimum":1,"maximum":1000},"offset":{"type":"integer","format":"int32","description":"An offset from the start of the results from which to fetch entities.
For example, \\'Fetch 10 computers from offset 15\\' will return computers 10 through 25","minimum":0}},"required":["pageSize","offset"],"type":"object","additionalProperties":false},"QuarantineManagementFileByDeviceNameRequest":{"properties":{"device":{"$ref":"#/components/schemas/QuarantineManagementFileByDeviceNameRequestDevice"},"paging":{"$ref":"#/components/schemas/QuarantinePaging"}},"required":["paging"],"type":"object","additionalProperties":false},"RestoreQuarantinedFileParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"fileIds":{"items":{"type":"string"},"type":"array"},"restoreLocation":{"type":"string"}},"required":["fileIds","restoreLocation"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsRestoreQuarantinedFileParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/RestoreQuarantinedFileParams"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"FileTransferProtocol":{"enum":["FTP","SFTP"],"type":"string"},"FileTransferServerConnection":{"properties":{"protocol":{"$ref":"#/components/schemas/FileTransferProtocol"},"address":{"type":"string"},"fingerprint":{"type":"string"}},"required":["protocol","address"],"type":"object","additionalProperties":false},"LoginCredentials":{"description":"Credentials with which to login","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"],"type":"object","additionalProperties":false},"FileTransferServerUploadParams":{"properties":{"connection":{"$ref":"#/components/schemas/FileTransferServerConnection"},"loginCredentials":{"$ref":"#/components/schemas/LoginCredentials"},"uploadPath":{"type":"string","description":"The path on the server to upload to"}},"required":["connection"],"type":"object","additionalProperties":false},"FetchQuarantinedFileParams":{"properties":{"informUser":{"type":"boolean","description":"Determines whether to inform the user, via a UserCheck (popup) message, that the operation is taking place"},"allowPostpone":{"type":"boolean","description":"Determines whether to allow the user to postpone the operation"},"fileIds":{"items":{"type":"string"},"type":"array"},"archivePassword":{"type":"string","description":"The password which will be used to encrypt/decrypt the archive containing the quarantined fileTo protect against accidental infection, quarantined files are packaged into an encrypted archive before being returned
"},"upload":{"$ref":"#/components/schemas/FileTransferServerUploadParams"}},"required":["fileIds","upload"],"type":"object","additionalProperties":false},"PushOperationRequestWithMandatoryParamsFetchQuarantinedFileParams":{"properties":{"comment":{"type":"string"},"timing":{"$ref":"#/components/schemas/PushOperationTiming"},"targets":{"$ref":"#/components/schemas/PushOperationTargeting"},"operationParameters":{"$ref":"#/components/schemas/FetchQuarantinedFileParams"}},"required":["targets","operationParameters"],"type":"object","additionalProperties":false},"LoginResponse":{"description":"An object providing details about the session returned by a login request","properties":{"apiToken":{"type":"string","description":"The API token for the session\nThis token should be provided on all requests via the x-mgmt-api-token header
The token returned by the Infinity Portal's (CloudInfra) External Authentication service.
Sample response:
The following documentation provides the operations supported by the Harmony Endpoint's External API.
To use the Harmony Endpoint External API service:
In the Infinity Portal, create a suitable API Key. In the Service field, enter Endpoint.
For more information, refer to the Infinity Portal Administration Guide.
Once a key has been created, it may be used indefinitely (unless an expiration date was explicitly set for it).
Authenticate using the Infinity Portal's External Authentication Service.
The authentication request should be made to the Authentication URL obtained during the previous step.
Example (Your tenant's authentication URL may differ):
Note, image is for reference only. Exact CURL syntax may differ.
Include the resulting token in the Authorization header in the form of a Bearer (For example, 'Authorization': 'Bearer {TOKEN}') in every request made to the API service
Call the Cloud Login API
Include the resulting x-mgmt-api-token in Header x-mgmt-api-token of all subsequent requests
During usage, you may encounter different issues and errors.
To facilitate resolution of such issues, the Harmony Endpoint API service uses an RFC7807 compliant error structure which conveys information like the type of error that occurred and its source and even potential fixes.
This is the first and often last step in diagnosing API related issues.
The below list is of common errors that may not be obvious from the error message alone.
If you encounter an error that is not listed here and require help, please open a support ticket or request assistance via the e-mail address at the bottom of this documentation page.
This error usually indicates your authentication request was malformed.
Make sure your request is a valid JSON, includes header Content-Type with a value of application/json and looks like { \"clientId\": \"{{ciClientId}}\", \"accessKey\": \"{{ciAccessKey}}\" }
This error indicates that you have attempted to access a resource without a valid Bearer authoriztion token.
An example could be an attempt to invoke a Harmony Endpoint API operation without providing an Infinity Portal token in the request's Authorization header
Specific cases where this error is raised include:
\nThis API Endpoint provides a low-level view into the information provided by the Harmony Endpoint agent.\nAvailable information includes all information available within the Infinity Portal's Harmony Endpoint Asset Management Tab.\nPlease note that security events are not covered by this API with the exception of Anti-Malware detections\n
\n\nWhile working with the API you may get a unique field value - 999.\nThis value is a placeholder for 'null'.For example, when 'computerAmVersion' is '999', it means there are no infections for a given computer.\nIn the context of 'deploymentStatus' though, for example, the same '999' (e.g. 'null') means 'deploymentStatus' in unknown.\n
","summary":"Get computers matching the given filters","tags":["Asset Management"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComputersByFilterArgs"}}}}}},"/v1/ioc/get":{"post":{"operationId":"GetIocPaged","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_PageOfIoc_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Gets a list of Indicators of Compromise matching the given parameters","summary":"Get existing Indicators of Compromise","tags":["Indicators of Compromise"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IocPagedRequest"}}}}}},"/v1/ioc/edit":{"put":{"operationId":"EditIoc","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_IndicatorOfCompromise-Array_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Updates the given Indicators of Compromise with the given parameters","summary":"Update existing Indicators of Compromise","tags":["Indicators of Compromise"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UpdateIoc"},"type":"array"}}}}}},"/v1/ioc/create":{"post":{"operationId":"CreateIoc","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_IndicatorOfCompromise-Array_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Creates new Indicators of Compromise using the given parameters
\n\n\n Each IOC may have one of several types who's\n formats are provided in ECMAScript-flavored Regular Expression syntax.\n
\n\nDomain - A domain-only string. For example, xyz.com
A protocol (e.g https:// or specific URLs (e.g. xyz.com/file.php) are invalid in this context
\nFormat: /^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]/i
IP - An IPv4 address (e.g. 1.1.1.1)
Format: /(((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3})(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/
URL - A URL (e.g. https://www.checkpoint.com/harmony/advanced-endpoint-protection)
Format: /^(((http(s?|\\??):\\/\\/([\\p{L}\\p{N}()\\*\\?].)*)|([\\p{L}\\p{N}()\\*\\?].)*)[-\\p{L}\\p{N}@:%_\\?\\*\\+~#=]{0,256}\\.[\\p{L}\\p{N}()\\*\\?]+([-\\p{L}\\p{N}()@:%_\\?\\*\\+.~#?&//=]*))$/u
MD5 - An MD5 string
Format: /^(?:([A-F0-9]{8}-){3}[A-F0-9]{8})$|^([a-f0-9]{32})$/i
SHA1 - A SHA1 string
Format: /^(?:([A-F0-9]{8}-){4}[A-F0-9]{8})$|^([a-fA-F0-9]{40})$/i
For example, a search for a particular computer in the organization may take a considerable amount of time\nin large organizations so the '/computers/by-filter' API has been made to return a Job.\nThis means that, when invoked, the operation returns an object with a 'jobId' field. That Job can then be queried and, when completed, will contain\nthe result of the '/computers/by-filter' operation.
\nAs such, Jobs should be treated as 'single-use'. Once concluded, they should be 'discarded'
","summary":"Retrieve the status and result of an asynchronous operation","tags":["Jobs"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the operation to query the status of","in":"path","name":"jobId","required":true,"schema":{"type":"string"}}]}},"/v1/organization/tree/search":{"post":{"operationId":"SearchInOrganization","responses":{"201":{"description":"Operation completed successfully. Response body contains a list of entities matching the given search parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_SlimEntity-Array_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Searches the organization for entities matching the given query","summary":"Search the organization for entities matching a query","tags":["Organizational Structure"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchInOrganizationRequest"}}}}}},"/v1/organization/virtual-group/create":{"post":{"operationId":"Create","responses":{"201":{"description":"Operation completed successfully. The requested group was successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_Id_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"409":{"description":"A Virtual Group with the given name already exists"},"500":{"description":"An internal error has occurred"}},"description":"Creates a new Virtual Group","summary":"Create a new Virtual Group","tags":["Organizational Structure"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}],"requestBody":{"description":"Parameters used to create the Virtual Group","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVirtualGroupRequest"}}}}}},"/v1/organization/virtual-group/{virtualGroupId}/members/add":{"put":{"operationId":"AddMembersToVirtualGroup","responses":{"200":{"description":"Operation completed successfully. All given entities were successfully added to the Virtual Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_AcknowledgeResponse_"}}}},"400":{"description":"Request did not specify any members to add"},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Adds the specified entities to the given Virtual Group\nEntities that are already assigned to the Virtual Group are ignored
","summary":"Add entities to a Virtual Group","tags":["Organizational Structure"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the Virtual Group to add members to","in":"path","name":"virtualGroupId","required":true,"schema":{"type":"string"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}],"requestBody":{"description":"A list of entity IDs to add to the given Virtual Group\nVirtual Groups can accepts entities of types 'USER', 'COMPUTER' and 'VIRTUAL_GROUP' (for supported servers)
","required":true,"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Id"},"type":"array"}}}}}},"/v1/organization/virtual-group/{virtualGroupId}/members/remove":{"put":{"operationId":"RemoveMembersFromVirtualGroup","responses":{"200":{"description":"Operation completed successfully. All given entities were successfully removed from the Virtual Group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_AcknowledgeResponse_"}}}},"400":{"description":"Request did not specify any members to remove"},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Removes the specified entities from the given Virtual Group.\nEntities that are not assigned to the Virtual Group are ignored
","summary":"Remove entities from a Virtual Group","tags":["Organizational Structure"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the Virtual Group to remove members from","in":"path","name":"virtualGroupId","required":true,"schema":{"type":"string"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}],"requestBody":{"description":"A list of entity IDs to remove from the given Virtual Group","required":true,"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Id"},"type":"array"}}}}}},"/v1/policy/{ruleId}/assignments":{"get":{"operationId":"GetRuleAssignments","responses":{"200":{"description":"Operation completed successfully. Response body contains the requested rule's assignments list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_RuleAssignment-Array_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"404":{"description":"The given rule was not found"},"500":{"description":"An internal error has occurred"}},"description":"Gets all entities directly assigned to the given rule","summary":"Get entities assigned to a rule","tags":["Policy - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the rule to get the assignments of","in":"path","name":"ruleId","required":true,"schema":{"type":"string"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}]}},"/v1/policy/{ruleId}/assignments/add":{"put":{"operationId":"AddRuleAssignments","responses":{"200":{"description":"Operation completed successfully. All given entities were added to the given rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_AcknowledgeResponse_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"404":{"description":"The given rule was not found"},"500":{"description":"An internal error has occurred"}},"description":"Assigns the specified entities to the given rule.\nSpecified IDs that are already assigned to the rule are ignored
","summary":"Assign entities to a given rule","tags":["Policy - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the rule to add assignments to","in":"path","name":"ruleId","required":true,"schema":{"type":"string"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}],"requestBody":{"description":"A list of entity IDs to assign to the given rule\nAssignments may be users, computers, organizational units and Virtual Groups
","required":true,"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Id"},"type":"array"}}}}}},"/v1/policy/{ruleId}/assignments/remove":{"put":{"operationId":"RemoveRuleAssignments","responses":{"200":{"description":"Operation completed successfully. All given entities were removed from the given rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_AcknowledgeResponse_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"404":{"description":"The given rule was not found"},"500":{"description":"An internal error has occurred"}},"description":"Removes the specified entities from the given rule's assignments.\nSpecified IDs that are not assigned to the rule are ignored
","summary":"Remove entities from a rule","tags":["Policy - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the rule to remove assignments from","in":"path","name":"ruleId","required":true,"schema":{"type":"string"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}],"requestBody":{"description":"A list of entity IDs to un-assign from the rule","required":true,"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Id"},"type":"array"}}}}}},"/v1/policy/install":{"post":{"operationId":"InstallAllPolicies","responses":{"200":{"description":"Operation completed successfully. All policies have been installed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_AcknowledgeResponse_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"409":{"description":"The default client un-installation Password must be changed before policy installation"},"500":{"description":"An internal error has occurred"}},"description":"Installs all policies.\nChanges to rule settings are only enforced after policy installation
","summary":"Install all policies","tags":["Policy - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}]}},"/v1/policy/{ruleId}/install":{"post":{"operationId":"InstallPoliciesForRule","responses":{"200":{"description":"Operation completed successfully. All policies have been installed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_AcknowledgeResponse_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"409":{"description":"The default client un-installation Password must be changed before policy installation"},"500":{"description":"An internal error has occurred"}},"description":"Installs all policies of a given rule.\nChanges to rule settings are only enforced after policy installation
","summary":"Install all policies of a given rule","tags":["Policy - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the rule to install","in":"path","name":"ruleId","required":true,"schema":{"type":"string"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}]}},"/v1/policy/{ruleId}/modifications":{"get":{"operationId":"GetModificationsPendingInstallationByRuleId","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_ModifiedRule_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"\nGets information on modifications to a given rule since it was last installed","summary":"Get information on modifications to a given rule","tags":["Policy - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the rule to get the modifications of","in":"path","name":"ruleId","required":true,"schema":{"type":"string"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}]}},"/v1/policy/{ruleId}":{"post":{"operationId":"CloneRule","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_AcknowledgeResponse_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"\nClones the specified rule and puts the clone in the provided position inside the rulebase","summary":"Clones the specified rule and puts the clone in the provided position inside the rulebase","tags":["Policy - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the rule to get the modifications of","in":"path","name":"ruleId","required":true,"schema":{"$ref":"#/components/schemas/RuleId"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}],"requestBody":{"description":"properties of the new rule","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ICloneRuleInput"}}}}}},"/v1/policy/{ruleId}/metadata":{"get":{"operationId":"GetRuleMetadataById","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_RuleMetadata_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Gets the given rule's metadata.\nMetadata refers to all information relating to the rule except it's actual settings
","summary":"Get a rule's metadata","tags":["Policy - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the rule to get the metadata of","in":"path","name":"ruleId","required":true,"schema":{"type":"string"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}}]}},"/v1/policy/metadata":{"get":{"operationId":"GetAllRulesMetadata","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_RuleMetadata-Array_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Gets the metadata of all runes.\nMetadata refers to all information relating to the rule except it's actual settings
","summary":"Get the metadata of all rules","tags":["Policy - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob"}},{"description":"An optional 'Rule Family' filter. Used to filter the results to only the selected capability family (e.g. only 'Threat Prevention')","in":"query","name":"ruleFamily","required":false,"schema":{"$ref":"#/components/schemas/BladeFamily"}},{"description":"An optional 'Connection State' filter. Used to filter the results to only the selected Connection State (e.g. only rules pertaining to policies for 'Connected' clients)","in":"query","name":"connectionState","required":false,"schema":{"$ref":"#/components/schemas/ConnectionState"}}]}},"/policy/threat-prevention/{ruleId}":{"get":{"operationId":"GetThreatPreventionPolicy","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPolicyResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"409":{"description":"Threat Prevention is not in the 'Unified' mode"},"500":{"description":"An internal error has occurred"}},"description":"\nGets the Threat-Prevention policy of the given rule","summary":"Get a rule's Threat-Prevention policy","tags":["Policy - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the rule to get the Threat-Prevention policy of","in":"path","name":"ruleId","required":true,"schema":{"$ref":"#/components/schemas/RuleId"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}},{"description":"The returned policy's detail level","in":"query","name":"detailsLevel","required":false,"schema":{"$ref":"#/components/schemas/DetailsLevel"}}]},"patch":{"operationId":"SetThreatPreventionPolicy","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_AcknowledgeResponse_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"409":{"description":"Threat Prevention is not in the 'Unified' mode"},"500":{"description":"An internal error has occurred"}},"description":"Updates the given Threat-Prevention rule","summary":"Update a rule's Threat-Prevention policy","tags":["Policy - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the Threat-Prevention rule to update","in":"path","name":"ruleId","required":true,"schema":{"$ref":"#/components/schemas/RuleId"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}},{"description":"Indicates whether the updated Threat-Prevention rule should be installed after a successful update","in":"query","name":"installPolicy","required":false,"schema":{"type":"boolean"}},{"description":"Indicates whether the new configuration is allowed to 'break out' the currently defined rule template.\n\nThis parameter controls whether an exception is raised if changes passed via the settings parameter conflict\nwith the rule's currently selected template\n
Note that most properties on this parameter are optional. It is recommended to specify only fields being updated.
","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IThreatPreventionPolicy"}}}}}},"/policy/threat-prevention/{ruleId}/template":{"put":{"operationId":"SetThreatPreventionPolicyTemplate","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_AcknowledgeResponse_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"409":{"description":"Threat Prevention is not in the 'Unified' mode"},"500":{"description":"An internal error has occurred"}},"description":"Sets the Threat-Prevention policy template for the given rule.\n\nSetting a template instructs the policy to adhere to the Check Point's recommended configuration
","summary":"Sets a rule's Threat-Prevention policy template","tags":["Policy - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"description":"The ID of the rule to update the Threat-Prevention policy or template of","in":"path","name":"ruleId","required":true,"schema":{"$ref":"#/components/schemas/RuleId"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}},{"description":"The template to which the given Threat-Prevention rule should adhere","in":"query","name":"template","required":true,"schema":{"$ref":"#/components/schemas/PolicyTemplateName"}},{"description":"Indicates whether the updated Threat-Prevention rule should be installed after a successful update","in":"query","name":"installPolicy","required":false,"schema":{"type":"boolean"}}]}},"/v1/posture/vulnerability/data":{"get":{"operationId":"GetVulnerabilitiesData","responses":{"200":{"description":"The requested page of vulnerabilities data was found and returned in the response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_VulnerableDeviceSearchResults_"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Gets all vulnerability related information","summary":"Get information about vulnerabilities","tags":["Posture Management - Vulnerabilities"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}},{"in":"query","name":"pageSize","required":true,"schema":{"$ref":"#/components/schemas/PageSizePosture"}},{"in":"query","name":"offset","required":true,"schema":{"$ref":"#/components/schemas/OffsetPosture"}}]}},"/v1/posture/vulnerability/devices":{"post":{"operationId":"GetDeviceVulnerabilitiesDevice","responses":{"200":{"description":"The requested vulnerabilities data for the given devices was found and returned in the response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_VulnerableDeviceSearchResults_"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Gets vulnerabilities affecting the given devices","summary":"Get vulnerabilities of given devices","tags":["Posture Management - Vulnerabilities"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VulnerableDevicesByIdPagedRequest"}}}}}},"/v1/posture/vulnerability/scan":{"post":{"operationId":"VulnerabilityScan","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_PushOperationCreationResult_"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Initiates a vulnerability scan on devices matching the given query","summary":"Start a vulnerability scan on given devices","tags":["Posture Management - Vulnerabilities"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VulnerabilityScanRequest"}}}}}},"/v1/posture/vulnerability/scan/status":{"post":{"operationId":"VulnerabilityScanStatus","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DeviceVulnerabilityScanStatus"},"type":"array"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Gets the current statuses of the vulnerability scans running on devices matching the given query","summary":"Get a vulnerability scan's status","tags":["Posture Management - Vulnerabilities"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VulnerabilityScanStatusRequest"}}}}}},"/v1/posture/vulnerability/patch":{"post":{"operationId":"VulnerabilityPatch","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_PushOperationCreationResult_"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Initiates an application/s patch operation on devices matching the given query","summary":"Patch vulnerable applications","tags":["Posture Management - Vulnerabilities"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VulnerabilityPatchRequestFilter"}}}}}},"/v1/posture/vulnerability/patch/status":{"post":{"operationId":"VulnerabilityPatchStatus","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_VulnerabilityPatchStatus-Array_"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Gets the application patch operation statuses for devices and/or CVEs matching the given query","summary":"Get patch operation statuses","tags":["Posture Management - Vulnerabilities"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VulnerabilityPosturePatchStatusRequest"}}}}}},"/v1/remediation/agent/reset-computer":{"post":{"operationId":"ResetComputer","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Restarts computers matching the given query","summary":"Restart computers matching a given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestAgentRebootOrShutdownParameters"}}}}}},"/v1/remediation/agent/shutdown-computer":{"post":{"operationId":"ShutdownComputer","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Shuts-down computers matching the given query","summary":"Shut-down computers matching a given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestAgentRebootOrShutdownParameters"}}}}}},"/v1/remediation/agent/repair-computer":{"post":{"operationId":"RepairComputer","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Repairs the Harmony Endpoint Client installation on computers matching the given query","summary":"Repair client installations on computers matching a given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestBasePushOperationParameters"}}}}}},"/v1/remediation/agent/collect-logs":{"post":{"operationId":"CollectLogs","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Collects all Harmony Endpoint Client logs as well as diagnostic information from computers matching the given query","summary":"Collect diagnostic information from computers matching a given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestAgentCollectLogsParameters"}}}}}},"/v1/remediation/agent/registry/key/add":{"post":{"operationId":"AgentAddRegistryKey","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Adds a given registry key and/or value to the registry of computers matching the given query","summary":"Add a registry key and/or value to computers matching the given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsAddRegistryKeyParams"}}}}}},"/v1/remediation/agent/registry/key/delete":{"post":{"operationId":"AgentRemoveRegistryKey","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Removes the given registry key or value to the registry of computers matching the given query","summary":"Remove a registry key or value to computers matching the given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsRemoveRegistryKeyParams"}}}}}},"/v1/remediation/agent/file/copy":{"post":{"operationId":"AgentCopyFile","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Copies the given file from the given source to the given destination on computers matching the given query","summary":"Copy a given file on computers matching the given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsBaseFileRelocationParams"}}}}}},"/v1/remediation/agent/file/move":{"post":{"operationId":"AgentMoveFile","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Moves the given file from the given source to the given destination on computers matching the given query","summary":"Move a given file on computers matching the given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsBaseFileRelocationParams"}}}}}},"/v1/remediation/agent/file/delete":{"post":{"operationId":"AgentDeleteFile","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Deletes the given file from the given source on computers matching the given query","summary":"Delete a given file on computers matching the given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsDeleteFileParams"}}}}}},"/v1/remediation/agent/process/information":{"post":{"operationId":"AgentCollectProcessInformation","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Collects information about processes on computers matching the given query","summary":"Collect information about processes on computers matching the given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestCollectProcessInformationParams"}}}}}},"/v1/remediation/agent/process/terminate":{"post":{"operationId":"AgentTerminateProcess","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Terminates the given process on computers matching the given query","summary":"Terminate the given process on computers matching the given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsTerminateProcessParams"}}}}}},"/v1/remediation/agent/vpn/site/add":{"post":{"operationId":"AgentAddVpnSite","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Adds the given VPN Site's configuration to computers matching the given query\nAdding a VPN Site allows Harmony Endpoint Clients to connect to it
","summary":"Add the VPN Site's configuration to computers matching the given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsAddVpnSiteParams"}}}}}},"/v1/remediation/agent/vpn/site/remove":{"post":{"operationId":"AgentRemoveVpnSite","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Removes the given VPN Site's configuration to computers matching the given query","summary":"Remove the given VPN Site's configuration to computers matching the given query","tags":["Remediation & Response - Agent"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsRemoveVpnSiteParams"}}}}}},"/v1/remediation/anti-malware/scan":{"post":{"operationId":"AntiMalwareScan","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}}},"description":"Performs an Anti-Malware scan on computers matching the given query","summary":"Perform an Anti-Malware scan on computers matching a query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestAmScanParameters"}}}}}},"/v1/remediation/anti-malware/update":{"post":{"operationId":"AntiMalwareUpdate","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}}},"description":"Updates the Anti-Malware Signature Database on computers matching the given query","summary":"Update the Anti-Malware Signature Database on computers matching a query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestAmUpdateParameters"}}}}}},"/v1/remediation/anti-malware/restore":{"post":{"operationId":"AntiMalwareRestore","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}}},"description":"Restores a file that was previously quarantined by the Harmony Endpoint Client's Anti-Malware capability","summary":"Restore a file that was quarantined by the Harmony Endpoint Client's Anti-Malware","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestAmRestoreParameters"}}}}}},"/v1/remediation/forensics/analyze-by-indicator/url":{"post":{"operationId":"AnalyzeByUrl","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Collects forensics data whenever a computer that matches the given query accesses the given URL","summary":"Collect forensic information on computers matching a given query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsForensicsAnalyzeByIndicatorParameters"}}}}}},"/v1/remediation/forensics/analyze-by-indicator/ip":{"post":{"operationId":"AnalyzeByIp","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Collects forensics data whenever a computer that matches the given query accesses or executes a resource matching the given MD5","summary":"Collect forensic information on computers matching a given query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsForensicsAnalyzeByIndicatorParameters"}}}}}},"/v1/remediation/forensics/analyze-by-indicator/path":{"post":{"operationId":"AnalyzeByPath","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"\nCollects forensics data whenever a computer that matches the given query accesses or executes a resource residing in the given path","summary":"Collect forensic information on computers matching a given query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsForensicsAnalyzeByIndicatorParameters"}}}}}},"/v1/remediation/forensics/analyze-by-indicator/file-name":{"post":{"operationId":"AnalyzeByFileName","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Collects forensics data whenever a computer that matches the given query accesses or executes the given file","summary":"Collect forensic information on computers matching a given query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsForensicsAnalyzeByIndicatorParameters"}}}}}},"/v1/remediation/forensics/analyze-by-indicator/md5":{"post":{"operationId":"AnalyzeByMd5","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Collects forensics data whenever a computer that matches the given query accesses or executes a resource matching the given MD5","summary":"Collect forensic information on computers matching a given query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsForensicsAnalyzeByIndicatorParameters"}}}}}},"/v1/remediation/forensics/file/quarantine":{"post":{"operationId":"QuarantineFile","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Quarantines files given by path or MD5 or detections relating to a forensic incident","summary":"Quarantine given files on computers matching a given query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsForensicsQuarantineOperationParams"}}}}}},"/v1/remediation/forensics/file/restore":{"post":{"operationId":"RestoreQuarantinedFile","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Restores previously quarantined files given by path or MD5 or detections relating to a forensic incident","summary":"Restore given file from quarantine on computers matching a given query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsForensicsQuarantineOperationParams"}}}}}},"/v1/remediation/isolate":{"post":{"operationId":"IsolateComputer","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Isolates the computers matching the given query.\nIsolation is the act of denying all network access from a given computer
","summary":"Isolate computers matching a given query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePushOperationRequest"}}}}}},"/v1/remediation/de-isolate":{"post":{"operationId":"DeIsolateComputer","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"De-Isolates the computers matching the given query.\nDe-isolating a computer restores its access to network resources. Affects only isolated computers
","summary":"De-isolate computers matching a given query","tags":["Remediation & Response - Threat Prevention"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJobON.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePushOperationRequest"}}}}}},"/v1/remediation/status":{"get":{"operationId":"GetAllRemediationOperationStatuses","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_PushOperationStatus-Array_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"500":{"description":"An internal error has occurred"}},"description":"Gets the current statuses of all Remediation Operations","summary":"Get the status of all Remediation Operations","tags":["Remediation & Response - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}]}},"/v1/remediation/{id}/status":{"get":{"operationId":"GetRemediationOperationStatusById","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_PushOperationStatus_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"404":{"description":"The given Remediation Operation was not found"},"500":{"description":"An internal error has occurred"}},"description":"Gets the current status of the given Remediation Operation\nNote: By default, the operation returns a Job that needs to be queried by the GET /job/{id} API
\nWhen completed, the job will contain the operation's current status.The job itself should not be re-used.\nDoing so will yield the same result
","summary":"Get the status of a given Remediation Operation","tags":["Remediation & Response - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}},{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]}},"/v1/remediation/{id}/abort":{"post":{"operationId":"AbortRemediationOperationById","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_AcknowledgeResponse_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"404":{"description":"The given Remediation Operation was not found"},"500":{"description":"An internal error has occurred"}},"description":"Aborts the given Remediation Operation.\nAborting an operation prevents it from being sent to further Harmony Endpoint Clients.
\nClients that have already received the operation are not affected
","summary":"Abort a given Remediation Operation","tags":["Remediation & Response - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}]}},"/v1/remediation/{id}/results/slim":{"post":{"operationId":"GetRemediationOperationSlimResultsById","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_PushOperationClientResultSlimResponse_"}}}},"403":{"description":"You do not have permissions to perform the operation"},"404":{"description":"The given Remediation Operation was not found"},"500":{"description":"An internal error has occurred"}},"description":"Gets the results of a given Remediation Operation.\n\nRemediation Operations may produce results such a Forensics Report or yield status updates such as an Anti-Malware scan progress.
\nNote: this operation is a 'slim' version, returning only essential information
","summary":"Get the results of a given Remediation Operation.","tags":["Remediation & Response - General"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationResultsRequestSlim"}}}}}},"/v1/quarantine-management/file/data":{"get":{"operationId":"GetQuarantineFileData","responses":{"200":{"description":"The requested quarantine files data was found and returned in the response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_QuarantinedFile-Array_"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"tags":["Quarantine Management"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"query","name":"pageSize","required":true,"schema":{"$ref":"#/components/schemas/PageSizeQuarantine"}},{"in":"query","name":"offset","required":true,"schema":{"$ref":"#/components/schemas/OffsetQuarantine"}},{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}]},"post":{"operationId":"GetQuarantineFileDataByDevice","responses":{"200":{"description":"The requested quarantine files data for specific devices was found and returned in the response body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_QuarantinedFile-Array_"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"tags":["Quarantine Management"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuarantineManagementFileByDeviceNameRequest"}}}}}},"/v1/quarantine-management/file/restore":{"post":{"operationId":"QuarantineFileRestore","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobOrResult_PushOperationCreationResult_"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"tags":["Quarantine Management"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsRestoreQuarantinedFileParams"}}}}}},"/v1/quarantine-management/file/fetch":{"post":{"operationId":"QuarantineFileFetch","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationCreationResult"}}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"tags":["Quarantine Management"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[{"in":"header","name":"x-mgmt-run-as-job","required":true,"schema":{"$ref":"#/components/schemas/RunAsJob.On"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushOperationRequestWithMandatoryParamsFetchQuarantinedFileParams"}}}}}},"/v1/session/keepalive":{"post":{"operationId":"KeepAlive","responses":{"204":{"description":"Keepalive was performed successfully.Updated Time until session expiration is specified in the 'x-mgmt-session-expiry-seconds' header as a number of seconds","headers":{"x-mgmt-session-expiry-seconds":{"schema":{"type":"string"},"required":true}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Resets the expiration time for the session back to its default value\nKeep-alive calls are used to extend the useful lifespan of a session without performing any meaningful operations
","summary":"Refresh an API work-session","tags":["Session"],"security":[{"cloudInfraJwt":[],"apiJwt":[]}],"parameters":[]}},"/v1/session/login/cloud":{"post":{"operationId":"LoginCloud","responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponse"}}},"headers":{"x-mgmt-session-expiry-utc-epoch":{"schema":{"type":"string"},"required":true},"x-mgmt-session-expiry-seconds":{"schema":{"type":"string"},"required":true},"x-mgmt-api-token":{"schema":{"type":"string"},"required":true}}},"401":{"description":"CloudInfra or API tokens are missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorExample"}}}},"403":{"description":"You do not have permissions to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorExample"}}}},"422":{"description":"The request was understood but was found to be invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntryErrorExample"}}}},"500":{"description":"An internal error has occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalErrorExample"}}}}},"description":"Creates a new API work-session.\nBy default, API sessions last 6 minutes before expiring. Performing any authenticated operation will reset the expiry
\n\nNote: The session created by this API Endpoint is unrelated to the Infinity Portal session conveyed via the 'cloudinfraJwt' bearer token
\nTo manually reset the expiry without performing any meaningful operations see the 'keepalive' operation
","summary":"Create a new API work-session","tags":["Session"],"security":[{"cloudInfraJwt":[]}],"parameters":[]}}},"servers":[{"url":"https://cloudinfra-gw.portal.checkpoint.com/app/endpoint-web-mgmt/harmony/endpoint/api","description":"Access via the Infinity Portal gateway based in Dublin, Ireland"},{"url":"https://cloudinfra-gw-us.portal.checkpoint.com/app/endpoint-web-mgmt/harmony/endpoint/api","description":"Access via the Infinity Portal gateway based in North Virginia, USA"},{"url":"https://cloudinfra-gw.ap.portal.checkpoint.com/app/endpoint-web-mgmt/harmony/endpoint/api","description":"Access via the Infinity Portal gateway based in Sydney, Australlia"}],"tags":[{"name":"Session","description":"Authenticate for and maintain Harmony Endpoint API sessions"},{"name":"Jobs","description":"Query for the state of active managerial operations"},{"name":"Asset Management","description":"Gain insight and control over the organization's assets"},{"name":"Posture Management - Vulnerabilities","description":"Monitor vulnerabilities, scan devices and patch applications"},{"name":"Quarantine Management","description":"Monitor, restore and fetch quarantine files"},{"name":"Indicators of Compromise","description":"Rapidly and globally adapt to engage potential or active threats"},{"name":"Remediation & Response - General","description":"Gain insight and control over active Remediation Operations"},{"name":"Remediation & Response - Agent","description":"Remotely perform managerial operations on Harmony Endpoint Clients"},{"name":"Remediation & Response - Threat Prevention","description":"Remotely perform security-oriented operations on Harmony Endpoint Clients"},{"name":"Policy - General","description":"Manage general aspects of the Harmony Endpoint organizational policies"},{"name":"Organizational Structure","description":"Gain insight and control over the organization's structure and assignments"}]}