{ "swagger": "2.0", "info": { "title": "Radar 3.0 API integration", "version": "integration" }, "paths": { "/api/integration/assetmonitoring/{id}": { "delete": { "tags": [ "Assets monitoring" ], "summary": "Delete discovery scan asset monitoring", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/api/integration/assetmonitoring/custom": { "post": { "tags": [ "Assets monitoring" ], "summary": "Create new custom asset monitoring", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/AssetMonitoringBaseViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/assetmonitoring/custom/{id}": { "get": { "tags": [ "Assets monitoring" ], "summary": "Get custom asset monitoring details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetMonitoringBaseViewModel" } } } }, "put": { "tags": [ "Assets monitoring" ], "summary": "Update custom asset monitoring", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/AssetMonitoringBaseViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/assetmonitoring/custom/{id}/assets": { "post": { "tags": [ "Assets monitoring" ], "summary": "Pass custom assets for asset monitoring mechanism (for example external hosts etc.)", "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/DiscoveredAssetViewModel" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/assetmonitoring/discoveryscan": { "post": { "tags": [ "Assets monitoring" ], "summary": "Create new discovery scan asset monitoring", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/DiscoveryScanAssetMonitoringViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/assetmonitoring/discoveryscan/{id}": { "get": { "tags": [ "Assets monitoring" ], "summary": "Get discovery scan asset monitoring details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiscoveryScanAssetMonitoringViewModel" } } } }, "put": { "tags": [ "Assets monitoring" ], "summary": "Update discovery scan asset monitoring", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/DiscoveryScanAssetMonitoringViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/assetmonitoring/internetdiscovery": { "post": { "tags": [ "Assets monitoring" ], "summary": "Create new internet discovery asset monitoring", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "View model representing information about a new internet discovery asset monitoring.", "schema": { "$ref": "#/definitions/InternetDiscoveryAssetMonitoringViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/assetmonitoring/internetdiscovery/{id}": { "get": { "tags": [ "Assets monitoring" ], "summary": "Get internet discovery asset monitoring details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Asset monitoring unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InternetDiscoveryAssetMonitoringViewModel" } } } }, "put": { "tags": [ "Assets monitoring" ], "summary": "Update internet discovery asset monitoring", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "View model representing information about updated internet discovery asset monitoring.", "schema": { "$ref": "#/definitions/InternetDiscoveryAssetMonitoringViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/assetmonitoring/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Assets monitoring" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/AssetMonitoringFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[AssetMonitoringListViewModel]" } } } } }, "/api/integration/systemscans": { "put": { "tags": [ "Network scans" ], "summary": "Update System Scan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters to update the existing scan.", "schema": { "$ref": "#/definitions/UpdateSystemScanViewModel" } } ], "responses": { "200": { "description": "Updated System Scan data", "schema": { "$ref": "#/definitions/ScanViewModel" } } } } }, "/api/integration/systemscans/{scanId}": { "get": { "tags": [ "Network scans" ], "summary": "Get the specific System Scan definition", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "System Scan definition", "schema": { "$ref": "#/definitions/ScanViewModel" } } } } }, "/api/integration/systemscans/{scanId}/notifications": { "get": { "tags": [ "Network scans" ], "summary": "Get a list of notifications for a System Scan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of notifications", "schema": { "$ref": "#/definitions/Collection[MessageNotificationViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/ports": { "get": { "tags": [ "Network scans" ], "summary": "Get scan ports", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "onlyOpenPorts", "description": "A flag indicates that only open ports are requested", "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Collection[ScanPortSimpleViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/tags": { "get": { "tags": [ "Network scans" ], "summary": "Gets available scan tags", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Collection[TagViewModel]" } } } }, "post": { "tags": [ "Network scans" ], "summary": "Add existing or create a new tag", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Information about a new tag.", "schema": { "$ref": "#/definitions/NewTagViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TagViewModel" } } } } }, "/api/integration/systemscans/{scanId}/tags/{technicalName}": { "delete": { "tags": [ "Network scans" ], "summary": "Removes tag", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "technicalName", "description": "Tag technical name to remove", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/systemscans/allowediprange": { "get": { "tags": [ "Network scans" ], "summary": "Get allowed IP range for scanning", "produces": [ "application/json" ], "responses": { "200": { "description": "Allowed IP range", "schema": { "type": "string" } } } } }, "/api/integration/vulnerabilityscans/{scanId}/configuration/xml": { "get": { "tags": [ "Network scans" ], "summary": "Download scan configuration", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A scan configuration xml" } } } }, "/api/integration/vulnerabilityscans/{scanId}/detailed": { "get": { "tags": [ "Network scans" ], "summary": "Get CcrId of the asset host related to the scan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "CcrId of the asset host related to the scan. Null if not found", "schema": { "$ref": "#/definitions/DeviceInfoDto" } } } } }, "/api/integration/vulnerabilityscans/{scanId}/detailed/assetid": { "get": { "tags": [ "Network scans" ], "summary": "Get the scan information", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "AssetId of the asset host related to the scan. Null if not found", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/vulnerabilityscans/{scanId}/info": { "get": { "tags": [ "Network scans" ], "summary": "Get the scan information", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Returns vulnerability ScanViewModel item", "schema": { "$ref": "#/definitions/ScanViewModel" } } } } }, "/api/integration/vulnerabilityscans/{scanId}/log": { "get": { "tags": [ "Network scans" ], "summary": "Get a scan log", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "newerThan", "description": "Optional parameter, show only newer logs than the specified date. (relevant when asking for refreshed logs)", "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "Scan log view model" } }, "deprecated": true } }, "/api/integration/vulnerabilityscans/{scanId}/log/download": { "get": { "tags": [ "Network scans" ], "summary": "Get a presigned URL to download a scan log", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "newerThan", "description": "Optional parameter, show only newer logs than the specified date. (relevant when asking for refreshed logs)", "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the log", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/vulnerabilityscans/{scanId}/log/refresh": { "get": { "tags": [ "Network scans" ], "summary": "Refresh scan log", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "format": "date-time", "type": "string" } } } } }, "/api/integration/vulnerabilityscans/{scanId}/start": { "put": { "tags": [ "Network scans" ], "summary": "Start the vulnerability scan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Returns the started vulnerablity ScanViewModel item", "schema": { "$ref": "#/definitions/VulnerabilityScansListViewModel" } } } } }, "/api/integration/vulnerabilityscans/{scanId}/stop": { "put": { "tags": [ "Network scans" ], "summary": "Stop vulnerability scan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Returns stopped vulnerability ScanViewModel item", "schema": { "$ref": "#/definitions/VulnerabilityScansListViewModel" } } } } }, "/api/integration/vulnerabilityscans/add/batch": { "post": { "tags": [ "Network scans" ], "summary": "Adds many System Scans at once", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "type": "array", "items": { "$ref": "#/definitions/AddSystemScansViewModel" } } } ], "responses": { "200": { "description": "Object with a list of added scan unique identifiers", "schema": { "$ref": "#/definitions/AddSystemScansResultViewModel" } } } } }, "/api/integration/vulnerabilityscans/any": { "get": { "tags": [ "Network scans" ], "summary": "Get information if there are any scans defined within the current organization", "produces": [ "application/json" ], "responses": { "200": { "description": "ScansAndScanGroupsViewModel", "schema": { "$ref": "#/definitions/ScansAndScanGroupsViewModel" } } } } }, "/api/integration/vulnerabilityscans/configuration/xml": { "put": { "tags": [ "Network scans" ], "summary": "Upload scans configuration", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Action parameters", "schema": { "$ref": "#/definitions/BatchUpdateScanConfigurationViewModel" } } ], "responses": { "200": { "description": "A list of updated scans", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } } }, "get": { "tags": [ "Network scans" ], "summary": "Download scan configurations", "parameters": [ { "in": "query", "name": "ScanGroupIds", "description": "A list of the scan group's unique identifiers to change the state for all its scans", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "ScanIds", "description": "A list of unique identifiers for Scans where the state is changed", "required": true, "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "StartPage", "description": "A start page", "type": "integer", "format": "int32" }, { "in": "query", "name": "PageSize", "description": "A page size", "type": "integer", "format": "int32" }, { "in": "query", "name": "VulnerabilityScansFilterModel.NextRunDays", "description": "A next run days", "type": "integer", "format": "int32" }, { "in": "query", "name": "VulnerabilityScansFilterModel.Protocol", "description": "A protocol type" }, { "in": "query", "name": "VulnerabilityScansFilterModel.ScheduleId", "description": "A unique identifier for a schedule", "type": "string", "format": "uuid" }, { "in": "query", "name": "VulnerabilityScansFilterModel.ScanTemplateId", "description": "A unique identifier for a scan template", "type": "string", "format": "uuid" }, { "in": "query", "name": "VulnerabilityScansFilterModel.AllScanRunStates", "description": "A flag that indicates whether results can contain vulnerability scans with all run states. The default value is 'true'", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.ScanRunStates", "description": "An array with scan run states that are taken into account during filtering", "type": "array", "items": { "$ref": "#/definitions/ScanRunStateType" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityScansFilterModel.NewFindingsOnly", "description": "A flag that indicates whether only new findings are returned", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.AutomationAssetsOnly", "description": "A flag that indicates whether only automation assets are returned", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.SystemScan", "description": "A flag that indicates whether only System Scans are returned. The default value is 'true'", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.WebScan", "description": "A flag that indicates whether only Web Scans are returned. The default value is 'true'", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.NameOperator", "description": "A logic operator that is used to filter results by scan name", "type": "string" }, { "in": "query", "name": "VulnerabilityScansFilterModel.Name", "description": "Filters results by vulnerability scan name", "type": "string" }, { "in": "query", "name": "VulnerabilityScansFilterModel.HostName", "description": "Filters results by host name", "type": "string" }, { "in": "query", "name": "VulnerabilityScansFilterModel.HostNameOperator", "description": "A logical operator that is used to filter results by a host name. The default value is 'Is'", "type": "string" }, { "in": "query", "name": "VulnerabilityScansFilterModel.Responsible", "description": "A unique identifier for a responsible user", "type": "string", "format": "uuid" }, { "in": "query", "name": "VulnerabilityScansFilterModel.IPaddressOperator", "description": "A logical operator that is used to filter results by a host name. The default value is 'Is'", "type": "string" }, { "in": "query", "name": "VulnerabilityScansFilterModel.IPaddress", "description": "Filters results by an IP address", "type": "string" }, { "in": "query", "name": "VulnerabilityScansFilterModel.OperatingSystem", "description": "Filters results by operating system", "type": "string" }, { "in": "query", "name": "VulnerabilityScansFilterModel.Scanned", "description": "A time-based scan type (before, after, never, any). The default value is 'any'" }, { "in": "query", "name": "VulnerabilityScansFilterModel.ScannedNumber", "description": "A number of units used when checking the time of scan. The default value is 1", "type": "integer", "format": "int32" }, { "in": "query", "name": "VulnerabilityScansFilterModel.ScannedWhenUnit", "description": "Type of units that are used when checking the type of scan. The default value is 'Hours'" }, { "in": "query", "name": "VulnerabilityScansFilterModel.ScanGroup", "description": "Filters results by a list of scan groups", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityScansFilterModel.TagsOneOf", "description": "Tags included in the scan. The value is 'True' if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityScansFilterModel.TagsAllOf", "description": "Tags included in the scan. The value is 'True' if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityScansFilterModel.Severity", "description": "A severity level. The default value is 'All'", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityScansFilterModel.ExcludeHigherSeverity", "description": "A flag that indicates whether the result should exclude vulnerabilities with high severity", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.SkipNotScannedTargets", "description": "A flag that indicates whether targets that are not scanned should be skipped in results", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.HideEmptyScanGroups", "description": "A flag that indicates whether empty scan groups should be hidden", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.IsUpcomingScan", "description": "A flag that indicates an upcoming scan", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "VulnerabilityScansFilterModel.SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "VulnerabilityScansFilterModel.SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "VulnerabilityScansFilterModel.Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A compressed file with scan configurations" } } } }, "/api/integration/vulnerabilityscans/csv": { "get": { "tags": [ "Network scans" ], "summary": "Get vulnerability scans in csv format for the given filter", "parameters": [ { "in": "query", "name": "NextRunDays", "description": "A next run days", "type": "integer", "format": "int32" }, { "in": "query", "name": "Protocol", "description": "A protocol type" }, { "in": "query", "name": "ScheduleId", "description": "A unique identifier for a schedule", "type": "string", "format": "uuid" }, { "in": "query", "name": "ScanTemplateId", "description": "A unique identifier for a scan template", "type": "string", "format": "uuid" }, { "in": "query", "name": "AllScanRunStates", "description": "A flag that indicates whether results can contain vulnerability scans with all run states. The default value is 'true'", "type": "boolean" }, { "in": "query", "name": "ScanRunStates", "description": "An array with scan run states that are taken into account during filtering", "type": "array", "items": { "$ref": "#/definitions/ScanRunStateType" }, "collectionFormat": "multi" }, { "in": "query", "name": "NewFindingsOnly", "description": "A flag that indicates whether only new findings are returned", "type": "boolean" }, { "in": "query", "name": "AutomationAssetsOnly", "description": "A flag that indicates whether only automation assets are returned", "type": "boolean" }, { "in": "query", "name": "SystemScan", "description": "A flag that indicates whether only System Scans are returned. The default value is 'true'", "type": "boolean" }, { "in": "query", "name": "WebScan", "description": "A flag that indicates whether only Web Scans are returned. The default value is 'true'", "type": "boolean" }, { "in": "query", "name": "NameOperator", "description": "A logic operator that is used to filter results by scan name", "type": "string" }, { "in": "query", "name": "Name", "description": "Filters results by vulnerability scan name", "type": "string" }, { "in": "query", "name": "HostName", "description": "Filters results by host name", "type": "string" }, { "in": "query", "name": "HostNameOperator", "description": "A logical operator that is used to filter results by a host name. The default value is 'Is'", "type": "string" }, { "in": "query", "name": "Responsible", "description": "A unique identifier for a responsible user", "type": "string", "format": "uuid" }, { "in": "query", "name": "IPaddressOperator", "description": "A logical operator that is used to filter results by a host name. The default value is 'Is'", "type": "string" }, { "in": "query", "name": "IPaddress", "description": "Filters results by an IP address", "type": "string" }, { "in": "query", "name": "OperatingSystem", "description": "Filters results by operating system", "type": "string" }, { "in": "query", "name": "Scanned", "description": "A time-based scan type (before, after, never, any). The default value is 'any'" }, { "in": "query", "name": "ScannedNumber", "description": "A number of units used when checking the time of scan. The default value is 1", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScannedWhenUnit", "description": "Type of units that are used when checking the type of scan. The default value is 'Hours'" }, { "in": "query", "name": "ScanGroup", "description": "Filters results by a list of scan groups", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TagsOneOf", "description": "Tags included in the scan. The value is 'True' if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TagsAllOf", "description": "Tags included in the scan. The value is 'True' if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "Severity", "description": "A severity level. The default value is 'All'", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "ExcludeHigherSeverity", "description": "A flag that indicates whether the result should exclude vulnerabilities with high severity", "type": "boolean" }, { "in": "query", "name": "SkipNotScannedTargets", "description": "A flag that indicates whether targets that are not scanned should be skipped in results", "type": "boolean" }, { "in": "query", "name": "HideEmptyScanGroups", "description": "A flag that indicates whether empty scan groups should be hidden", "type": "boolean" }, { "in": "query", "name": "IsUpcomingScan", "description": "A flag that indicates an upcoming scan", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "Vulnerability scans in cvs format" } }, "deprecated": true } }, "/api/integration/vulnerabilityscans/csv/download": { "get": { "tags": [ "Network scans" ], "summary": "Get a presigned URL to download vulnerability scans in csv format", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "NextRunDays", "description": "A next run days", "type": "integer", "format": "int32" }, { "in": "query", "name": "Protocol", "description": "A protocol type" }, { "in": "query", "name": "ScheduleId", "description": "A unique identifier for a schedule", "type": "string", "format": "uuid" }, { "in": "query", "name": "ScanTemplateId", "description": "A unique identifier for a scan template", "type": "string", "format": "uuid" }, { "in": "query", "name": "AllScanRunStates", "description": "A flag that indicates whether results can contain vulnerability scans with all run states. The default value is 'true'", "type": "boolean" }, { "in": "query", "name": "ScanRunStates", "description": "An array with scan run states that are taken into account during filtering", "type": "array", "items": { "$ref": "#/definitions/ScanRunStateType" }, "collectionFormat": "multi" }, { "in": "query", "name": "NewFindingsOnly", "description": "A flag that indicates whether only new findings are returned", "type": "boolean" }, { "in": "query", "name": "AutomationAssetsOnly", "description": "A flag that indicates whether only automation assets are returned", "type": "boolean" }, { "in": "query", "name": "SystemScan", "description": "A flag that indicates whether only System Scans are returned. The default value is 'true'", "type": "boolean" }, { "in": "query", "name": "WebScan", "description": "A flag that indicates whether only Web Scans are returned. The default value is 'true'", "type": "boolean" }, { "in": "query", "name": "NameOperator", "description": "A logic operator that is used to filter results by scan name", "type": "string" }, { "in": "query", "name": "Name", "description": "Filters results by vulnerability scan name", "type": "string" }, { "in": "query", "name": "HostName", "description": "Filters results by host name", "type": "string" }, { "in": "query", "name": "HostNameOperator", "description": "A logical operator that is used to filter results by a host name. The default value is 'Is'", "type": "string" }, { "in": "query", "name": "Responsible", "description": "A unique identifier for a responsible user", "type": "string", "format": "uuid" }, { "in": "query", "name": "IPaddressOperator", "description": "A logical operator that is used to filter results by a host name. The default value is 'Is'", "type": "string" }, { "in": "query", "name": "IPaddress", "description": "Filters results by an IP address", "type": "string" }, { "in": "query", "name": "OperatingSystem", "description": "Filters results by operating system", "type": "string" }, { "in": "query", "name": "Scanned", "description": "A time-based scan type (before, after, never, any). The default value is 'any'" }, { "in": "query", "name": "ScannedNumber", "description": "A number of units used when checking the time of scan. The default value is 1", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScannedWhenUnit", "description": "Type of units that are used when checking the type of scan. The default value is 'Hours'" }, { "in": "query", "name": "ScanGroup", "description": "Filters results by a list of scan groups", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TagsOneOf", "description": "Tags included in the scan. The value is 'True' if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TagsAllOf", "description": "Tags included in the scan. The value is 'True' if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "Severity", "description": "A severity level. The default value is 'All'", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "ExcludeHigherSeverity", "description": "A flag that indicates whether the result should exclude vulnerabilities with high severity", "type": "boolean" }, { "in": "query", "name": "SkipNotScannedTargets", "description": "A flag that indicates whether targets that are not scanned should be skipped in results", "type": "boolean" }, { "in": "query", "name": "HideEmptyScanGroups", "description": "A flag that indicates whether empty scan groups should be hidden", "type": "boolean" }, { "in": "query", "name": "IsUpcomingScan", "description": "A flag that indicates an upcoming scan", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the CSV file", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/vulnerabilityscans/delete/batch": { "post": { "tags": [ "Network scans" ], "summary": "Delete scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A BatchScanViewModel", "schema": { "$ref": "#/definitions/BatchScanViewModel" } } ], "responses": { "200": { "description": "A list of unique identifiers for deleted scans", "schema": { "$ref": "#/definitions/DeleteActionTypeEnum" } } } } }, "/api/integration/vulnerabilityscans/grouped": { "get": { "tags": [ "Network scans" ], "summary": "Get summary information about vulnerability scans", "produces": [ "application/json" ], "responses": { "200": { "description": "Summary information", "schema": { "$ref": "#/definitions/VulnerabilityScansSummaryViewModel" } } } } }, "/api/integration/vulnerabilityscans/grouped/scans/count": { "put": { "tags": [ "Network scans" ], "summary": "Get the number of scans that are grouped by a scan type for a given filter", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Filter parameters.", "schema": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } } ], "responses": { "200": { "description": "Number of scans", "schema": { "$ref": "#/definitions/NumberOfScansViewModel" } } } } }, "/api/integration/vulnerabilityscans/grouped/scans/operating/system/count": { "put": { "tags": [ "Network scans" ], "summary": "Get a list of scans that are grouped based on operating system for a given filter", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Filter parameters.", "schema": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } } ], "responses": { "200": { "description": "A list of scans that are grouped based on operating system", "schema": { "$ref": "#/definitions/Collection[NameValueItem[Int32]]" } } } } }, "/api/integration/vulnerabilityscans/grouped/scans/statuses/count": { "put": { "tags": [ "Network scans" ], "summary": "Get the number of scans that are grouped based on scanning progress for a given filter", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Filter parameters.", "schema": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } } ], "responses": { "200": { "description": "A number of scans", "schema": { "$ref": "#/definitions/Collection[ScanningProgressViewModel]" } } } } }, "/api/integration/vulnerabilityscans/grouped/severity/count": { "put": { "tags": [ "Network scans" ], "summary": "Get the number of vulnerabilities that are grouped based on the severity for a given filter", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Filter parameters.", "schema": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } } ], "responses": { "200": { "description": "A number of vulnerabilities", "schema": { "$ref": "#/definitions/NumberOfVulnerabiltiesViewModel" } } } } }, "/api/integration/vulnerabilityscans/move/batch": { "post": { "tags": [ "Network scans" ], "summary": "Move scans to another scan group", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Action parameters", "schema": { "$ref": "#/definitions/BatchMoveScanViewModel" } } ], "responses": { "200": { "description": "A list of moved scans", "schema": { "$ref": "#/definitions/Collection[ScanViewModel]" } } } } }, "/api/integration/vulnerabilityscans/schedule/update/batch": { "put": { "tags": [ "Network scans" ], "summary": "Update scan schedules", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateScanScheduleViewModel" } } ], "responses": { "200": { "description": "A list of updated scans", "schema": { "$ref": "#/definitions/Collection[ScanViewModel]" } } } } }, "/api/integration/vulnerabilityscans/start/batch": { "put": { "tags": [ "Network scans" ], "summary": "Start the vulnerability scans that are single scans or belong to scan groups", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A view model containing scan IDs or scan group IDs.", "schema": { "$ref": "#/definitions/BatchScanViewModel" } } ], "responses": { "200": { "description": "Returns updated entries to the list", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } } } }, "/api/integration/vulnerabilityscans/stop/batch": { "put": { "tags": [ "Network scans" ], "summary": "Stop vulnerability scans that are single scans or belong to scan groups", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A view model that contains scan or scan group unique identifiers.", "schema": { "$ref": "#/definitions/BatchScanViewModel" } } ], "responses": { "200": { "description": "Returns updated entries to the list", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } } } }, "/api/integration/vulnerabilityscans/tags/batch": { "put": { "tags": [ "Network scans" ], "summary": "Update scan tags", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchAddTagsToScansViewModel" } } ], "responses": { "200": { "description": "A list of updated scans", "schema": { "$ref": "#/definitions/Collection[ScanViewModel]" } } } } }, "/api/integration/vulnerabilityscans/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Network scans" ], "summary": "Get a paged list of vulnerability scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilityScansListViewModel]" } } } } }, "/api/integration/webscans": { "post": { "tags": [ "Network scans" ], "summary": "Create Web Scan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters for creating a new web scan.", "schema": { "$ref": "#/definitions/CreateWebScanViewModel" } } ], "responses": { "200": { "description": "Data for a newly created Web Scan", "schema": { "$ref": "#/definitions/WebScanViewModel" } } } }, "put": { "tags": [ "Network scans" ], "summary": "Update Web Scan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters to update the existing Web Scan.", "schema": { "$ref": "#/definitions/UpdateWebScanViewModel" } } ], "responses": { "200": { "description": "Updated Web Scan data", "schema": { "$ref": "#/definitions/WebScanViewModel" } } } } }, "/api/integration/webscans/{id}": { "get": { "tags": [ "Network scans" ], "summary": "Get Web Scan definition", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "A unique identifier for a Web Scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Data on a definition for a Web Scan", "schema": { "$ref": "#/definitions/WebScanViewModel" } } } } }, "/api/integration/webscans/{id}/recordings/{recordingsId}": { "delete": { "tags": [ "Network scans" ], "summary": "Delete Web Scan recordings", "parameters": [ { "in": "path", "name": "id", "description": "A unique identifier for a Web Scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "recordingsId", "description": "A unique identifier for recordings", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/webscans/{scanId}/notifications": { "get": { "tags": [ "Network scans" ], "summary": "Get a list of notifications for a Web Scan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of notifications for Web Scan", "schema": { "$ref": "#/definitions/Collection[MessageNotificationViewModel]" } } } } }, "/api/integration/webscans/{scanId}/recordings/{recordingId}": { "get": { "tags": [ "Network scans" ], "summary": "Get details of an uploaded recording file", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "recordingId", "description": "A recording unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A Web Scan recording", "schema": { "$ref": "#/definitions/WebScanRecordingViewModel" } } } }, "put": { "tags": [ "Network scans" ], "summary": "Update Web Scan recording", "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "recordingId", "description": "A recording unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters for updating the recording.", "schema": { "type": "array", "items": { "$ref": "#/definitions/UpdateWebScanRecordingItemViewModel" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/webscans/{scanId}/recordings/{recordingId}/xml": { "get": { "tags": [ "Network scans" ], "summary": "Get recordings as an XML file", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "recordingId", "description": "A recording unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "The recordings XML file" } }, "deprecated": true } }, "/api/integration/webscans/{scanId}/recordings/{recordingId}/xml/download": { "get": { "tags": [ "Network scans" ], "summary": "Get recordings as an XML file", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "recordingId", "description": "A recording unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the recording XML file", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/webscans/{scanId}/tags": { "get": { "tags": [ "Network scans" ], "summary": "Get scan tags", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Collection[TagViewModel]" } } } }, "post": { "tags": [ "Network scans" ], "summary": "Add existing or create a new tag", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Information about a new tag.", "schema": { "$ref": "#/definitions/NewTagViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TagViewModel" } } } } }, "/api/integration/webscans/{scanId}/tags/{technicalName}": { "delete": { "tags": [ "Network scans" ], "summary": "Remove tags", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "technicalName", "description": "Tag technical name to remove", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/webscans/default": { "get": { "tags": [ "Network scans" ], "summary": "Get default Web Scan configuration", "produces": [ "application/json" ], "responses": { "200": { "description": "Default Web Scan configuration", "schema": { "$ref": "#/definitions/WebScanViewModel" } } } } }, "/api/integration/discoveryscans": { "put": { "tags": [ "Discovery scans" ], "summary": "Update the existing discovery scan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters for updating an existing discovery scan.", "schema": { "$ref": "#/definitions/UpdateDiscoveryScanDefinitionViewModel" } } ], "responses": { "200": { "description": "Updated discovery scan unique identifier", "schema": { "format": "uuid", "type": "string" } } } }, "post": { "tags": [ "Discovery scans" ], "summary": "Add discovery scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters for adding discovery scans.", "schema": { "$ref": "#/definitions/CreateDiscoveryScanDefinitionViewModel" } } ], "responses": { "200": { "description": "A list of unique identifiers for discovery scans that were added", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } } } }, "/api/integration/discoveryscans/{discoveryId}/reports/{reportId}/hosts/grouped": { "get": { "tags": [ "Discovery scans" ], "summary": "Get latest discovery scan report group information", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HostsGroupViewModel" } } } } }, "/api/integration/discoveryscans/{discoveryId}/reports/{reportId}/hosts/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Discovery scans" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/HostsFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[DiscoveryHostViewModel]" } } } } }, "/api/integration/discoveryscans/{discoveryId}/reports/latest/hosts/grouped": { "get": { "tags": [ "Discovery scans" ], "summary": "Get latest discovery scan report group information", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HostsGroupViewModel" } } } } }, "/api/integration/discoveryscans/{discoveryId}/reports/latest/hosts/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Discovery scans" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/HostsFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[DiscoveryHostViewModel]" } } } } }, "/api/integration/discoveryscans/{discoveryScanId}": { "get": { "tags": [ "Discovery scans" ], "summary": "Get discovery scan details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryScanId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Discovery scan details", "schema": { "$ref": "#/definitions/DiscoveryScanViewModel" } } } } }, "/api/integration/discoveryscans/{discoveryScanId}/log": { "get": { "tags": [ "Discovery scans" ], "summary": "Gets the last discovery scan log", "parameters": [ { "in": "path", "name": "discoveryScanId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "newerThan", "description": "Optional parameter, show only newer logs than the specified date. (relevant when asking for refreshed logs)", "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/integration/discoveryscans/{discoveryScanId}/log/download": { "get": { "tags": [ "Discovery scans" ], "summary": "Gets a presigned URL to download the last discovery scan log", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryScanId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "newerThan", "description": "Optional parameter, show only newer logs than the specified date. (relevant when asking for refreshed logs)", "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/discoveryscans/{discoveryScanId}/log/refresh": { "get": { "tags": [ "Discovery scans" ], "summary": "Refresh scan log", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryScanId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "format": "date-time", "type": "string" } } } } }, "/api/integration/discoveryscans/{discoveryScanId}/notifications": { "get": { "tags": [ "Discovery scans" ], "summary": "Get a list of notifications for a discovery scan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryScanId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of message notifications", "schema": { "$ref": "#/definitions/Collection[MessageNotificationViewModel]" } } } } }, "/api/integration/discoveryscans/{discoveryScansId}/simple": { "get": { "tags": [ "Discovery scans" ], "summary": "Get basic information about the discovery scan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryScansId", "description": "The unique identifier for a discovery scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Information about the discovery scan including run state", "schema": { "$ref": "#/definitions/DiscoveryScanSimpleViewModel" } } } } }, "/api/integration/discoveryscans/{scanId}/start": { "put": { "tags": [ "Discovery scans" ], "summary": "Start discovery scan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Information about the started discovery scan", "schema": { "$ref": "#/definitions/DiscoveryScansListViewModel" } } } } }, "/api/integration/discoveryscans/{scanId}/stop": { "put": { "tags": [ "Discovery scans" ], "summary": "Stop discovery scan", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Information about the discovery scans that were stopped", "schema": { "$ref": "#/definitions/DiscoveryScansListViewModel" } } } } }, "/api/integration/discoveryscans/any": { "get": { "tags": [ "Discovery scans" ], "summary": "Get information about any discovery scans that are defined within the current organization", "produces": [ "application/json" ], "responses": { "200": { "description": "True if there are scans defined", "schema": { "type": "boolean" } } } } }, "/api/integration/discoveryscans/default": { "get": { "tags": [ "Discovery scans" ], "summary": "Get definition details of the default discovery scan", "produces": [ "application/json" ], "responses": { "200": { "description": "Definition details for a default discovery scan", "schema": { "$ref": "#/definitions/DiscoveryScanViewModel" } } } } }, "/api/integration/discoveryscans/delete/batch": { "post": { "tags": [ "Discovery scans" ], "summary": "Delete discovery scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A BatchScanViewModel.", "schema": { "$ref": "#/definitions/BatchNetworkScanViewModel" } } ], "responses": { "200": { "description": "A list of unique identifiers for deleted scans", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } } } }, "/api/integration/discoveryscans/grouped": { "get": { "tags": [ "Discovery scans" ], "summary": "Get summary information about discovery scans", "produces": [ "application/json" ], "responses": { "200": { "description": "Summary information", "schema": { "$ref": "#/definitions/DiscoveryScansListSummaryViewModel" } } } } }, "/api/integration/discoveryscans/schedule/update/batch": { "put": { "tags": [ "Discovery scans" ], "summary": "Update schedule for discovery scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters such as scans and the new schedule unique identifier.", "schema": { "$ref": "#/definitions/BatchUpdateScheduleNetworkScanViewModel" } } ], "responses": { "200": { "description": "A list of updated discovery scans", "schema": { "$ref": "#/definitions/Collection[DiscoveryScansListViewModel]" } } } } }, "/api/integration/discoveryscans/simple": { "get": { "tags": [ "Discovery scans" ], "summary": "Get simple list of discovery scans", "produces": [ "application/json" ], "responses": { "200": { "description": "A simple list of discovery scans", "schema": { "$ref": "#/definitions/Collection[NameIdItem[Guid]]" } } } } }, "/api/integration/discoveryscans/start/batch": { "put": { "tags": [ "Discovery scans" ], "summary": "Start discovery scan", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A unique identifier for scans to be started", "schema": { "$ref": "#/definitions/BatchNetworkScanViewModel" } } ], "responses": { "200": { "description": "List of started scans", "schema": { "$ref": "#/definitions/Collection[DiscoveryScansListViewModel]" } } } } }, "/api/integration/discoveryscans/stop/batch": { "put": { "tags": [ "Discovery scans" ], "summary": "Stop discovery scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A unique identifier for scans to be started", "schema": { "$ref": "#/definitions/BatchNetworkScanViewModel" } } ], "responses": { "200": { "description": "A list of stopped scans", "schema": { "$ref": "#/definitions/Collection[DiscoveryScansListViewModel]" } } } } }, "/api/integration/discoveryscans/template/update/batch": { "put": { "tags": [ "Discovery scans" ], "summary": "Updates the template for multiple scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "View the model with the scans and the new template ID.", "schema": { "$ref": "#/definitions/BatchUpdateTemplateNetworkScanViewModel" } } ], "responses": { "200": { "description": "Updated rows", "schema": { "$ref": "#/definitions/Collection[DiscoveryScansListViewModel]" } } } } }, "/api/integration/discoveryscans/validate/iprangelimit/{limit}": { "post": { "tags": [ "Discovery scans" ], "summary": "Validate discovery scan ip range limit", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "limit", "description": "", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/DiscoveryScanDefinitionScanTargetViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/api/integration/discoveryscans/validate/iprangelimit/hostdiscovery": { "post": { "tags": [ "Discovery scans" ], "summary": "Validate port discovery scan ip range limit", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/DiscoveryScanDefinitionScanTargetViewModel" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/discoveryscans/validate/iprangelimit/portscan": { "post": { "tags": [ "Discovery scans" ], "summary": "Validate host discovery scan ip range limit", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/DiscoveryScanDefinitionScanTargetViewModel" } } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/discoveryscans/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Discovery scans" ], "summary": "Get a paged list of discovery scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/NetworkFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[DiscoveryScansListViewModel]" } } } } }, "/api/integration/assethosts": { "post": { "tags": [ "Assets" ], "summary": "Save asset host details", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Asset host details view model", "schema": { "$ref": "#/definitions/AssetHostDetailsViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } }, "deprecated": true } }, "/api/integration/assethosts/{assetHostId}": { "get": { "tags": [ "Assets" ], "summary": "Get asset host by its unique identifier", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetHostId", "description": "An assethost uniqueidentifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetHostViewModel" } } } } }, "/api/integration/assethosts/asset/{assetId}": { "get": { "tags": [ "Assets" ], "summary": "Get asset host for asset unique identifier", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "description": "An asset uniqueidentifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetHostViewModel" } } } } }, "/api/integration/assethosts/asset/{assetId}/description": { "get": { "tags": [ "Assets" ], "summary": "Get asset host description by asset unique identifier", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "description": "An asset uniqueidentifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetHostDescriptionViewModel" } } } } }, "/api/integration/assethosts/asset/{assetId}/software": { "get": { "tags": [ "Assets" ], "summary": "Get asset host software by asset unique identifier", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "description": "An asset uniqueidentifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetHostSoftwareViewModel" } } } } }, "/api/integration/assethosts/asset/ccrid/{ccrId}": { "get": { "tags": [ "Assets" ], "summary": "Get asset host for asset unique identifier", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "assetId", "description": "An asset uniqueidentifier", "type": "string", "format": "uuid" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetHostViewModel" } } } } }, "/api/integration/assethosts/asset/ccrid/{ccrId}/description": { "get": { "tags": [ "Assets" ], "summary": "Get asset host description by asset unique identifier", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "assetId", "description": "An asset uniqueidentifier", "type": "string", "format": "uuid" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetHostDescriptionViewModel" } } } } }, "/api/integration/assethosts/asset/ccrid/{ccrId}/software": { "get": { "tags": [ "Assets" ], "summary": "Get asset host software by asset unique identifier", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "assetId", "description": "An asset uniqueidentifier", "type": "string", "format": "uuid" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetHostSoftwareViewModel" } } } } }, "/api/integration/assethosts/description": { "post": { "tags": [ "Assets" ], "summary": "Save asset host description", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Asset host description view model", "schema": { "$ref": "#/definitions/AssetHostDescriptionViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } }, "deprecated": true } }, "/api/integration/assets": { "post": { "tags": [ "Assets" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/AssetViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } }, "deprecated": true } }, "/api/integration/assets/{assetId}": { "get": { "tags": [ "Assets" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetDetailsViewModel" } } } } }, "/api/integration/assets/{assetId}/details": { "get": { "tags": [ "Assets" ], "summary": "Get asset details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "description": "An asset unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetViewModel" } } } } }, "/api/integration/assets/{assetId}/logs": { "get": { "tags": [ "Assets" ], "summary": "Get asset's managed scan logs", "parameters": [ { "in": "path", "name": "assetId", "description": "An asset unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "newerThan", "description": "Optional parameter, only shows newer logs than the specified date", "type": "string", "format": "date-time" }, { "in": "query", "name": "jsonResponse", "description": "Set to true in order to return a valid JSON as a response. For backwards compatibility reasons, a default option is to return the log file", "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/integration/assets/{assetId}/logs/download": { "get": { "tags": [ "Assets" ], "summary": "Get a presigned URL to download asset's managed scan logs", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "description": "An asset unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "newerThan", "description": "Optional parameter, only shows newer logs than the specified date", "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/assets/{assetId}/note": { "post": { "tags": [ "Assets" ], "summary": "Update asset note", "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "description": "An asset unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Asset note.", "schema": { "$ref": "#/definitions/AssetNoteViewModel" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/integration/assets/{assetId}/reports/latest/vulnerabilitiesandfindings/{vulnerabilityId}/detailed": { "get": { "tags": [ "Assets" ], "summary": "Get detailed information on vulnerability and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "description": "The asset unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Detailed information on vulnerability and findings", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedViewModel" } } } } }, "/api/integration/assets/{assetId}/reports/latest/vulnerabilitiesandfindings/{vulnerabilityScanDetailId}/history": { "get": { "tags": [ "Assets" ], "summary": "Get historical information on vulnerability and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "vulnerabilityScanDetailId", "description": "The vulnerability instance unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "assetId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Historical information on vulnerability and findings", "schema": { "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsHistoryViewModel" } } } } } }, "/api/integration/assets/{assetId}/reports/latest/vulnerabilitiesandfindings/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Assets" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "assetId", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilitiesAndFindingsViewModel]" } } } } }, "/api/integration/assets/{assetId}/tags": { "get": { "tags": [ "Assets" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Collection[TagViewModel]" } } } }, "post": { "tags": [ "Assets" ], "summary": "Add an existing tag or create a new one for a asset", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "description": "A asset unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Information about a new tag.", "schema": { "$ref": "#/definitions/NewTagViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TagViewModel" } } }, "deprecated": true } }, "/api/integration/assets/{assetId}/tags/{technicalName}": { "delete": { "tags": [ "Assets" ], "summary": "Remove tags from a assetId", "parameters": [ { "in": "path", "name": "assetId", "description": "A asset unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "technicalName", "description": "Tag technical name to remove", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/integration/assets/{ccrId}/detailed/assetid": { "get": { "tags": [ "Assets" ], "summary": "Get the asset information", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ccrId", "description": "An endpoint agent unique identifier installed on device", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns asset unique identifier", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/assets/any": { "get": { "tags": [ "Assets" ], "summary": "Get information if any assets are found", "produces": [ "application/json" ], "responses": { "200": { "description": "True if there are any assets found", "schema": { "type": "boolean" } } } } }, "/api/integration/assets/businessowner/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets business owner", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsBusinessOwnerViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/businessownerresponsibilities/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets business owner responsibilities", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsBusinessOwnerResponsibilitiesViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/ccrid/{ccrId}": { "get": { "tags": [ "Assets" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "assetId", "type": "string", "format": "uuid" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetDetailsViewModel" } } } } }, "/api/integration/assets/ccrid/{ccrId}/details": { "get": { "tags": [ "Assets" ], "summary": "Get asset details", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "assetId", "description": "An asset unique identifier", "type": "string", "format": "uuid" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetViewModel" } } } } }, "/api/integration/assets/ccrid/{ccrId}/logs/download": { "get": { "tags": [ "Assets" ], "summary": "Get a presigned URL to download asset's managed scan logs", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "assetId", "description": "An asset unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "newerThan", "description": "Optional parameter, only shows newer logs than the specified date", "type": "string", "format": "date-time" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/assets/ccrid/{ccrId}/reports/latest/vulnerabilitiesandfindings/{vulnerabilityId}/detailed": { "get": { "tags": [ "Assets" ], "summary": "Get detailed information on vulnerability and findings", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "assetId", "description": "The asset unique identifier", "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Detailed information on vulnerability and findings", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedViewModel" } } } } }, "/api/integration/assets/ccrid/{ccrId}/reports/latest/vulnerabilitiesandfindings/{vulnerabilityScanDetailId}/history": { "get": { "tags": [ "Assets" ], "summary": "Get historical information on vulnerability and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "vulnerabilityScanDetailId", "description": "The vulnerability instance unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Historical information on vulnerability and findings", "schema": { "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsHistoryViewModel" } } } } } }, "/api/integration/assets/ccrid/{ccrId}/reports/latest/vulnerabilitiesandfindings/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Assets" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilitiesAndFindingsViewModel]" } } } } }, "/api/integration/assets/ccrid/{ccrId}/tags": { "get": { "tags": [ "Assets" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "assetId", "type": "string", "format": "uuid" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Collection[TagViewModel]" } } } } }, "/api/integration/assets/contacts/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets contacts", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsContactsViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/contractinvoicing/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets contract and invoicing", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsContractAndInvoicingViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/country/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets country", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsCountryViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/customerpersonaldatacategory/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets customer personal data category", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsCustomerPersonalDataCategoryViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/customerpersonaldatastored/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets customer personal data stored", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsCustomerPersonalDataStoredViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/customerpersonaldatavolume/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets customer personal data volume", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsCustomerPersonalDataVolumeViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/department/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets department", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsDepartmentViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/employeepersonaldatacategory/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets employee personal data category", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsEmployeePersonalDataCategoryViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/employeepersonaldatastored/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets employee personal data stored", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsEmployeePersonalDataStoredViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/employeepersonaldatavolume/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets employee personal data volume", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsEmployeePersonalDataVolumeViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/importance/update/batch": { "put": { "tags": [ "Assets" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/BatchUpdateAssetsImportanceViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/intellectualpropertyrights/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets intellectual property rights", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsIntellectualPropertyRightsViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/internetexposure/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets internet exposure", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsInternetExposureViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/manufacturer/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets manufacturer", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsManufacturerViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/name/{assetId}": { "delete": { "tags": [ "Assets" ], "summary": "Remove asset name", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "description": "An asset unique identifer", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetViewModel" } } }, "deprecated": true } }, "/api/integration/assets/networkenvironment/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets network environment", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsNetworkEnvironmentViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/note/{assetId}": { "delete": { "tags": [ "Assets" ], "summary": "Remove asset note", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "assetId", "description": "An asset unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetViewModel" } } } } }, "/api/integration/assets/note/ccrid/{ccrId}": { "delete": { "tags": [ "Assets" ], "summary": "Remove asset note", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "assetId", "description": "An asset unique identifier", "type": "string", "format": "uuid" }, { "in": "path", "name": "ccrId", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AssetViewModel" } } } } }, "/api/integration/assets/notes/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets notes", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsNotes" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "int32", "type": "integer" } } }, "deprecated": true } }, "/api/integration/assets/purposeofapplication/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets purpose of application", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsPurposeOfApplicationViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/serverhostedin/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets server hosted in", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsServerHostedInViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/serviceowner/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets service owner", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsServiceOwnerViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/serviceownerresponsibilities/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets service owner responsibilities", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsServiceOwnerResponsibilitiesViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/tags/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets tags", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchAddTagsToAssetsViewModel" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/integration/assets/technicaldocumentation/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets technical documentation", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsTechnicalDocumentationViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/undefinedresponsibilities/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets undefined responsibilities", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsUndefinedResponsibilitiesViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/vendor/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets vendor", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsVendorViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/vendorresponsibilities/update/batch": { "put": { "tags": [ "Assets" ], "summary": "Update assets vendor responsibilities", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Operation parameters", "schema": { "$ref": "#/definitions/BatchUpdateAssetsVendorResponsibilitiesViewModel" } } ], "responses": { "200": { "description": "A list of updated assets", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/assets/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Assets" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/AssetFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[AssetsListViewModel]" } } } } }, "/api/integration/systemscans/{id}/reports/{reportId}": { "delete": { "tags": [ "Vulnerability scan reports" ], "summary": "Delete System Scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "", "schema": { "type": "boolean" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get System Scan report as a file in specified format", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File type (docx, xml). The default format is xml", "type": "string" }, { "in": "query", "name": "withAuditorNotes", "description": "A flag that indicates whether auditor notes are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "onlyCVEandBUGTRAQ", "description": "A flag that indicates whether only CVE and BUGTRAQ are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "System Scan report file in specified format" } }, "deprecated": true } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/download": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a presigned URL to download a System Scan report in specified format", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File type (docx, xml). The default format is xml", "type": "string" }, { "in": "query", "name": "withAuditorNotes", "description": "A flag that indicates whether auditor notes are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "onlyCVEandBUGTRAQ", "description": "A flag that indicates whether only CVE and BUGTRAQ are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "JSON response with download URL for the System Scan report", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/log": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a scan log", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Scan log view model" } }, "deprecated": true } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/log/download": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a presigned URL to download a scan log", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the log", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/ports": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get System Scan report ports info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "System Scan report ports information", "schema": { "$ref": "#/definitions/Collection[ScanPortViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/ports/simple": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get simple list of ports for System Scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of ports for System Scan report", "schema": { "$ref": "#/definitions/Collection[ScanPortSimpleViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/simple": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get System Scan info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "System Scan information", "schema": { "$ref": "#/definitions/SystemScanReportViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/statistics/scanhistory": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get counters for the System Scan history", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "ReportType", "description": "A report type", "required": true }, { "in": "query", "name": "StartPeriodDate", "description": "A start date for a period displayed on a report. If null, the date is set to -100 years", "type": "string", "format": "date-time" }, { "in": "query", "name": "EndPeriodDate", "description": "An end date for a period displayed on a report. If null, the date is set to +100 years", "type": "string", "format": "date-time" }, { "in": "query", "name": "ResultMessages", "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" }, "collectionFormat": "multi" }, { "in": "query", "name": "Language", "description": "A language in which the text is returned", "type": "string" }, { "in": "query", "name": "MessageLevel", "description": "A message level" }, { "in": "query", "name": "HttpStatusCode", "description": "A http status code" }, { "in": "query", "name": "Public", "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string" } ], "responses": { "200": { "description": "System Scan history counters", "schema": { "$ref": "#/definitions/Collection[ReportScanHistoryViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/statistics/status": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get System Scan vulnerability statistics by status", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A System Scan statistics", "schema": { "$ref": "#/definitions/ReportStatisticsVulnerabilityByStatusViewModel" } }, "204": { "description": "No Content" } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/statistics/vulnerability": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get counters for System Scan vulnerabilities and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Counters for System Scan vulnerabilities and findings", "schema": { "$ref": "#/definitions/ReportStatisticsVulnerabilityCountersViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/tags": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get vulnerability tags", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Vulnerability tags", "schema": { "$ref": "#/definitions/Collection[TagViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/tickets/simple": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get simple list of tickets for System Scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "onlyOpenTickets", "description": "A flag that indicates whether to return only open tickets", "type": "boolean" } ], "responses": { "200": { "description": "A simple list of tickets for System Scan report", "schema": { "$ref": "#/definitions/Collection[SimpleTicketViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/{vulnerabilityId}/detailed": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get detailed information on vulnerability and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Detailed information on vulnerability and findings", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/{vulnScanDetailID}/status": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Update status of vulnerabilities and findings", "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnScanDetailID", "description": "A unique identifier for vulnerability details", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update status.", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/aggregated/{tagTechnicalName}/detailed": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get aggregated vulnerabilities and findings details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "tagTechnicalName", "description": "A tag technical name", "required": true, "type": "string" }, { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Aggregated vulnerabilities and findings details", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsAggregatedDetailedViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/aggregated/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[IVulnerabilitiesAndFindingsBaseViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/counters": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get counters for System Scan report vulnerabilities and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Counters for System Scan vulnerabilities and findings", "schema": { "$ref": "#/definitions/Collection[ReportFindingsAndChangeViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/grouped": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get System Scan vulnerabilities and findings grouped based on severity", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "System Scan vulnerabilities and findings grouped based on severity", "schema": { "$ref": "#/definitions/VulnerabilityDetailsGroupedViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/manual": { "post": { "tags": [ "Vulnerability scan reports" ], "summary": "Manually add System Scan vulnerability. Manually means by no plug-in", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to add vulnerability manually.", "schema": { "$ref": "#/definitions/SystemScanVulnerabilitiesAndFindingsManualViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManualVulnerabilityViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/status": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Update the status of System Scan report vulnerabilities and findings", "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update status.", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilitiesAndFindingsViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/{reportId}/vulnerabilityscandetail/{vulnerabilityscandetailid}/vulnerabilitiesandfindings/manual": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Manually update System Scan vulnerability. Manually means by no plug-in", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityScanDetailId", "description": "A unique identifier for vulnerability scan details", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update vulnerability manually.", "schema": { "$ref": "#/definitions/SystemScanVulnerabilitiesAndFindingsManualViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManualVulnerabilityViewModel" } } } }, "delete": { "tags": [ "Vulnerability scan reports" ], "summary": "Manually delete System Scan vulnerability. Manually means by no plug-in", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityScanDetailId", "description": "A unique identifier for vulnerability scan details", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/systemscans/{scanId}/reports/history/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/ScanReportHistoryFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[ScanReportHistoryListViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get the latest System Scan report as a file in specified format", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File type (docx, xml). The default format is xml", "type": "string" }, { "in": "query", "name": "withAuditorNotes", "description": "A flag that indicates whether auditor notes are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "onlyCVEandBUGTRAQ", "description": "A flag that indicates whether only CVE and BUGTRAQ are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "The latest System Scan report file in specified format" } }, "deprecated": true } }, "/api/integration/systemscans/{scanId}/reports/latest/download": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a presigned URL to download the latest System Scan report in specified format", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File type (docx, xml). The default format is xml", "type": "string" }, { "in": "query", "name": "withAuditorNotes", "description": "A flag that indicates whether auditor notes are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "onlyCVEandBUGTRAQ", "description": "A flag that indicates whether only CVE and BUGTRAQ are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "JSON response with download URL for the latest System Scan report", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/log": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a scan log", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Scan log view model" } }, "deprecated": true } }, "/api/integration/systemscans/{scanId}/reports/latest/log/download": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a presigned URL to download a scan log", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the log", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/ports": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get System Scan report ports info", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "System Scan report ports information", "schema": { "$ref": "#/definitions/Collection[ScanPortViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/ports/simple": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a list of latest ports for System Scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of latest ports for System Scan report", "schema": { "$ref": "#/definitions/Collection[ScanPortSimpleViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/simple": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get the latest System Scan report information", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "System Scan information", "schema": { "$ref": "#/definitions/SystemScanReportViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/statistics/scanhistory": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get counters for the System Scan history", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "ReportType", "description": "A report type", "required": true }, { "in": "query", "name": "StartPeriodDate", "description": "A start date for a period displayed on a report. If null, the date is set to -100 years", "type": "string", "format": "date-time" }, { "in": "query", "name": "EndPeriodDate", "description": "An end date for a period displayed on a report. If null, the date is set to +100 years", "type": "string", "format": "date-time" }, { "in": "query", "name": "ResultMessages", "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" }, "collectionFormat": "multi" }, { "in": "query", "name": "Language", "description": "A language in which the text is returned", "type": "string" }, { "in": "query", "name": "MessageLevel", "description": "A message level" }, { "in": "query", "name": "HttpStatusCode", "description": "A http status code" }, { "in": "query", "name": "Public", "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } ], "responses": { "200": { "description": "System Scan history counters", "schema": { "$ref": "#/definitions/Collection[ReportScanHistoryViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/statistics/status": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get System Scan vulnerability statistics by status", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A System Scan statistics", "schema": { "$ref": "#/definitions/ReportStatisticsVulnerabilityByStatusViewModel" } }, "204": { "description": "No Content" } } } }, "/api/integration/systemscans/{scanId}/reports/latest/statistics/vulnerability": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get counters for System Scan vulnerabilities and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Counters for System Scan vulnerabilities and findings", "schema": { "$ref": "#/definitions/ReportStatisticsVulnerabilityCountersViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/tags": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get vulnerability tags", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Vulnerability tags", "schema": { "$ref": "#/definitions/Collection[TagViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/tickets/simple": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a list of latest tickets for System Scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "onlyOpenTickets", "description": "A flag that indicates whether to return only open tickets", "type": "boolean" } ], "responses": { "200": { "description": "A simple list of latest tickets for System Scan report", "schema": { "$ref": "#/definitions/Collection[SimpleTicketViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/vulnerabilitiesandfindings/{vulnerabilityId}/detailed": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get detailed information on vulnerability and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Detailed information on vulnerability and findings", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/vulnerabilitiesandfindings/{vulnScanDetailID}/status": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Update the status of latest vulnerabilities and findings", "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnScanDetailID", "description": "A unique identifier for vulnerability details", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update status.", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/systemscans/{scanId}/reports/latest/vulnerabilitiesandfindings/aggregated/{tagTechnicalName}/detailed": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get aggregated vulnerabilities and findings details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "tagTechnicalName", "description": "A tag technical name", "required": true, "type": "string" }, { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Aggregated vulnerabilities and findings details", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsAggregatedDetailedViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/vulnerabilitiesandfindings/aggregated/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[IVulnerabilitiesAndFindingsBaseViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/vulnerabilitiesandfindings/counters": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get counters for System Scan latest report vulnerabilities and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Counters for System Scan vulnerabilities and findings", "schema": { "$ref": "#/definitions/Collection[ReportFindingsAndChangeViewModel]" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/vulnerabilitiesandfindings/grouped": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get the latest System Scan report on vulnerabilities and findings grouped by severity", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "The latest System Scan report on vulnerabilities and findings grouped by severity", "schema": { "$ref": "#/definitions/VulnerabilityDetailsGroupedViewModel" } } } } }, "/api/integration/systemscans/{scanId}/reports/latest/vulnerabilitiesandfindings/status": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Update the status of latest vulnerabilities and findings", "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update status.", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/systemscans/{scanId}/reports/latest/vulnerabilitiesandfindings/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilitiesAndFindingsViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get Web Scan report as a file in specified format", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File type (docx, xml)", "type": "string" }, { "in": "query", "name": "withAuditorNotes", "description": "A flag that indicates whether auditor notes are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "withExternalResources", "description": "A flag that indicates whether external resources are included in a report. The default value is 'false'", "type": "boolean", "default": false }, { "in": "query", "name": "withPrevReportVulns", "description": "A flag that indicates whether vulnerabilities from a previous report are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "Web Scan report file in specified format" } }, "deprecated": true } }, "/api/integration/webscans/{scanId}/reports/{reportId}/discovered/pages": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get discovered pages", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A structure for discovered pages", "schema": { "$ref": "#/definitions/DiscoveredPagesViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/download": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a presigned URL to download a Web Scan report in specified format", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File type (docx, xml)", "type": "string" }, { "in": "query", "name": "withAuditorNotes", "description": "A flag that indicates whether auditor notes are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "withExternalResources", "description": "A flag that indicates whether external resources are included in a report. The default value is 'false'", "type": "boolean", "default": false }, { "in": "query", "name": "withPrevReportVulns", "description": "A flag that indicates whether vulnerabilities from a previous report are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the report", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/log": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a scan log", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Scan log view model" } }, "deprecated": true } }, "/api/integration/webscans/{scanId}/reports/{reportId}/log/download": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a presigned URL to download a scan log", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the log", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/simple": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get Web Scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A Web Scan report", "schema": { "$ref": "#/definitions/WebScanReportViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/statistics/scanhistory": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get Web Scan history data", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "ReportType", "description": "A report type", "required": true }, { "in": "query", "name": "StartPeriodDate", "description": "A start date for a period displayed on a report. If null, the date is set to -100 years", "type": "string", "format": "date-time" }, { "in": "query", "name": "EndPeriodDate", "description": "An end date for a period displayed on a report. If null, the date is set to +100 years", "type": "string", "format": "date-time" }, { "in": "query", "name": "ResultMessages", "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" }, "collectionFormat": "multi" }, { "in": "query", "name": "Language", "description": "A language in which the text is returned", "type": "string" }, { "in": "query", "name": "MessageLevel", "description": "A message level" }, { "in": "query", "name": "HttpStatusCode", "description": "A http status code" }, { "in": "query", "name": "Public", "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string" } ], "responses": { "200": { "description": "Web Scan history counters", "schema": { "$ref": "#/definitions/Collection[ReportScanHistoryViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/statistics/status": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get counters for Web Scan vulnerabilities by status", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Counters for Web Scan vulnerabilities", "schema": { "$ref": "#/definitions/ReportStatisticsVulnerabilityByStatusViewModel" } }, "204": { "description": "No Content" } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/statistics/vulnerabilitiesandfindings": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get Web Scans vulnerabilities and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Counters for Web Scan vulnerabilities and findings", "schema": { "$ref": "#/definitions/Collection[ReportFindingsAndChangeViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/tickets/simple": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get tickets for Web Scan reports", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of ticket parameters: unique identifier, name", "schema": { "$ref": "#/definitions/Collection[SimpleTicketViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/{vulnerabilityId}/detailed": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get vulnerability instance details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Details of vulnerability instance", "schema": { "$ref": "#/definitions/WebScanVulnerabilitiesAndFindingsDetailedViewModel" } }, "204": { "description": "No Content" } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/{webscanVulnScanDetailId}/status": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Update vulnerability status", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "webScanVulnScanDetailId", "description": "A unique identifier for Web Scan vulnerability scan details", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update vulnerability", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" } } ], "responses": { "200": { "description": "Update status", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/categories": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a list of Web Scans with a counter of contained scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to filter Web Scan results.", "schema": { "$ref": "#/definitions/WebScanReportFilterModel" } } ], "responses": { "200": { "description": "A list of WebScansListViewModel objects", "schema": { "$ref": "#/definitions/WebScanReportCategoryListViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/filter/categories": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a list of categories for Web Scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of categories", "schema": { "$ref": "#/definitions/Collection[WebScanReportVulnerabilityCategoryViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/grouped": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get Web Scan grouped information", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Web Scan grouped information", "schema": { "$ref": "#/definitions/WebScanReportGroupedViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/manual": { "post": { "tags": [ "Vulnerability scan reports" ], "summary": "Manaully add Web Scan vulnerability. Manually means by no plug-in", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to add vulnerability manually.", "schema": { "$ref": "#/definitions/WebScanVulnerabilitiesAndFindingsManualViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManualVulnerabilityViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/status": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Update the Web Scan vulnerability and category status", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update vulnerability", "schema": { "$ref": "#/definitions/WebScanReportUpdateStatusesViewModel" } } ], "responses": { "200": { "description": "Update status", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/vulnerabilitiesandfindings/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/WebScanReportFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[WebScanReportVulnerabilityViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/{reportId}/vulnerabilityscandetail/{vulnerabilityscandetailid}/vulnerabilitiesandfindings/manual": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Manually update Web Scan vulnerability. Manually means by no plug-in", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityScanDetailId", "description": "A unique identifier for vulnerability scan details", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update vulnerability manually.", "schema": { "$ref": "#/definitions/WebScanVulnerabilitiesAndFindingsManualViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManualVulnerabilityViewModel" } } } }, "delete": { "tags": [ "Vulnerability scan reports" ], "summary": "Manually delete Web Scan vulnerability. Manually means by no plug-in", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityScanDetailId", "description": "A unique identifier for vulnerability scan details", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/webscans/{scanId}/reports/history/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/ScanReportHistoryFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[ScanReportHistoryListViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/latest": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get Web Scan report as a file in specified format", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File type (docx, xml)", "type": "string" }, { "in": "query", "name": "withAuditorNotes", "description": "A flag that indicates whether auditor notes are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "withExternalResources", "description": "A flag that indicates whether external resources are included in a report. The default value is 'false'", "type": "boolean", "default": false }, { "in": "query", "name": "withPrevReportVulns", "description": "A flag that indicates whether vulnerabilities from a previous report are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "The latest Web Scan report file in specified format" } }, "deprecated": true } }, "/api/integration/webscans/{scanId}/reports/latest/discovered/pages": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get discovered pages", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A structure for discovered pages", "schema": { "$ref": "#/definitions/DiscoveredPagesViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/download": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a presigned URL to download the latest Web Scan report in specified format", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File type (docx, xml)", "type": "string" }, { "in": "query", "name": "withAuditorNotes", "description": "A flag that indicates whether auditor notes are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "withExternalResources", "description": "A flag that indicates whether external resources are included in a report. The default value is 'false'", "type": "boolean", "default": false }, { "in": "query", "name": "withPrevReportVulns", "description": "A flag that indicates whether vulnerabilities from a previous report are included in a report. The default value is 'true'", "type": "boolean", "default": true }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the report", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/log": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a scan log", "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Scan log view model" } }, "deprecated": true } }, "/api/integration/webscans/{scanId}/reports/latest/log/download": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a presigned URL to download a scan log", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the log", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/simple": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get Web Scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A Web Scan report", "schema": { "$ref": "#/definitions/WebScanReportViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/statistics/scanhistory": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get Web Scan history data", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "ReportType", "description": "A report type", "required": true }, { "in": "query", "name": "StartPeriodDate", "description": "A start date for a period displayed on a report. If null, the date is set to -100 years", "type": "string", "format": "date-time" }, { "in": "query", "name": "EndPeriodDate", "description": "An end date for a period displayed on a report. If null, the date is set to +100 years", "type": "string", "format": "date-time" }, { "in": "query", "name": "ResultMessages", "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" }, "collectionFormat": "multi" }, { "in": "query", "name": "Language", "description": "A language in which the text is returned", "type": "string" }, { "in": "query", "name": "MessageLevel", "description": "A message level" }, { "in": "query", "name": "HttpStatusCode", "description": "A http status code" }, { "in": "query", "name": "Public", "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } ], "responses": { "200": { "description": "Web Scan history counters", "schema": { "$ref": "#/definitions/Collection[ReportScanHistoryViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/statistics/status": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get counters for Web Scan vulnerabilities by status", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Counters for Web Scan vulnerabilities", "schema": { "$ref": "#/definitions/ReportStatisticsVulnerabilityByStatusViewModel" } }, "204": { "description": "No Content" } } } }, "/api/integration/webscans/{scanId}/reports/latest/statistics/vulnerabilitiesandfindings": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get Web Scans vulnerabilities and findings", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Counters for Web Scan vulnerabilities and findings", "schema": { "$ref": "#/definitions/Collection[ReportFindingsAndChangeViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/tickets/simple": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get tickets for Web Scan reports", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of ticket parameters: unique identifier, name", "schema": { "$ref": "#/definitions/Collection[SimpleTicketViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/vulnerabilitiesandfindings/{vulnerabilityId}/detailed": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get vulnerability instance details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Details of vulnerability instance", "schema": { "$ref": "#/definitions/WebScanVulnerabilitiesAndFindingsDetailedViewModel" } }, "204": { "description": "No Content" } } } }, "/api/integration/webscans/{scanId}/reports/latest/vulnerabilitiesandfindings/{webscanVulnScanDetailId}/status": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Update vulnerability status", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "webScanVulnScanDetailId", "description": "A unique identifier for Web Scan vulnerability scan details", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update vulnerability", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" } } ], "responses": { "200": { "description": "Update status", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/vulnerabilitiesandfindings/categories": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a list of Web Scans with a counter of contained scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to filter Web Scan results.", "schema": { "$ref": "#/definitions/WebScanReportFilterModel" } } ], "responses": { "200": { "description": "A list of WebScansListViewModel objects", "schema": { "$ref": "#/definitions/WebScanReportCategoryListViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/vulnerabilitiesandfindings/filter/categories": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a list of categories for Web Scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of categories", "schema": { "$ref": "#/definitions/Collection[WebScanReportVulnerabilityCategoryViewModel]" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/vulnerabilitiesandfindings/grouped": { "get": { "tags": [ "Vulnerability scan reports" ], "summary": "Get Web Scan grouped information", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Web Scan grouped information", "schema": { "$ref": "#/definitions/WebScanReportGroupedViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/vulnerabilitiesandfindings/status": { "put": { "tags": [ "Vulnerability scan reports" ], "summary": "Update the Web Scan vulnerability and category status", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update vulnerability", "schema": { "$ref": "#/definitions/WebScanReportUpdateStatusesViewModel" } } ], "responses": { "200": { "description": "Update status", "schema": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" } } } } }, "/api/integration/webscans/{scanId}/reports/latest/vulnerabilitiesandfindings/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerability scan reports" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "scanId", "description": "A unique identifier for a scan", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/WebScanReportFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[WebScanReportVulnerabilityViewModel]" } } } } }, "/api/integration/discoveryscans/{discoveryId}/reports/{reportId}": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get a discovery scan report as a file in a specified format", "parameters": [ { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File format (xml or xslx)", "type": "string" }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "A discovery scan report file in a specified format" } }, "deprecated": true } }, "/api/integration/discoveryscans/{discoveryId}/reports/{reportId}/download": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get a presigned URL to download a discovery scan report in a specified format", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File format (xml or xlsx)", "type": "string" }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the report", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/discoveryscans/{discoveryId}/reports/{reportId}/ports": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get list of ports for a discovery scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "previousReportId", "description": "A unique identifier of a previous discovery scan report", "type": "string", "format": "uuid" }, { "in": "query", "name": "sortBy", "description": "Parameter to sort by fields", "type": "string" }, { "in": "query", "name": "direction", "description": "Sort direction", "type": "string", "default": "desc" } ], "responses": { "200": { "description": "Information about the discovery scan ports", "schema": { "$ref": "#/definitions/DiscoveryScanOverviewViewModel" } } } } }, "/api/integration/discoveryscans/{discoveryId}/reports/{reportId}/simple": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get discovery scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "discovery scan report", "schema": { "$ref": "#/definitions/DiscoveryScanReportViewModel" } } } } }, "/api/integration/discoveryscans/{discoveryId}/reports/latest": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get a discovery scan report as a file in a specified format", "parameters": [ { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File format (xml or xslx)", "type": "string" }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "A discovery scan report file in a specified format" } }, "deprecated": true } }, "/api/integration/discoveryscans/{discoveryId}/reports/latest/download": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get a presigned URL to download a discovery scan report in a specified format", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" }, { "in": "query", "name": "fileType", "description": "File format (xml or xlsx)", "type": "string" }, { "in": "query", "name": "localization", "description": "An optional localization parameter. The default value is 'en_US'" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the report", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/discoveryscans/{discoveryId}/reports/latest/ports": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get list of ports for a discovery scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" }, { "in": "query", "name": "previousReportId", "description": "A unique identifier of a previous discovery scan report", "type": "string", "format": "uuid" }, { "in": "query", "name": "sortBy", "description": "Parameter to sort by fields", "type": "string" }, { "in": "query", "name": "direction", "description": "Sort direction", "type": "string", "default": "desc" } ], "responses": { "200": { "description": "Information about the discovery scan ports", "schema": { "$ref": "#/definitions/DiscoveryScanOverviewViewModel" } } } } }, "/api/integration/discoveryscans/{discoveryId}/reports/latest/simple": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get discovery scan report", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "discovery scan report", "schema": { "$ref": "#/definitions/DiscoveryScanReportViewModel" } } } } }, "/api/integration/discoveryscans/{discoveryScanId}/reports/{reportId}/log": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get the most recent discovery scan log", "parameters": [ { "in": "path", "name": "discoveryScanId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/integration/discoveryscans/{discoveryScanId}/reports/{reportId}/log/download": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get a presigned URL to download the most recent discovery scan log", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryScanId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/discoveryscans/{discoveryScanId}/reports/latest/log": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get the most recent discovery scan log", "parameters": [ { "in": "path", "name": "discoveryScanId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/integration/discoveryscans/{discoveryScanId}/reports/latest/log/download": { "get": { "tags": [ "Discovery scan reports" ], "summary": "Get a presigned URL to download the most recent discovery scan log", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "discoveryScanId", "description": "A discovery scan unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/reports/scheduled/assets/count": { "get": { "tags": [ "Scheduled summary reports" ], "summary": "Gets a total amount of assets", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "Text", "type": "string" }, { "in": "query", "name": "InternetExposure", "type": "boolean" }, { "in": "query", "name": "TagsOneOf", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TagsAllOf", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "OnlyWithoutAnyAssetTag", "type": "boolean" }, { "in": "query", "name": "OnlyWithAssetTags", "type": "boolean" }, { "in": "query", "name": "IsExploitable", "type": "boolean" }, { "in": "query", "name": "Severity", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "ExcludeHigherSeverity", "type": "boolean" }, { "in": "query", "name": "Importance", "type": "integer", "format": "int32" }, { "in": "query", "name": "RiskScore", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScanGroups", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "LastExecutedSourceType" }, { "in": "query", "name": "Archived", "type": "boolean" }, { "in": "query", "name": "AssetBasicFields", "type": "array", "items": { "$ref": "#/definitions/FilterBasicFieldWithScanned[AssetBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/reports/scheduled/autorefreshdata/withtoken/{pageSize}": { "get": { "tags": [ "Scheduled summary reports" ], "summary": "Refreshes reports data every specified seconds", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "token", "description": "Pagination token", "type": "string" }, { "in": "query", "name": "ReportName", "description": "A report name", "type": "string" }, { "in": "query", "name": "HasNoSortingField", "description": "A flag that indicates no sorting field. It is set to true", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ScheduledSummaryReportsListViewModel" } } } } } }, "/api/integration/reports/scheduled/autorefreshdata/withtoken/{pageSize}/{token}": { "get": { "tags": [ "Scheduled summary reports" ], "summary": "Refreshes reports data every specified seconds", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "token", "description": "Pagination token", "required": true, "type": "string" }, { "in": "query", "name": "ReportName", "description": "A report name", "type": "string" }, { "in": "query", "name": "HasNoSortingField", "description": "A flag that indicates no sorting field. It is set to true", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ScheduledSummaryReportsListViewModel" } } } } } }, "/api/integration/reports/scheduled/default": { "get": { "tags": [ "Scheduled summary reports" ], "summary": "Get default summary report filter", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SummaryReportFilter" } } } } }, "/api/integration/reports/scheduled/scans/count": { "get": { "tags": [ "Scheduled summary reports" ], "summary": "Gets a scans count based on provided tags", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "groupIds", "description": "Scan groups that scans belongs to", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "tags", "description": "", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "tagOperator", "description": "", "type": "integer", "format": "int32" }, { "in": "query", "name": "filterAssets", "description": "", "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FilteredScansCountViewModel" } } } } }, "/api/integration/reports/scheduled/supportedlanguages": { "get": { "tags": [ "Scheduled summary reports" ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/definitions/LocalizationEnum" } } } } } }, "/api/integration/reports/scheduled/tasks": { "post": { "tags": [ "Scheduled summary reports" ], "summary": "Creates report task definition based on informations provided in model", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Task parameters", "schema": { "$ref": "#/definitions/TaskDefinitionCreateModel" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Scheduled summary reports" ], "summary": "Deletes particular task by its id", "parameters": [ { "in": "query", "name": "taskIds", "description": "Task id", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/reports/scheduled/tasks/{taskId}": { "get": { "tags": [ "Scheduled summary reports" ], "summary": "Gets a single task definition details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "taskId", "description": "Task unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScheduledSummaryReportUpdateViewModel" } } } }, "put": { "tags": [ "Scheduled summary reports" ], "summary": "Updates existing task", "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "taskId", "description": "Task id", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Model with updated properties", "schema": { "$ref": "#/definitions/TaskDefinitionCreateModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/reports/scheduled/tasks/{taskId}/activate": { "put": { "tags": [ "Scheduled summary reports" ], "summary": "Toggles task activation", "parameters": [ { "in": "path", "name": "taskId", "description": "Task unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "active", "description": "Flag indicating whether this task should be active or not", "type": "boolean" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/reports/scheduled/tasks/{taskId}/reports": { "get": { "tags": [ "Scheduled summary reports" ], "summary": "Gets list of reports for particular task definition", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "taskId", "description": "Task id", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskReportsResponse" } } } }, "post": { "tags": [ "Scheduled summary reports" ], "summary": "Generates new report instance for specified task", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "taskId", "description": "Task", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScheduledSummaryReportsListViewModel" } } } } }, "/api/integration/reports/scheduled/tasks/any": { "get": { "tags": [ "Scheduled summary reports" ], "summary": "Get information if there are any reports defined within the current organization", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/api/integration/reports/scheduled/tasks/batch/generate": { "post": { "tags": [ "Scheduled summary reports" ], "summary": "Generates new report instances for specified tasks", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Task ids", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ScheduledSummaryReportsListViewModel" } } } } } }, "/api/integration/reports/scheduled/tasks/clone": { "post": { "tags": [ "Scheduled summary reports" ], "summary": "Generates a new report instances for specified tasks", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/SummaryReportRegenerateViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/reports/scheduled/tasks/reports/{reportId}/download": { "get": { "tags": [ "Scheduled summary reports" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "format" }, { "in": "query", "name": "jsonResponse", "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/api/integration/reports/scheduled/tasks/reports/{reportId}/formats": { "get": { "tags": [ "Scheduled summary reports" ], "summary": "Gets a list of available report formats to download", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "reportId", "description": "A unique identifier for a report", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/api/integration/reports/scheduled/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Scheduled summary reports" ], "summary": "Get a paged list of summary reports", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/SummaryReportsFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[ScheduledSummaryReportsListViewModel]" } } } } }, "/api/integration/reports/scheduled/withtoken/{pageSize}": { "post": { "tags": [ "Scheduled summary reports" ], "summary": "Gets paged data based on provided pagination token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "token", "description": "Pagination token", "type": "string" }, { "in": "body", "name": "body", "description": "Summary reports filter for grid.", "schema": { "$ref": "#/definitions/SummaryReportsFilterModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedData[ScheduledSummaryReportsListViewModel]" } } } } }, "/api/integration/reports/scheduled/withtoken/{pageSize}/{token}": { "post": { "tags": [ "Scheduled summary reports" ], "summary": "Gets paged data based on provided pagination token", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "token", "description": "Pagination token", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Summary reports filter for grid.", "schema": { "$ref": "#/definitions/SummaryReportsFilterModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PagedData[ScheduledSummaryReportsListViewModel]" } } } } }, "/api/integration/vulnerabilities/any": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get information if any vulnerabilities are found within the current organization", "produces": [ "application/json" ], "responses": { "200": { "description": "True if there are any vulnerabilities found within current organization", "schema": { "type": "boolean" } } } } }, "/api/integration/vulnerabilities/grouped": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get summary information about discovery scans", "produces": [ "application/json" ], "responses": { "200": { "description": "Summary information about discovery scans", "schema": { "$ref": "#/definitions/VulnerabilityListSummaryViewModel" } } } } }, "/api/integration/vulnerabilities/grouped/{periodType}/changes/count": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get number of vulnerabilities changes grouped by severity for given filter", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "periodType", "description": "A period type", "required": true }, { "in": "query", "name": "scanGroupIds", "description": "A list of Scan Group unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "withAverageSeverity", "description": "", "type": "boolean", "default": false } ], "responses": { "200": { "description": "Number of changes to vulnerabilities, grouped by severity for a given filter", "schema": { "$ref": "#/definitions/VulnerabilitiesChangesViewModel" } } } } }, "/api/integration/vulnerabilities/grouped/severity/count": { "put": { "tags": [ "Vulnerabilities" ], "summary": "Get the number of vulnerabilities that are grouped based on the severity for a given filter", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A filter for the results", "schema": { "$ref": "#/definitions/VulnerabilityFilterViewModel" } } ], "responses": { "200": { "description": "Number of vulnerabilities grouped by severity for the given filter", "schema": { "$ref": "#/definitions/NumberOfVulnerabilityDefinitionsViewModel" } } } } }, "/api/integration/vulnerabilities/grouped/statuses/count": { "put": { "tags": [ "Vulnerabilities" ], "summary": "Get number of vulnerabilities grouped by status for the given filter", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A filter for the results", "schema": { "$ref": "#/definitions/VulnerabilityFilterViewModel" } } ], "responses": { "200": { "description": "Number of vulnerabilities grouped by status for the given filter", "schema": { "$ref": "#/definitions/Collection[NameValueItem[Int32]]" } } } } }, "/api/integration/vulnerabilities/grouped/systemscan/categories/count": { "put": { "tags": [ "Vulnerabilities" ], "summary": "Get number of System Scan vulnerabilities grouped by category for the given filter", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A filter for the results", "schema": { "$ref": "#/definitions/VulnerabilityFilterViewModel" } } ], "responses": { "200": { "description": "Number of System Scan vulnerabilities grouped by category for the given filter", "schema": { "$ref": "#/definitions/Collection[NumberOfVulnerabilityByCategoryViewModel]" } } } } }, "/api/integration/vulnerabilities/grouped/webscan/categories/count": { "put": { "tags": [ "Vulnerabilities" ], "summary": "Get number of Web Scan vulnerabilities grouped by category for the given filter", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A filter for the results", "schema": { "$ref": "#/definitions/VulnerabilityFilterViewModel" } } ], "responses": { "200": { "description": "A number of Web Scan vulnerabilities grouped by category for the given filter", "schema": { "$ref": "#/definitions/Collection[NumberOfVulnerabilityByCategoryViewModel]" } } } } }, "/api/integration/vulnerabilities/plugins/{cve}": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get list of Plugins for given CVE", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "cve", "description": "CVE identifier", "required": true, "type": "string" }, { "in": "query", "name": "includeDescriptions", "description": "Determine if to include Descriptions in the response", "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/VulnerabilityPluginDetailsViewModel" } } } } } }, "/api/integration/vulnerabilities/reference/types": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get dictionary of possible vulnerability reference types", "produces": [ "application/json" ], "responses": { "200": { "description": "Dictionary of vulnerability reference types", "schema": { "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } } } } } }, "/api/integration/vulnerabilities/status": { "put": { "tags": [ "Vulnerabilities" ], "summary": "Update status, auditor note, and potential fields of System Scan and Web Scan vulnerability instances", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters for updating the status of scan instances", "schema": { "$ref": "#/definitions/VulnerabilitiesListUpdateStatusesViewModel" } } ], "responses": { "200": { "description": "List of updated scan instances", "schema": { "$ref": "#/definitions/VulnerabilitiesListUpdatedViewModel" } } } } }, "/api/integration/vulnerabilities/statuses": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a list of vulnerability statuses", "produces": [ "application/json" ], "responses": { "200": { "description": "List of vulnerability statuses", "schema": { "$ref": "#/definitions/Collection[VulnerabilityStatuses]" } } } } }, "/api/integration/vulnerabilities/systemscan/{id}/detailed": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get details of System Scan vulnerability", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "A vulnerability unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "System Scan vulnerability details", "schema": { "$ref": "#/definitions/VulnerabilitiesListSystemScanDetailsViewModel" } } } } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedassets/csv": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get affected assets as CSV file", "parameters": [ { "in": "query", "name": "VulnerabilityId", "description": "Vulnerability unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "ExcludePotential", "description": "Exclude potential vulnerabilities", "type": "boolean" }, { "in": "query", "name": "ScanTagsOneOf", "description": "Tags included in scan. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ScanTagsAllOf", "description": "Tags included in scan. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[TargetRelatedBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "Archived", "description": "A flag indicating that filtered items will contain also archived assets. By default only non archived assets are returned", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" } ], "responses": { "200": { "description": "An affected host csv file" } }, "deprecated": true } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedassets/csv/download": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a presigned URL to download affected assets as CSV file", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "VulnerabilityId", "description": "Vulnerability unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "ExcludePotential", "description": "Exclude potential vulnerabilities", "type": "boolean" }, { "in": "query", "name": "ScanTagsOneOf", "description": "Tags included in scan. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ScanTagsAllOf", "description": "Tags included in scan. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[TargetRelatedBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "Archived", "description": "A flag indicating that filtered items will contain also archived assets. By default only non archived assets are returned", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the CSV file", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedassets/status": { "put": { "tags": [ "Vulnerabilities" ], "summary": "Update status of vulnerabilities", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "scanId", "description": "A unique identifier for a scan", "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Update parameters.", "schema": { "$ref": "#/definitions/VulnerabilitiesDetailsListUpdateStatusesViewModel" } } ], "responses": { "200": { "description": "A list with updated vulnerabilities", "schema": { "$ref": "#/definitions/VulnerabilitiesListUpdatedViewModel" } } } } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedassets/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerabilities" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/AffectedAssetsFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilityAffectedAssetsViewModel]" } } } } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedtargets/csv": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get affected hosts as csv file", "parameters": [ { "in": "query", "name": "VulnerabilityId", "description": "Vulnerability unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "ScanGroupIds", "description": "IDs of scan groups to search for affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "ExcludePotential", "description": "Exclude potential vulnerabilities", "type": "boolean" }, { "in": "query", "name": "ScanTagsOneOf", "description": "Tags included in scan. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ScanTagsAllOf", "description": "Tags included in scan. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[TargetRelatedBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" } ], "responses": { "200": { "description": "An affected host csv file" } }, "deprecated": true } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedtargets/csv/download": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a presigned URL to download affected hosts as csv file", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "VulnerabilityId", "description": "Vulnerability unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "ScanGroupIds", "description": "IDs of scan groups to search for affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "ExcludePotential", "description": "Exclude potential vulnerabilities", "type": "boolean" }, { "in": "query", "name": "ScanTagsOneOf", "description": "Tags included in scan. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ScanTagsAllOf", "description": "Tags included in scan. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[TargetRelatedBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the CSV file", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedtargets/grouped/csv": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get grouped System Scan vulnerabilities as csv file", "parameters": [ { "in": "query", "name": "VulnerabilityId", "description": "Vulnerability unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "ScanGroupIds", "description": "IDs of scan groups to search for affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "ExcludePotential", "description": "Exclude potential vulnerabilities", "type": "boolean" }, { "in": "query", "name": "ScanTagsOneOf", "description": "Tags included in scan. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ScanTagsAllOf", "description": "Tags included in scan. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[TargetRelatedBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" } ], "responses": { "200": { "description": "A csv file with grouped vulnerabilities" } }, "deprecated": true } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedtargets/grouped/csv/download": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a presigned URL to download grouped System Scan vulnerabilities as csv file", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "VulnerabilityId", "description": "Vulnerability unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "ScanGroupIds", "description": "IDs of scan groups to search for affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "ExcludePotential", "description": "Exclude potential vulnerabilities", "type": "boolean" }, { "in": "query", "name": "ScanTagsOneOf", "description": "Tags included in scan. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ScanTagsAllOf", "description": "Tags included in scan. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[TargetRelatedBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the CSV file", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedtargets/grouped/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerabilities" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/AffectedHostsFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilityAffectedHostsGroupedViewModel]" } } } } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedtargets/status": { "put": { "tags": [ "Vulnerabilities" ], "summary": "Update status of vulnerabilities", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "scanId", "description": "A unique identifier for a scan", "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Update parameters.", "schema": { "$ref": "#/definitions/VulnerabilitiesDetailsListUpdateStatusesViewModel" } } ], "responses": { "200": { "description": "A list with updated vulnerabilities", "schema": { "$ref": "#/definitions/VulnerabilitiesListUpdatedViewModel" } } } } }, "/api/integration/vulnerabilities/systemscan/{vulnerabilityId}/affectedtargets/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerabilities" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/AffectedHostsFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilityAffectedHostsViewModel]" } } } } }, "/api/integration/vulnerabilities/systemscan/families": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a list of System Scan families", "produces": [ "application/json" ], "responses": { "200": { "description": "A list of System Scan families", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityCategoryIdOrManualId}/{pluginId}/detailed": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get details for Web Scan vulnerability", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "vulnerabilityCategoryIdOrManualId", "description": "A vulnerability category unique identifier or manual finding unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "pluginId", "description": "Web Scan vulnerability plugin identifier", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Details for Web Scan vulnerability", "schema": { "$ref": "#/definitions/VulnerabilitiesListWebScanDetailsViewModel" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityCategoryIdOrManualId}/detailed": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get details for Web Scan vulnerability", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "vulnerabilityCategoryIdOrManualId", "description": "A vulnerability category unique identifier or manual finding unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Details for Web Scan vulnerability", "schema": { "$ref": "#/definitions/VulnerabilitiesListWebScanDetailsViewModel" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/{pluginId}/affectedtargets/csv": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get grouped Web Scan vulnerabilities as csv file", "parameters": [ { "in": "query", "name": "VulnerabilityCategoryId", "description": "Vulnerability category unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "WsPluginId", "description": "ID of Web Scan plug-in which reported the vulnerability instance", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScanGroupIds", "description": "Scan group unique identifiers to search affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityCategoryIds", "description": "Web Scan categories unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[AffectedSiteBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "path", "name": "pluginId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A csv file with grouped Web Scan vulnerabilities" } }, "deprecated": true } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/{pluginId}/affectedtargets/csv/download": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a presigned URL to download grouped Web Scan vulnerabilities as csv file", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "VulnerabilityCategoryId", "description": "Vulnerability category unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "WsPluginId", "description": "ID of Web Scan plug-in which reported the vulnerability instance", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScanGroupIds", "description": "Scan group unique identifiers to search affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityCategoryIds", "description": "Web Scan categories unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[AffectedSiteBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "path", "name": "pluginId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the CSV file", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/{pluginId}/affectedtargets/grouped/csv": { "get": { "tags": [ "Vulnerabilities" ], "summary": "A grouped cvs file of Web Scan vulnerabilities", "parameters": [ { "in": "query", "name": "VulnerabilityCategoryId", "description": "Vulnerability category unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "WsPluginId", "description": "ID of Web Scan plug-in which reported the vulnerability instance", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScanGroupIds", "description": "Scan group unique identifiers to search affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityCategoryIds", "description": "Web Scan categories unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[AffectedSiteBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "path", "name": "pluginId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A csv file with grouped vulnerabilities" } }, "deprecated": true } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/{pluginId}/affectedtargets/grouped/csv/download": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a presigned URL to download a grouped csv file of Web Scan vulnerabilities", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "VulnerabilityCategoryId", "description": "Vulnerability category unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "WsPluginId", "description": "ID of Web Scan plug-in which reported the vulnerability instance", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScanGroupIds", "description": "Scan group unique identifiers to search affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityCategoryIds", "description": "Web Scan categories unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[AffectedSiteBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "path", "name": "pluginId", "required": true, "type": "string" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the CSV file", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/{pluginId}/affectedtargets/grouped/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerabilities" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "path", "name": "pluginId", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/AffectedSitesFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilityAffectedSitesGroupedViewModel]" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/{pluginId}/affectedtargets/status": { "put": { "tags": [ "Vulnerabilities" ], "summary": "Update status of vulnerabilities", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "scanId", "description": "A unique identifier for a scan", "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "path", "name": "pluginId", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Update parameters.", "schema": { "$ref": "#/definitions/VulnerabilitiesDetailsListUpdateStatusesViewModel" } } ], "responses": { "200": { "description": "A list with updated vulnerability instances", "schema": { "$ref": "#/definitions/VulnerabilitiesListUpdatedViewModel" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/{pluginId}/affectedtargets/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerabilities" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "path", "name": "pluginId", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/AffectedSitesFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilityAffectedSitesViewModel]" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/affectedtargets/csv": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get grouped Web Scan vulnerabilities as csv file", "parameters": [ { "in": "query", "name": "VulnerabilityCategoryId", "description": "Vulnerability category unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "WsPluginId", "description": "ID of Web Scan plug-in which reported the vulnerability instance", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScanGroupIds", "description": "Scan group unique identifiers to search affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityCategoryIds", "description": "Web Scan categories unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[AffectedSiteBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" } ], "responses": { "200": { "description": "A csv file with grouped Web Scan vulnerabilities" } }, "deprecated": true } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/affectedtargets/csv/download": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a presigned URL to download grouped Web Scan vulnerabilities as csv file", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "VulnerabilityCategoryId", "description": "Vulnerability category unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "WsPluginId", "description": "ID of Web Scan plug-in which reported the vulnerability instance", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScanGroupIds", "description": "Scan group unique identifiers to search affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityCategoryIds", "description": "Web Scan categories unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[AffectedSiteBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the CSV file", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/affectedtargets/grouped/csv": { "get": { "tags": [ "Vulnerabilities" ], "summary": "A grouped cvs file of Web Scan vulnerabilities", "parameters": [ { "in": "query", "name": "VulnerabilityCategoryId", "description": "Vulnerability category unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "WsPluginId", "description": "ID of Web Scan plug-in which reported the vulnerability instance", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScanGroupIds", "description": "Scan group unique identifiers to search affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityCategoryIds", "description": "Web Scan categories unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[AffectedSiteBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" } ], "responses": { "200": { "description": "A csv file with grouped vulnerabilities" } }, "deprecated": true } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/affectedtargets/grouped/csv/download": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a presigned URL to download a grouped csv file of Web Scan vulnerabilities", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "VulnerabilityCategoryId", "description": "Vulnerability category unique identifier", "type": "string", "format": "uuid" }, { "in": "query", "name": "WsPluginId", "description": "ID of Web Scan plug-in which reported the vulnerability instance", "type": "integer", "format": "int32" }, { "in": "query", "name": "ScanGroupIds", "description": "Scan group unique identifiers to search affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityCategoryIds", "description": "Web Scan categories unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "VulnerabilityStatusIds", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" }, { "in": "query", "name": "TargetRelatedBasicFields", "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[AffectedSiteBasicFieldEnum]" }, "collectionFormat": "multi" }, { "in": "query", "name": "ShowAllOpenStatuses", "type": "boolean" }, { "in": "query", "name": "ShowAllStatuses", "type": "boolean" }, { "in": "query", "name": "DefaultFilter", "description": "... a default filter", "type": "boolean" }, { "in": "query", "name": "SortPrimary", "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortPrimaryByDesc", "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "SortSecondary", "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, { "in": "query", "name": "SortSecondaryByDesc", "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, { "in": "query", "name": "Flags", "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the CSV file", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/affectedtargets/grouped/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerabilities" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/AffectedSitesFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilityAffectedSitesGroupedViewModel]" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/affectedtargets/status": { "put": { "tags": [ "Vulnerabilities" ], "summary": "Update status of vulnerabilities", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "scanId", "description": "A unique identifier for a scan", "type": "string", "format": "uuid" }, { "in": "query", "name": "reportId", "description": "A unique identifier for a report", "type": "string", "format": "uuid" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Update parameters.", "schema": { "$ref": "#/definitions/VulnerabilitiesDetailsListUpdateStatusesViewModel" } } ], "responses": { "200": { "description": "A list with updated vulnerability instances", "schema": { "$ref": "#/definitions/VulnerabilitiesListUpdatedViewModel" } } } } }, "/api/integration/vulnerabilities/webscan/{vulnerabilityId}/affectedtargets/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerabilities" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "vulnerabilityId", "description": "A unique identifier for vulnerabilities", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/AffectedSitesFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilityAffectedSitesViewModel]" } } } } }, "/api/integration/vulnerabilities/webscan/categories": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a list of Web Scan vulnerability categories", "produces": [ "application/json" ], "responses": { "200": { "description": "A list of Web Scan vulnerability categories", "schema": { "$ref": "#/definitions/Collection[VulnerabilityCategoryViewModel]" } } } } }, "/api/integration/vulnerabilities/webscan/categories/simple": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a simple list of Web Scan categories", "produces": [ "application/json" ], "responses": { "200": { "description": "A simple list of Web Scan categories", "schema": { "$ref": "#/definitions/Collection[WebScanVulnerabilityCategory]" } } } } }, "/api/integration/vulnerabilities/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerabilities" ], "summary": "Get a paged list of vulnerabilities", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilityFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilitiesListViewModel]" } } } } }, "/api/integration/vulnerabilitiescoverage/grouped": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get summary information about vulnerability coverage", "produces": [ "application/json" ], "responses": { "200": { "description": "Summary information about vulnerability coverage", "schema": { "$ref": "#/definitions/VulnerabilityListSummaryViewModel" } } } } }, "/api/integration/vulnerabilitiescoverage/reference/types": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a list of already-existing vulnerability reference types for vulnerability references", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "searchPhrase", "description": "A string that limits vulnerability types in search", "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/api/integration/vulnerabilitiescoverage/simple": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get simple (Id, Name, PluginId) vulnerabilities info by search phrase.\nSearch take into account both name and plugin id (integer). During the search, name is taken with wildcard but plugin id is taken strictly", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "searchPhrase", "description": "Vulnerability name (or its part) or plugin id (int)", "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/VulnerabilityCoverageSimpleViewModel" } } } } } }, "/api/integration/vulnerabilitiescoverage/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Vulnerabilities" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilityCoverageFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[VulnerabilitiesCoverageListViewModel]" } } } } }, "/api/integration/vulnerabilitystatuses": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get vulnerability statuses", "produces": [ "application/json" ], "responses": { "200": { "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/VulnerabilityStatusViewModelShort" } } } } } }, "/api/integration/schedulingtemplates": { "get": { "tags": [ "Scheduling templates" ], "summary": "Get a list of scheduling templates", "responses": { "200": { "description": "A list of scheduling templates" } } }, "post": { "tags": [ "Scheduling templates" ], "summary": "Add scheduling template", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters to add a scheduling template", "schema": { "$ref": "#/definitions/SchedulingTemplatesViewModel" } } ], "responses": { "200": { "description": "A unique identifier of an item newly added" }, "400": { "description": "When viewModel is not valid" } } }, "put": { "tags": [ "Scheduling templates" ], "summary": "Update scheduling template", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters to update a scheduling template", "schema": { "$ref": "#/definitions/SchedulingTemplatesViewModel" } } ], "responses": { "200": { "description": "A unique identifier for a scheduling template" }, "400": { "description": "When viewModel is not valid" } } } }, "/api/integration/schedulingtemplates/{id}": { "get": { "tags": [ "Scheduling templates" ], "summary": "Get single scheduling template", "parameters": [ { "in": "path", "name": "id", "description": "Unique identifier of a scheduling template", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "withListScans", "description": "If true, scans list is included in response. By default, the value is false", "type": "boolean", "default": false } ], "responses": { "200": { "description": "A single scheduling template" } } }, "delete": { "tags": [ "Scheduling templates" ], "summary": "Deletes the scheduling template", "parameters": [ { "in": "path", "name": "id", "description": "A unique identifier of a scheduling template", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "When scheduling template has been deleted" }, "404": { "description": "When scheduling template was not found" } } } }, "/api/integration/schedulingtemplates/defaults": { "get": { "tags": [ "Scheduling templates" ], "summary": "Get default Scheduling Template model", "produces": [ "application/json" ], "responses": { "200": { "description": "Default Scheduling Template model", "schema": { "$ref": "#/definitions/SchedulingTemplatesViewModel" } } } } }, "/api/integration/schedulingtemplates/delete/batch": { "post": { "tags": [ "Scheduling templates" ], "summary": "Allows batch scheduler templates delete", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A BatchSchedulingTemplatesViewModel.", "schema": { "$ref": "#/definitions/BatchSchedulingTemplatesViewModel" } } ], "responses": { "200": { "description": "Returns list of unique identifiers of deleted scheduling templates", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } } } }, "/api/integration/schedulingtemplates/nextrun": { "put": { "tags": [ "Scheduling templates" ], "summary": "Calculate next run", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters to calculate next run.", "schema": { "$ref": "#/definitions/SchedulingTemplatesViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "date-time", "type": "string" } } } } }, "/api/integration/schedulingtemplates/timezones": { "get": { "tags": [ "Scheduling templates" ], "summary": "Get time zones list", "produces": [ "application/json" ], "responses": { "200": { "description": "A list of time zones", "schema": { "$ref": "#/definitions/Collection[SystemTimeZonesViewModel]" } } } } }, "/api/integration/schedulingtemplates/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Scheduling templates" ], "summary": "Get a paged list of scheduling templates", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/BaseFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[SchedulingTemplatesViewModel]" } } } } }, "/api/integration/scantemplates/{id}": { "get": { "tags": [ "Scan templates" ], "summary": "Get vulnerability scan template", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "A vulnerability scan template", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ScanTemplatesListDetailsViewModel[SystemScanCustomConfigurationViewModel]" } } } } }, "/api/integration/scantemplates/any": { "get": { "tags": [ "Scan templates" ], "summary": "Check if a scan template exists", "produces": [ "application/json" ], "responses": { "200": { "description": "True if any scan template exists. Else return false", "schema": { "type": "boolean" } } } } }, "/api/integration/scantemplates/delete/batch": { "post": { "tags": [ "Scan templates" ], "summary": "Allows batch deletion of scan templates", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A BatchScanTemplatesViewModel.", "schema": { "$ref": "#/definitions/BatchScanTemplatesViewModel" } } ], "responses": { "200": { "description": "Returns a list of unique identifiers for deleted vulnerability scan templates", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } } } }, "/api/integration/scantemplates/discoveryscan": { "post": { "tags": [ "Scan templates" ], "summary": "Create new discovery scan template", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters for creating a new Discovery scan template.", "schema": { "$ref": "#/definitions/CreateDiscoveryScanTemplateViewModel" } } ], "responses": { "200": { "description": "Created discovery scan template unique identifier", "schema": { "format": "uuid", "type": "string" } } } }, "put": { "tags": [ "Scan templates" ], "summary": "Update the existing discovery scan definition", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters for updating an existing Discovery scan template.", "schema": { "$ref": "#/definitions/UpdateDiscoveryScanTemplateViewModel" } } ], "responses": { "200": { "description": "An updated discovery scan template unique identifier", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/scantemplates/discoveryscan/{id}": { "get": { "tags": [ "Scan templates" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiscoveryTemplatesListDetailsViewModel" } } } } }, "/api/integration/scantemplates/discoveryscan/{scanTemplatesId}/configuration/xml": { "get": { "tags": [ "Scan templates" ], "summary": "Download scan configuration", "parameters": [ { "in": "path", "name": "scanTemplatesId", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A scan configuration xml" } }, "deprecated": true } }, "/api/integration/scantemplates/discoveryscan/{scanTemplatesId}/configuration/xml/download": { "get": { "tags": [ "Scan templates" ], "summary": "Download scan configuration", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanTemplatesId", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the configuration", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/scantemplates/discoveryscan/any": { "get": { "tags": [ "Scan templates" ], "summary": "Check if a discovery scan template exists", "produces": [ "application/json" ], "responses": { "200": { "description": "A True value when disovery scan exist. Else return false", "schema": { "type": "boolean" } } } } }, "/api/integration/scantemplates/discoveryscan/configuration/xml": { "put": { "tags": [ "Scan templates" ], "summary": "Upload scans configuration", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Action parameters", "schema": { "$ref": "#/definitions/BatchConfigurationScanTemplatesViewModel" } } ], "responses": { "200": { "description": "A list of updated scans", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } } }, "get": { "tags": [ "Scan templates" ], "summary": "Download scan configurations", "parameters": [ { "in": "query", "name": "ScanTemplatesIds", "description": "A list of unique identifiers for scan template IDs to change state", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A compressed file with scan configurations" } }, "deprecated": true } }, "/api/integration/scantemplates/discoveryscan/configuration/xml/download": { "get": { "tags": [ "Scan templates" ], "summary": "Download scan configurations", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "ScanTemplatesIds", "description": "A list of unique identifiers for scan template IDs to change state", "type": "array", "items": { "format": "uuid", "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "A JSON object containing a presigned URL to download the configurations", "schema": { "$ref": "#/definitions/DownloadUrlResponse" } } } } }, "/api/integration/scantemplates/discoveryscan/default": { "get": { "tags": [ "Scan templates" ], "summary": "Get the default view model for discovery scan template details", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiscoveryTemplatesListDetailsViewModel" } } } } }, "/api/integration/scantemplates/discoveryscan/delete/batch": { "delete": { "tags": [ "Scan templates" ], "summary": "Allows batch deletion of discovery templates", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A batchDiscoveryTemplatesViewModel.", "schema": { "$ref": "#/definitions/BatchScanTemplatesViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } } } }, "/api/integration/scantemplates/discoveryscan/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Scan templates" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/DiscoveryScanTemplatesFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[DiscoveryScanTemplatesListViewModel]" } } } } }, "/api/integration/scantemplates/systemscan/any": { "get": { "tags": [ "Scan templates" ], "summary": "Check if a Web Scan template exists", "produces": [ "application/json" ], "responses": { "200": { "description": "True if any System Scan template exists. Else return false", "schema": { "type": "boolean" } } } } }, "/api/integration/scantemplates/webscan/any": { "get": { "tags": [ "Scan templates" ], "summary": "Checks there's any Web Scan template", "produces": [ "application/json" ], "responses": { "200": { "description": "True if any Web Scan template exists. Else return false", "schema": { "type": "boolean" } } } } }, "/api/integration/scantemplates/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Scan templates" ], "summary": "Get a paged list of scan templates", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilityScanTemplatesFilterModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[ScanTemplatesListViewModel]" } } } } }, "/api/integration/scangroups": { "post": { "tags": [ "Scan groups" ], "summary": "Create a new Scan Group", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters to create a new Scan Group.", "schema": { "$ref": "#/definitions/CreateScanGroupViewModel" } } ], "responses": { "200": { "description": "Scan Group view model", "schema": { "$ref": "#/definitions/ScanGroupViewModel" } } } }, "put": { "tags": [ "Scan groups" ], "summary": "Update existing Scan Group", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters to update the existing scan Group.", "schema": { "$ref": "#/definitions/UpdateScanGroupViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/scangroups/{scanGroupId}": { "delete": { "tags": [ "Scan groups" ], "summary": "Delete scan group", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanGroupId", "description": "Scan Group unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Information that the deletion is performed in the background", "schema": { "$ref": "#/definitions/DeleteActionTypeEnum" } } } }, "get": { "tags": [ "Scan groups" ], "summary": "Get information about a scan group", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanGroupId", "description": "Scan Group unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Scan group information", "schema": { "$ref": "#/definitions/ScanGroupViewModel" } } } } }, "/api/integration/scangroups/{scanGroupId}/detailed": { "get": { "tags": [ "Scan groups" ], "summary": "Get detailed information about a scan group", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanGroupId", "description": "Scan Group unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "Detailed information about scan group", "schema": { "$ref": "#/definitions/ScanGroupViewModel" } } } } }, "/api/integration/scangroups/{scanGroupId}/notifications": { "get": { "tags": [ "Scan groups" ], "summary": "Get notifications defined on the scan groups", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanGroupId", "description": "Scan Group unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of view model objects of notifications", "schema": { "$ref": "#/definitions/Collection[MessageNotificationViewModel]" } } } } }, "/api/integration/scangroups/{scanGroupId}/systemscans": { "get": { "tags": [ "Scan groups" ], "summary": "Get a list of System Scans assigned to a scan group", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanGroupId", "description": "Scan Group unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of view model objects of assigned System Scans", "schema": { "$ref": "#/definitions/Collection[ScanViewModel]" } } } } }, "/api/integration/scangroups/{scanGroupId}/tags": { "get": { "tags": [ "Scan groups" ], "summary": "Get tags assigned directly to a scan group", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanGroupId", "description": "Scan Group unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of view model objects of assigned tags", "schema": { "$ref": "#/definitions/Collection[NameValueItem[String]]" } } } } }, "/api/integration/scangroups/{scanGroupId}/webscans": { "get": { "tags": [ "Scan groups" ], "summary": "Get a list of Web Scans assigned to a scan group", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanGroupId", "description": "Scan Group unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of view model objects of assigned Web Scans", "schema": { "$ref": "#/definitions/Collection[ScanViewModel]" } } } } }, "/api/integration/scangroups/{scanGroupId}/webscans/default": { "get": { "tags": [ "Scan groups" ], "summary": "Get a default Web Scan configuration for the scan group", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanGroupId", "description": "Scan Group unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A default Web Scan configuration for the scan group", "schema": { "$ref": "#/definitions/WebScanViewModel" } } } } }, "/api/integration/scangroups/default": { "get": { "tags": [ "Scan groups" ], "summary": "Get default scan group view model", "produces": [ "application/json" ], "responses": { "200": { "description": "Scan group view model", "schema": { "$ref": "#/definitions/CreateScanGroupViewModel" } } } } }, "/api/integration/scangroups/groupswithscancounter": { "put": { "tags": [ "Scan groups" ], "summary": "Return a list of Scan Groups with counter of containing scans", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters to filter Scan Results.", "schema": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } } ], "responses": { "200": { "description": "A list of GroupCountModel objects", "schema": { "$ref": "#/definitions/Collection[GroupCountViewModel]" } } } } }, "/api/integration/scangroups/scans/simple": { "post": { "tags": [ "Scan groups" ], "summary": "Get scans with host info", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "type", "description": "A type of scan. It could be SystemScan or WebScan" }, { "in": "body", "name": "body", "description": "A list of Scan Groups.", "schema": { "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Collection[NameIdItem[Guid]]" } } } } }, "/api/integration/scangroups/simple": { "get": { "tags": [ "Scan groups" ], "summary": "Get simple list of Scan Groups", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "scanEnabled", "description": "", "type": "array", "items": { "$ref": "#/definitions/ScanType" }, "collectionFormat": "multi" }, { "in": "query", "name": "ticketId", "description": "A ticket unique identifier", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "A list of Scan Groups", "schema": { "$ref": "#/definitions/Collection[NameIdItem[Guid]]" } } } } }, "/api/integration/roles": { "get": { "tags": [ "Users" ], "summary": "Return a list of user roles", "produces": [ "application/json" ], "responses": { "200": { "description": "A list of roles", "schema": { "$ref": "#/definitions/Collection[RoleViewModel]" } } } } }, "/api/integration/roles/{id}": { "get": { "tags": [ "Users" ], "summary": "Get single user role", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "A role unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "An user role", "schema": { "$ref": "#/definitions/RoleViewModel" } } } } }, "/api/integration/usergroups": { "get": { "tags": [ "Users" ], "summary": "Return list of user groups", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserGroupsListViewModel" } } } } } }, "/api/integration/usergroups/{id}": { "get": { "tags": [ "Users" ], "summary": "Get single user group", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "User group unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserGroupViewModel" } } } } }, "/api/integration/usergroups/filtered": { "put": { "tags": [ "Users" ], "summary": "Return list of user groups filtered by criteria", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Users filter.", "schema": { "$ref": "#/definitions/UserFilterViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserGroupsListViewModel" } } } } } }, "/api/integration/usergroups/validate/{id}": { "get": { "tags": [ "Users" ], "summary": "Delete user group by id", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "User group unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/api/integration/users": { "get": { "tags": [ "Users" ], "summary": "Get the list of users", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "includeInactive", "description": "If true, the list includes inactive users", "type": "boolean" }, { "in": "query", "name": "includeParent", "description": "If true, the list includes users from the parent organization", "type": "boolean" } ], "responses": { "200": { "description": "A list of users with the basic information", "schema": { "$ref": "#/definitions/Collection[SimpleUserViewModel]" } } } } }, "/api/integration/users/{Id}/details": { "get": { "tags": [ "Users" ], "summary": "Get user details", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "A unique user identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "User details", "schema": { "$ref": "#/definitions/UserDetailsViewModel" } } } } }, "/api/integration/users/byid": { "get": { "tags": [ "Users" ], "summary": "Get user", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "userId", "description": "An user unique identifier", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "An user data", "schema": { "$ref": "#/definitions/UserViewModel" } } } } }, "/api/integration/users/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Users" ], "summary": "Get a paged list of users", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/UserFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[UserListViewModel]" } } } } }, "/api/integration/tickets": { "post": { "tags": [ "Tickets" ], "summary": "Create ticket", "description": "Use this method to create a new ticket with basic information.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Parameters to create ticket.", "schema": { "$ref": "#/definitions/CreateTicketViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/tickets/{ticketId}": { "get": { "tags": [ "Tickets" ], "summary": "Get basic info about the ticket, such as name, description, estimate, priority", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketViewModel" } } } }, "put": { "tags": [ "Tickets" ], "summary": "Update ticket", "description": "This method allows to change basic ticket information.", "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to update ticket.", "schema": { "$ref": "#/definitions/CreateTicketViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/tickets/{ticketId}/changelog": { "get": { "tags": [ "Tickets" ], "summary": "Get the log items of ticket changes", "description": "Every ticket has chain of events that describe activity\nperformed and its state. This method returns chronological list of who and when performed\nany action. The most recent events are first.", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/TicketActivityView" } } } } }, "post": { "tags": [ "Tickets" ], "summary": "Add comment to ticket", "description": "Any text can be added to the ticket as comment.\nEvery comment that is added to the ticket is visible on the change log list.", "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Ticket comment.", "schema": { "$ref": "#/definitions/TicketCommentViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/tickets/{ticketId}/followers": { "post": { "tags": [ "Tickets" ], "summary": "Add a follower to the ticket", "description": "Follower for a ticket is identified by user unique identifier (if it already exists in portal) or by email address (if the user does not exist in portal).\nTo add a follower to the ticket, add the email address or user unique identifier in the object that is passed within this request.\nWith an email address, the follower does not automatically become a Radar user but receives notifications that are related to the ticket.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "", "schema": { "$ref": "#/definitions/TicketFollowerViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "int32", "type": "integer" } } } }, "get": { "tags": [ "Tickets" ], "summary": "Get ticket followers. Returns all followers that have been added to a particular ticket", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/TicketFollowersViewModel" } } } } } }, "/api/integration/tickets/{ticketId}/followers/delete/batch": { "post": { "tags": [ "Tickets" ], "summary": "Delete followers", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "A list of followers unique identifiers.", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } ], "responses": { "200": { "description": "OK", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/tickets/{ticketId}/openvulnerabilities/count": { "get": { "tags": [ "Tickets" ], "summary": "Get the number of open vulnerabilities that are attached to the ticket", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/tickets/{ticketId}/reopen": { "get": { "tags": [ "Tickets" ], "summary": "Reopen closed ticket", "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/tickets/{ticketId}/status": { "post": { "tags": [ "Tickets" ], "summary": "Change the ticket status, can be used to open or close a ticket", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to change the status.", "schema": { "$ref": "#/definitions/ChangeTicketStatusViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketViewModel" } } } } }, "/api/integration/tickets/{ticketId}/tags": { "get": { "tags": [ "Tickets" ], "summary": "Get ticket tags", "description": "Ticket description can include tags. This method returns all tags that have been added to the ticket.", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Collection[TagViewModel]" } } } }, "post": { "tags": [ "Tickets" ], "summary": "Add an existing tag or create a new one for a ticket", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Information about a new tag.", "schema": { "$ref": "#/definitions/NewTagViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TagViewModel" } } } } }, "/api/integration/tickets/{ticketId}/tags/{technicalName}": { "delete": { "tags": [ "Tickets" ], "summary": "Remove tags from a ticket", "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "technicalName", "description": "Tag technical name to remove", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/tickets/{ticketId}/vulnerabilities/attach/batch": { "put": { "tags": [ "Tickets" ], "summary": "Attach vulnerabilities to existing ticket", "description": "Radar tickets are usually created to solve problems with vulnerabilities on hosts or systems.\nUse this method to attach findings to a particular ticket.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to attach vulnerabilities to ticket", "schema": { "$ref": "#/definitions/VulnerabilitiesInstancesViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/tickets/{ticketId}/vulnerabilities/detach/batch": { "put": { "tags": [ "Tickets" ], "summary": "Detach vulnerabilities from an existing ticket", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to detach vulnerabilities from a ticket.", "schema": { "$ref": "#/definitions/VulnerabilitiesInstancesViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/tickets/{ticketId}/vulnerabilities/status/change/batch": { "put": { "tags": [ "Tickets" ], "summary": "Change the status of vulnerabilities in a ticket", "description": "Every vulnerability instance has a status no matter if it is attached to a ticket or not.\nUse this method to change the status of vulnerability instances that are attached to a particular ticket.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "ticketId", "description": "A ticket unique identifier", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "description": "Parameters to change vulnerabilities status in ticket", "schema": { "$ref": "#/definitions/VulnerabilitiesStatusChangeViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "int32", "type": "integer" } } } } }, "/api/integration/tickets/default": { "get": { "tags": [ "Tickets" ], "summary": "Get default view model to create ticket", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateTicketViewModel" } } } } }, "/api/integration/tickets/delete/batch": { "post": { "tags": [ "Tickets" ], "summary": "Delete tickets", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A list of tickets unique identifiers.", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "format": "uuid", "type": "string" } } } } } }, "/api/integration/tickets/grouped": { "get": { "tags": [ "Tickets" ], "summary": "Get total number of tickets and vulnerabilities in organization", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketsSummaryViewModel" } } } } }, "/api/integration/tickets/simple": { "get": { "tags": [ "Tickets" ], "summary": "Get a simple list (name and unique identifier) of tickets", "description": "Use this method when you do not need to get all basic ticket information but only its name and unique identifier.\nReturns only tickets that contain vulnerability instances for hosts in those scan groups that the requester can access.\nReturns tickets based on the requester (user) privilege flags.\nFor example, the Ticketing_Own privilege flag only returns tickets created by the user.", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "statusesOfOpenType", "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Collection[NameIdItem[Guid]]" } } } } }, "/api/integration/tickets/statuses": { "get": { "tags": [ "Tickets" ], "summary": "Get the list of possible ticket statuses", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/TicketStatusViewModel" } } } } } }, "/api/integration/tickets/systemscan/vulnerabilities/grouped/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Tickets" ], "summary": "Get System Scan findings attached to ticket", "description": "Returns only vulnerability instances for hosts in those scan groups that the requester (user) can access.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilitiesOnHostFilter" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[TicketGroupedVulnerabilityOnHostViewModel]" } } } } }, "/api/integration/tickets/systemscan/vulnerabilities/hosts": { "post": { "tags": [ "Tickets" ], "summary": "Get hosts that have vulnerabilities attached to tickets and filtered by Scan Groups", "description": "This method checks if the requester (user) has access to scan groups that are passed in parameters..", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "A list of Scan Groups.", "schema": { "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Collection[NameIdItem[Guid]]" } } } } }, "/api/integration/tickets/systemscan/vulnerabilities/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Tickets" ], "summary": "Get a list of System Scan findings that are attached to the ticket", "description": "Returns only vulnerability instances for hosts in those scan groups that the requester (user) can access.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilitiesOnHostFilter" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[TicketVulnerabilityOnHostViewModel]" } } } } }, "/api/integration/tickets/vulnerabilities/groupedby/tickets/count": { "get": { "tags": [ "Tickets" ], "summary": "Get the number of vulnerabilities grouped by the ticket for organization", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[Guid]" } } } } } }, "/api/integration/tickets/webscan/vulnerabilities/grouped/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Tickets" ], "summary": "Get list of Web Scan findings attached to the ticket", "description": "Returns only vulnerability instances for hosts in those scan groups that the requester (user) can access.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilitiesOnSiteFilter" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[TicketGroupedVulnerabilityOnSiteViewModel]" } } } } }, "/api/integration/tickets/webscan/vulnerabilities/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Tickets" ], "summary": "Get list of Web Scan findings attached to the ticket", "description": "Returns only vulnerability instances for hosts in those scan groups that the requester (user) can access.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/VulnerabilitiesOnSiteFilter" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[TicketVulnerabilityOnSiteViewModel]" } } } } }, "/api/integration/tickets/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Tickets" ], "summary": "Get a paged list of tickets", "description": "Every returned ticket contains basic information, for example name, description, estimate, and deadline.\n Returns only tickets with vulnerability instances of those hosts in scan groups that the requester (user) can access.\n Returns tickets based on the requester (user) privilege flags. For example, the Ticketing_Own privilege flag only returns tickets created by the user.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/TicketsFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[TicketViewModel]" } } } } }, "/api/integration/logs/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Audit trail" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/LogsFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[LogViewModel]" } } } } }, "/api/integration/account/authenticationcontext": { "get": { "tags": [ "My profile" ], "summary": "Get context for a currently authenticated user (in specific organization)", "produces": [ "application/json" ], "responses": { "200": { "description": "Account details", "schema": { "$ref": "#/definitions/AuthenticationContextViewModel" } } } } }, "/api/integration/account/details": { "get": { "tags": [ "My profile" ], "summary": "Get account details", "produces": [ "application/json" ], "responses": { "200": { "description": "Account details", "schema": { "$ref": "#/definitions/AccountDetailsViewModel" } } } }, "put": { "tags": [ "My profile" ], "summary": "Update user details", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Account parameters", "schema": { "$ref": "#/definitions/AccountDetailsViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/news/changelogurl": { "get": { "tags": [ "News" ], "summary": "Get changelog url", "produces": [ "application/json" ], "responses": { "200": { "description": "String with url where changelog is located", "schema": { "type": "string" } } } } }, "/api/integration/news/rss": { "get": { "tags": [ "News" ], "summary": "Get the RSS data about news", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "top", "description": "Get only top X elements", "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "A list with Radar news", "schema": { "$ref": "#/definitions/Collection[RssDataViewModel]" } } } } }, "/api/integration/news/rssurl": { "get": { "tags": [ "News" ], "summary": "Get the RSS feed location", "produces": [ "application/json" ], "responses": { "200": { "description": "Url with string where RSS feed is located", "schema": { "type": "string" } } } } }, "/api/integration/scannodes": { "get": { "tags": [ "Scan nodes" ], "summary": "Gets the scan nodes", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { } } } } }, "post": { "tags": [ "Scan nodes" ], "summary": "Creates the scan node", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "The scan node settings.", "schema": { "$ref": "#/definitions/CreateScanNodeSettingsViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } }, "put": { "tags": [ "Scan nodes" ], "summary": "Updates the scan node", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Updated scan node details.", "schema": { "$ref": "#/definitions/UpdateScanNodeSettingsViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/scannodes/{scanNodeId}": { "get": { "tags": [ "Scan nodes" ], "summary": "Gets the scan node", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanNodeId", "description": "Scan node unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateScanNodeSettingsViewModel" } } } } }, "/api/integration/scannodes/{scanNodeId}/deactivation": { "put": { "tags": [ "Scan nodes" ], "summary": "Deletes the scan node", "parameters": [ { "in": "path", "name": "scanNodeId", "description": "Unique identifier of scan node to be deleted", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/scannodes/{scanNodeId}/details": { "get": { "tags": [ "Scan nodes" ], "summary": "Gets details of scan node", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanNodeId", "description": "Scan node unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScanNodeDetailsViewModel" } } } } }, "/api/integration/scannodes/{scanNodeId}/newscannodeid/{newScanNodeId}": { "delete": { "tags": [ "Scan nodes" ], "summary": "Deletes the scan node", "parameters": [ { "in": "path", "name": "scanNodeId", "description": "Unique identifier of scan node to be deleted", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "newScanNodeId", "description": "Unique identifier of scan node to use instead of removed one", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/scannodes/default": { "get": { "tags": [ "Scan nodes" ], "summary": "Gets the default scan node settings", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "scanNodeId", "description": "The scan node identifier", "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateScanNodeSettingsViewModel" } } } } }, "/api/integration/scannodes/discoveryscan": { "get": { "tags": [ "Scan nodes" ], "summary": "Gets the discovery scan scan nodes", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { } } } } } }, "/api/integration/scannodes/licenseinfo": { "get": { "tags": [ "Scan nodes" ], "summary": "Returns mumber of Scan Node Agent licenses, that are already utilized in this organization's subscription", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScanNodeLicensesViewModel" } } } } }, "/api/integration/scannodes/requestlicense": { "post": { "tags": [ "Scan nodes" ], "summary": "Returns link to license for specified scan node", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/RequestScanNodeLicenseViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScanNodeLicenseOrderResponseViewModel" } } } } }, "/api/integration/scannodes/systemscan": { "get": { "tags": [ "Scan nodes" ], "summary": "Gets the System Scan scan nodes", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { } } } } } }, "/api/integration/scannodes/virtual/{scanNodeId}/details": { "get": { "tags": [ "Scan nodes" ], "summary": "Gets a list of scan nodes assigned to a virtual scan node", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "scanNodeId", "description": "A unique identifier for a virtual scan node", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ScanNodeVirtualDetailsViewModel" } } } } } }, "/api/integration/scannodes/webscan": { "get": { "tags": [ "Scan nodes" ], "summary": "Gets the Web Scan nodes", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { } } } } } }, "/api/integration/scannodes/withstartindex/{startIndex}/andpagesize/{pageSize}": { "post": { "tags": [ "Scan nodes" ], "summary": "Get a paged list", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "startIndex", "description": "A start index of a page", "required": true, "type": "integer", "format": "int32" }, { "in": "path", "name": "pageSize", "description": "A page size", "required": true, "type": "integer", "format": "int32" }, { "in": "body", "name": "body", "description": "Filter object to filter data.", "schema": { "$ref": "#/definitions/ScanNodesFilterViewModel" } } ], "responses": { "200": { "description": "Paged data", "schema": { "$ref": "#/definitions/PagedData[ScanNodeViewModel]" } } } } }, "/api/integration/authenticationcheck": { "post": { "tags": [ "Uncategorized actions" ], "summary": "Check authentication status", "parameters": [ { "in": "query", "name": "userId", "type": "string", "format": "uuid" }, { "in": "query", "name": "timestamp", "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Uncategorized actions" ], "summary": "Get authentication status", "parameters": [ { "in": "query", "name": "userId", "type": "string", "format": "uuid" }, { "in": "query", "name": "timestamp", "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/authenticationcheck/{userId}": { "post": { "tags": [ "Uncategorized actions" ], "summary": "Check authentication status", "parameters": [ { "in": "path", "name": "userId", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "timestamp", "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Uncategorized actions" ], "summary": "Get authentication status", "parameters": [ { "in": "path", "name": "userId", "required": true, "type": "string", "format": "uuid" }, { "in": "query", "name": "timestamp", "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/productinfo": { "get": { "tags": [ "Uncategorized actions" ], "summary": "Get information about the product", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductInfoViewModel" } } } } }, "/api/integration/settings/general": { "get": { "tags": [ "Uncategorized actions" ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GeneralSettingsViewModel" } } } } }, "/api/integration/settings/general/archiveassetsperiod": { "put": { "tags": [ "Uncategorized actions" ], "summary": "Updates period when assets should be archived", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "After what time the asset will be archived.", "schema": { "$ref": "#/definitions/ArchiveAssetsPeriodViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/settings/general/encryptionkeys": { "get": { "tags": [ "Uncategorized actions" ], "summary": "Gets a colection of encryption keys", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/EncryptionKeyViewModel" } } } } }, "post": { "tags": [ "Uncategorized actions" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/CreateEncryptionKeyViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/settings/general/encryptionkeys/{encryptionKeyId}": { "delete": { "tags": [ "Uncategorized actions" ], "summary": "Removes encryption key", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "encryptionKeyId", "description": "Encryption key unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } } }, "/api/integration/settings/general/encryptionkeys/{encryptionKeyId}/default": { "put": { "tags": [ "Uncategorized actions" ], "summary": "Sets existing encryption key as a default", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "encryptionKeyId", "description": "Encryption key unique identifier", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/api/integration/settings/general/endpointagentscanschedule": { "put": { "tags": [ "Uncategorized actions" ], "summary": "Updates period how often Radar Endpoint Agent scan should be executed", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "How often Radar Endpoint Agent scan should be executed.", "schema": { "$ref": "#/definitions/EndpointAgentScanScheduleViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/settings/general/primarycontactdetails": { "put": { "tags": [ "Uncategorized actions" ], "summary": "Updates organization primary contact", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/GeneralSettingsContactDetailsViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/settings/general/scanningrestrictions": { "get": { "tags": [ "Uncategorized actions" ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScanningRestrictionViewModel" } } } }, "put": { "tags": [ "Uncategorized actions" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/ScanningRestrictionViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/api/integration/settings/general/scanningrestrictions/timeframes": { "post": { "tags": [ "Uncategorized actions" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TimeFrameViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "format": "uuid", "type": "string" } } } }, "put": { "tags": [ "Uncategorized actions" ], "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/TimeFrameViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/settings/general/scanningrestrictions/timeframes/{timeFrameId}": { "delete": { "tags": [ "Uncategorized actions" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "timeFrameId", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/api/integration/settings/general/storeassetsperiod": { "put": { "tags": [ "Uncategorized actions" ], "summary": "Updates period how long assets should be kept in the system", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "How long assets should be kept in the system.", "schema": { "$ref": "#/definitions/StoreAssetsPeriodViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/settings/general/storereportsperiod": { "put": { "tags": [ "Uncategorized actions" ], "summary": "Updates organization report storage policy", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "How long scanning reports should be kept.", "schema": { "$ref": "#/definitions/StoreReportsPeriodViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/settings/general/tickets": { "get": { "tags": [ "Uncategorized actions" ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TicketSettingsViewModel" } } } } }, "/api/integration/settings/general/timezone": { "put": { "tags": [ "Uncategorized actions" ], "summary": "Updates time zone settings for the organization", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/OrganizationTimeZoneViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/settings/general/vulnerabilitystatuses": { "get": { "tags": [ "Uncategorized actions" ], "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Collection[VulnerabilityStatusViewModel]" } } } }, "post": { "tags": [ "Uncategorized actions" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/VulnerabilityStatusViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/api/integration/settings/general/vulnerabilitystatuses/{vulnerabilityStatusId}": { "put": { "tags": [ "Uncategorized actions" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "vulnerabilityStatusId", "required": true, "type": "string", "format": "uuid" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/VulnerabilityStatusViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } }, "delete": { "tags": [ "Uncategorized actions" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "vulnerabilityStatusId", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } } } }, "/api/integration/settings/general/workflow": { "put": { "tags": [ "Uncategorized actions" ], "summary": "Updates workflow settings", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/WorkflowSettingsViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/settings/security": { "get": { "tags": [ "Uncategorized actions" ], "summary": "Gets organization security settings", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SecuritySettingsViewModel" } } } }, "put": { "tags": [ "Uncategorized actions" ], "summary": "Updates organization security settings", "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "description": "Security settings view model.", "schema": { "$ref": "#/definitions/SecuritySettingsViewModel" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/integration/tags": { "get": { "tags": [ "Uncategorized actions" ], "summary": "Get a list with available tags to search by", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "manualTags", "description": "If true, manual tags are included in the list", "type": "boolean" }, { "in": "query", "name": "detectedInScans", "description": "Show only tags detected in scans. If false, shows all tags", "type": "boolean", "default": true } ], "responses": { "200": { "description": "A list of available search tags", "schema": { "$ref": "#/definitions/Collection[TagViewModel]" } } } } } }, "definitions": { "AccessRestrictViewModel": { "description": "Represents access restrictions.", "type": "object", "properties": { "IsActive": { "description": "A flag that indicates if access restriction is active or not", "type": "boolean" }, "IpFilteringMode": { "$ref": "#/definitions/RadarIPFilteringMode" }, "IpList": { "description": "IP range or IPs with restrictions", "type": "string" } }, "additionalProperties": false }, "AccountDetailsViewModel": { "type": "object", "properties": { "AuthenticationMode": { "$ref": "#/definitions/AuthenticationMode" }, "RequireTwoFactorAutheticationFromAnyCompany": { "description": "A flag that indicates if user need verify against two factor authentication because some organization require it", "type": "boolean" }, "Email": { "description": "An user email address", "type": "string" }, "FirstName": { "description": "Name of the user", "type": "string" }, "LanguageCode": { "$ref": "#/definitions/LocalizationEnum" }, "LastName": { "description": "An user last name", "type": "string" }, "NotificationPeriod": { "$ref": "#/definitions/NotificationPeriod" }, "Phone": { "description": "An user phone number", "type": "string" }, "TimeZone": { "description": "An user time zone", "type": "string" } }, "additionalProperties": false }, "AccountTypes": { "enum": [ "ServiceAccount", "CustomCredentials" ], "type": "string" }, "AddSystemScansResultViewModel": { "type": "object", "properties": { "ScanList": { "description": "A list of scan unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "AddSystemScansViewModel": { "required": [ "GroupId" ], "type": "object", "properties": { "GroupId": { "format": "uuid", "description": "A Scan Group unique identifier", "type": "string" }, "Targets": { "description": "A list of scan targets", "type": "array", "items": { "$ref": "#/definitions/TargetScanViewModel" } }, "ScanningMode": { "$ref": "#/definitions/ScanningMode" } }, "additionalProperties": false }, "AffectedAssetViewModel": { "type": "object", "properties": { "HostName": { "type": "string" } }, "additionalProperties": false }, "AffectedAssetsFilterViewModel": { "type": "object", "properties": { "VulnerabilityId": { "format": "uuid", "description": "Vulnerability unique identifier", "type": "string" }, "VulnerabilityStatusIds": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "ExcludePotential": { "description": "Exclude potential vulnerabilities", "type": "boolean" }, "ScanTagsOneOf": { "description": "Tags included in scan. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "ScanTagsAllOf": { "description": "Tags included in scan. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "TargetRelatedBasicFields": { "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[TargetRelatedBasicFieldEnum]" } }, "ShowAllOpenStatuses": { "type": "boolean" }, "ShowAllStatuses": { "type": "boolean" }, "Archived": { "description": "A flag indicating that filtered items will contain also archived assets. By default only non archived assets are returned", "type": "boolean" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "AffectedHostsFilterViewModel": { "type": "object", "properties": { "VulnerabilityId": { "format": "uuid", "description": "Vulnerability unique identifier", "type": "string" }, "ScanGroupIds": { "description": "IDs of scan groups to search for affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "VulnerabilityStatusIds": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "ExcludePotential": { "description": "Exclude potential vulnerabilities", "type": "boolean" }, "ScanTagsOneOf": { "description": "Tags included in scan. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "ScanTagsAllOf": { "description": "Tags included in scan. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "TargetRelatedBasicFields": { "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[TargetRelatedBasicFieldEnum]" } }, "ShowAllOpenStatuses": { "type": "boolean" }, "ShowAllStatuses": { "type": "boolean" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "AffectedSiteBasicFieldEnum": { "description": "Type of fields for affected site on which filter can be set.", "enum": [ "Name", "TargetSite" ], "type": "string" }, "AffectedSitesFilterViewModel": { "type": "object", "properties": { "VulnerabilityCategoryId": { "format": "uuid", "description": "Vulnerability category unique identifier", "type": "string" }, "WsPluginId": { "format": "int32", "description": "ID of Web Scan plug-in which reported the vulnerability instance", "type": "integer" }, "ScanGroupIds": { "description": "Scan group unique identifiers to search affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "VulnerabilityCategoryIds": { "description": "Web Scan categories unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "VulnerabilityStatusIds": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "TargetRelatedBasicFields": { "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[AffectedSiteBasicFieldEnum]" } }, "ShowAllOpenStatuses": { "type": "boolean" }, "ShowAllStatuses": { "type": "boolean" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "ApiAuthenticationTypes": { "enum": [ "Password", "Token" ], "type": "string" }, "ArchiveAssetsPeriodViewModel": { "description": "After what time the asset will be archived.", "type": "object", "properties": { "ArchiveAssetsPeriod": { "$ref": "#/definitions/ArchiveAssetsPeriods" } }, "additionalProperties": false }, "ArchiveAssetsPeriods": { "description": "After what time the asset will be archived.", "enum": [ "Never", "Month", "Quarter", "HalfYear", "Year", "TwoYears" ], "type": "string" }, "AssetBasicFieldEnum": { "description": "Type of basic asset fields on which filter can be set.", "enum": [ "Notes", "OperatingSystem", "LastScanned", "LastSeen", "FirstDiscovered", "LastUpdated", "PurposeOfApplication", "TechnicalDocumentation", "Contacts", "ServiceOwner", "BusinessOwner", "Vendor", "ContractAndInvoicing", "ServiceOwnerResponsibilities", "BusinessOwnerResponsibilities", "VendorResponsibilities", "UndefinedResponsibilities", "ServerHostedIn", "Country", "NetworkEnvironment", "Manufacturer", "Department", "EmployeePersonalDataStored", "EmployeePersonalDataCategory", "EmployeePersonalDataVolume", "CustomerPersonalDataStored", "CustomerPersonalDataCategory", "CustomerPersonalDataVolume", "IntellectualPropertyRights", "Name", "Version", "Publisher", "InstallDate", "VulnerabilitiesHigh", "VulnerabilitiesMedium", "VulnerabilitiesLow", "VulnerabilitiesInformational", "Type", "SystemManufacturer", "SystemModel", "ProcessorInfo", "SystemMemory", "BiosInfo", "SystemType", "Storage", "NetworkInterfaceName", "NetworkInterfaceMacAddress", "NetworkInterfaceIpAddress" ], "type": "string" }, "AssetDetailsViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "An asset unique identifier", "type": "string" }, "FriendlyName": { "description": "Friendly name of the asset", "type": "string" }, "LastUpdatedOn": { "format": "date-time", "description": "Last updated date", "type": "string" }, "LastSeenOn": { "format": "date-time", "description": "Last seen date", "type": "string" }, "LastScannedOn": { "format": "date-time", "description": "Last scanned date", "type": "string" }, "FirstDiscoveredOn": { "format": "date-time", "description": "First discovered date", "type": "string" }, "InternetExposure": { "description": "Defines asset host's internet exposure", "type": "boolean" }, "Archived": { "description": "Flag that indicates if asset is archived", "type": "boolean" }, "Tags": { "description": "A list that represents tags pinned to the asset", "type": "array", "items": { "$ref": "#/definitions/TagViewModel" } }, "Note": { "description": "An asset note", "type": "string" }, "ScanGroups": { "description": "A list of scan groups related to asset by scan", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "PrimaryScanGroupId": { "format": "uuid", "description": "A scan group of scan from where vulnerabilities are taken", "type": "string" } }, "additionalProperties": false }, "AssetFilterViewModel": { "type": "object", "properties": { "Text": { "type": "string" }, "InternetExposure": { "type": "boolean" }, "TagsOneOf": { "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "TagsAllOf": { "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "OnlyWithoutAnyAssetTag": { "type": "boolean" }, "OnlyWithAssetTags": { "type": "boolean" }, "IsExploitable": { "type": "boolean" }, "Severity": { "type": "array", "items": { "type": "string" } }, "ExcludeHigherSeverity": { "type": "boolean" }, "Importance": { "format": "int32", "type": "integer" }, "RiskScore": { "format": "int32", "type": "integer" }, "ScanGroups": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "LastExecutedSourceType": { "$ref": "#/definitions/FSecure.Radar.SecurityCentre.Model.Enums.Assets.AssetSourceTypes" }, "Archived": { "type": "boolean" }, "AssetBasicFields": { "type": "array", "items": { "$ref": "#/definitions/FilterBasicFieldWithScanned[AssetBasicFieldEnum]" } }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "AssetHostDescriptionViewModel": { "type": "object", "properties": { "AssetHostId": { "format": "uuid", "description": "Unique identifier of asset host which has description parameters", "type": "string" }, "PurposeOfApplication": { "description": "Purpose of the application", "maxLength": 2048, "type": "string" }, "TechnicalDocumentation": { "description": "Technical documentation", "maxLength": 2048, "type": "string" }, "Contacts": { "description": "Contacts", "maxLength": 2048, "type": "string" }, "ServiceOwner": { "description": "Service owner", "maxLength": 2048, "type": "string" }, "BusinessOwner": { "description": "Business owner", "maxLength": 2048, "type": "string" }, "Vendor": { "description": "Vendor", "maxLength": 2048, "type": "string" }, "ContractAndInvoicing": { "description": "Contract and invoicing", "maxLength": 2048, "type": "string" }, "ServiceOwnerResponsibilities": { "description": "Service owner responsibilities", "maxLength": 2048, "type": "string" }, "BusinessOwnerResponsibilities": { "description": "Business owner responsibilities", "maxLength": 2048, "type": "string" }, "VendorResponsibilities": { "description": "Vendor responsibilities", "maxLength": 2048, "type": "string" }, "UndefinedResponsibilities": { "description": "Undefined responsibilities", "maxLength": 2048, "type": "string" }, "ServerHostedIn": { "description": "Server hosted in", "maxLength": 2048, "type": "string" }, "Country": { "description": "Country", "maxLength": 2048, "type": "string" }, "NetworkEnvironment": { "description": "Network environment", "maxLength": 2048, "type": "string" }, "Manufacturer": { "description": "Manufacturer", "maxLength": 2048, "type": "string" }, "Department": { "description": "Department", "maxLength": 2048, "type": "string" }, "EmployeePersonalDataStored": { "description": "Employee personal data stored", "type": "boolean" }, "EmployeePersonalDataCategory": { "description": "Employee personal data category", "maxLength": 2048, "type": "string" }, "EmployeePersonalDataVolume": { "description": "Employee personal data volume", "maxLength": 2048, "type": "string" }, "CustomerPersonalDataStored": { "description": "Customer personal data stored", "type": "boolean" }, "CustomerPersonalDataCategory": { "description": "Customer personal data category", "maxLength": 2048, "type": "string" }, "CustomerPersonalDataVolume": { "description": "Customer personal data volume", "maxLength": 2048, "type": "string" }, "IntellectualPropertyRights": { "description": "Intellectual property rights", "maxLength": 2048, "type": "string" }, "Importance": { "format": "int32", "description": "Asset importance", "type": "integer" }, "InternetExposure": { "description": "Internet exposure", "type": "boolean" }, "ManualInternetExposure": { "description": "Manual internet exposure", "type": "boolean" }, "OnPublicInternet": { "description": "Public on internet", "type": "boolean" }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "AssetHostDetailsViewModel": { "type": "object", "properties": { "AssetHostId": { "format": "uuid", "description": "Unique identifier of asset host which has description parameters", "type": "string" }, "InternetExposure": { "description": "Defines asset host's internet exposure", "type": "boolean" }, "ManualInternetExposure": { "description": "Defines asset host's internet exposure set manually by user", "type": "boolean" }, "Importance": { "format": "int32", "description": "Defines asset's importance - impacts risk score", "maximum": 1, "minimum": -1, "type": "integer" }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "AssetHostSoftwareViewModel": { "type": "object", "properties": { "OperatingSystem": { "description": "Operating system", "type": "string" }, "OperatingSystemName": { "description": "Name of operating system", "type": "string" }, "OperatingSystemVersion": { "description": "Version of operating system", "type": "string" }, "OperatingSystemManufacturer": { "description": "Manufacturer of operating system", "type": "string" }, "LastBoot": { "format": "date-time", "description": "Date of last boot", "type": "string" } }, "additionalProperties": false }, "AssetHostViewModel": { "type": "object", "properties": { "AssetHostId": { "format": "uuid", "description": "Asset host unique identifier", "type": "string" }, "AssetId": { "format": "uuid", "description": "Asset unique identifier", "type": "string" }, "HostName": { "description": "Asset host name", "type": "string" }, "IpAddress": { "description": "Asset IP address", "type": "string" }, "IpAddressNumber": { "format": "int64", "description": "Asset IP address number", "type": "integer" }, "MacAddress": { "description": "Asset mac address", "type": "string" }, "LastExecutedSourceType": { "$ref": "#/definitions/FSecure.Radar.SecurityCentre.Model.Enums.Assets.AssetSourceTypes" }, "LastExecutedSourceTypes": { "description": "Last executed source types", "type": "array", "items": { "$ref": "#/definitions/FSecure.Radar.SecurityCentre.Model.Enums.Assets.AssetSourceTypes" } }, "OperatingSystem": { "description": "Asset operating system", "type": "string" }, "OperatingSystemName": { "description": "Name of operating system", "type": "string" }, "OperatingSystemVersion": { "description": "Version of operating system", "type": "string" }, "OperatingSystemManufacturer": { "description": "Manufacturer of operating system", "type": "string" }, "InternetExposure": { "description": "Defines asset host's internet exposure", "type": "boolean" }, "OnPublicInternet": { "description": "Defines asset host's internet exposure taken from EPP service", "type": "boolean" }, "ManualInternetExposure": { "description": "Internet exposure set manually by user", "type": "boolean" }, "NumberOfPublicExploits": { "format": "int32", "description": "Number of public exploits, null if the information is not available", "type": "integer" }, "VulnerabilitiesCritical": { "format": "int32", "description": "A number of vulnerabilitites with critical serverity", "type": "integer" }, "VulnerabilitiesHigh": { "format": "int32", "description": "A number of vulnerabilitites with high serverity", "type": "integer" }, "VulnerabilitiesMedium": { "format": "int32", "description": "A number of vulnerabilitites with medium serverity", "type": "integer" }, "VulnerabilitiesLow": { "format": "int32", "description": "A number of vulnerabilitites with low serverity", "type": "integer" }, "VulnerabilitiesInformational": { "format": "int32", "description": "A number of vulnerabilitites with informational serverity", "type": "integer" }, "IsVulnerabilityScanned": { "description": "A flag indicating that asset is scanned", "type": "boolean" }, "Change": { "$ref": "#/definitions/ScanChange" }, "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "DomainName": { "description": "Host domain name", "type": "string" }, "Archived": { "description": "A flag indicating that asset is archived", "type": "boolean" }, "LastScanTerminated": { "description": "A flag indicating that last scan was terminated, not succesfully finished", "type": "boolean" }, "RiskScore": { "format": "double", "description": "Asset risk score calculated value", "type": "number" }, "RiskScoreState": { "$ref": "#/definitions/AssetRiskScoreStateEnum" }, "RiskScoreLastCalculatedOn": { "format": "date-time", "description": "Last asset risk score successfull calculation date", "type": "string" }, "Importance": { "format": "int32", "description": "Asset importance", "type": "integer" } }, "additionalProperties": false }, "AssetMonitoringBaseViewModel": { "type": "object", "properties": { "ScanGroupId": { "format": "uuid", "description": "A unique identifier referring to Scan Group", "type": "string" }, "IsActive": { "description": "A flag that indicates whether specific monitoring is active", "type": "boolean" }, "TrackSystemScans": { "description": "A flag that indicates if System Scans should be tracked", "type": "boolean" }, "TrackWebScans": { "description": "A flag that indicates whether Web Scans should be tracked", "type": "boolean" }, "AlwaysAddNewSystemScans": { "description": "A flag that indicates whether new System Scan should be added", "type": "boolean" }, "AlwaysAddNewWebScans": { "description": "A flag that indicates whether new Web Scan should be added", "type": "boolean" }, "RemoveSystemScanWhenUndiscovered": { "description": "A flag that indicates whether undiscovered System Scan should be removed", "type": "boolean" }, "RemoveWebScanWhenUndiscovered": { "description": "A flag that indicates whether undiscovered Web Scan should be removed", "type": "boolean" }, "AssetSourceType": { "$ref": "#/definitions/Radar.Model.Enums.AssetSourceTypes" }, "TrackedHttpPortRangeForWebScan": { "description": "An object that contains information about tracked ports for Web Scans (http service)", "type": "string" }, "TrackedHttpsPortRangeForWebScan": { "description": "An object that contains information about tracked ports for Web Scans (https service)", "type": "string" }, "RunSystemScanImmediatelyAfterAdd": { "description": "A flag that indicates whether the new detected System Scan should be started", "type": "boolean" }, "RunWebScanImmediatelyAfterAdd": { "description": "A flag that indicates whether the new detected Web Scan should be started", "type": "boolean" }, "ScheduleId": { "format": "uuid", "description": "A unique identifier referring to Schedule", "type": "string" }, "RunSystemScanImmediatelyIfNewServicesDiscovered": { "description": "A flag that indicates whether the System Scan with new service detected should be started", "type": "boolean" }, "TrackedSystemScanByHostname": { "description": "A flag that indicates whether System Scans should be tracked by hostname or IP address", "type": "boolean" }, "CrossCheckForSystemScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid System Scan duplicates", "type": "boolean" }, "CrossCheckForWebScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid Web Scan duplicates", "type": "boolean" } }, "additionalProperties": false }, "AssetMonitoringFilterViewModel": { "description": "View model for filter of asset monitoring", "type": "object", "properties": { "AssetSourceType": { "$ref": "#/definitions/Radar.Model.Enums.AssetSourceTypes" }, "ScheduleId": { "format": "uuid", "description": "A unique identifier referring to Schedule", "type": "string" }, "ScanGroupId": { "format": "uuid", "description": "A unique identifier referring to Scan Group", "type": "string" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "AssetMonitoringListViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "An asset monitoring unique identifier", "type": "string" }, "ScanGroupId": { "format": "uuid", "description": "A unique identifier referring to Scan Group", "type": "string" }, "IsActive": { "description": "A flag that indicates whether specific monitoring is active", "type": "boolean" }, "TrackSystemScans": { "description": "A flag that indicates if System Scans should be tracked", "type": "boolean" }, "TrackWebScans": { "description": "A flag that indicates whether Web Scans should be tracked", "type": "boolean" }, "AlwaysAddNewSystemScans": { "description": "A flag that indicates whether new System Scan should be added", "type": "boolean" }, "AlwaysAddNewWebScans": { "description": "A flag that indicates whether new Web Scan should be added", "type": "boolean" }, "RemoveSystemScanWhenUndiscovered": { "description": "A flag that indicates whether undiscovered System Scan should be removed", "type": "boolean" }, "RemoveWebScanWhenUndiscovered": { "description": "A flag that indicates whether undiscovered Web Scan should be removed", "type": "boolean" }, "AssetSourceType": { "$ref": "#/definitions/Radar.Model.Enums.AssetSourceTypes" }, "TrackedHttpPortRangeForWebScan": { "description": "An object that contains information about tracked ports for Web Scans (http service)", "type": "string" }, "TrackedHttpsPortRangeForWebScan": { "description": "An object that contains information about tracked ports for Web Scans (https service)", "type": "string" }, "RunSystemScanImmediatelyAfterAdd": { "description": "A flag that indicates whether the new detected System Scan should be started", "type": "boolean" }, "RunWebScanImmediatelyAfterAdd": { "description": "A flag that indicates whether the new detected Web Scan should be started", "type": "boolean" }, "ScheduleId": { "format": "uuid", "description": "A unique identifier referring to Schedule", "type": "string" }, "RunSystemScanImmediatelyIfNewServicesDiscovered": { "description": "A flag that indicates whether the System Scan with new service detected should be started", "type": "boolean" }, "TrackedSystemScanByHostname": { "description": "A flag that indicates whether System Scans should be tracked by hostname or IP address", "type": "boolean" }, "CrossCheckForSystemScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid System Scan duplicates", "type": "boolean" }, "CrossCheckForWebScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid Web Scan duplicates", "type": "boolean" } }, "additionalProperties": false }, "AssetMonitoringSimpleViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "An asset monitoring unique identifier", "type": "string" }, "IsActive": { "description": "Define if asset monitoring is active", "type": "boolean" }, "AssetSourceType": { "format": "int32", "description": "An asset monitoring type", "type": "integer" }, "DiscoveryScan": { "$ref": "#/definitions/SimpleDiscoveryScanAssetMonitoringViewModel" }, "InternetDiscovery": { "$ref": "#/definitions/SimpleInternetDiscoveryAssetMonitoringViewModel" }, "ScanGroup": { "$ref": "#/definitions/ScanGroupSimpleViewModel" } }, "additionalProperties": false }, "AssetName": { "type": "object", "properties": { "Value": { "type": "string" }, "IsAlias": { "type": "boolean" } }, "additionalProperties": false }, "AssetNoteViewModel": { "type": "object", "properties": { "Note": { "type": "string" } }, "additionalProperties": false }, "AssetRiskScoreStateEnum": { "description": "AssetRiskScore calcultion state", "enum": [ "CalculationCompleted", "CalculationInProgress", "CalculationError" ], "type": "string" }, "AssetViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "type": "string" }, "Name": { "$ref": "#/definitions/AssetName" }, "Note": { "type": "string" }, "EventDateOn": { "format": "date-time", "type": "string" }, "EventSourceVersion": { "format": "int32", "type": "integer", "readOnly": true }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "AssetsListViewModel": { "description": "A list that represents each row on Assets.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "An asset unique identifier", "type": "string" }, "AssetHostId": { "format": "uuid", "description": "An asset host unique identifier", "type": "string" }, "FriendlyName": { "description": "Friendly name of the asset", "type": "string" }, "LastUpdatedOn": { "format": "date-time", "description": "Last updated date", "type": "string" }, "LastSeenOn": { "format": "date-time", "description": "Last seen date", "type": "string" }, "LastScannedOn": { "format": "date-time", "description": "Last scanned date", "type": "string" }, "FirstDiscoveredOn": { "format": "date-time", "description": "First discovered date", "type": "string" }, "NumberOfPublicExploits": { "format": "int32", "description": "Number of public exploits, null if the information is not available", "type": "integer" }, "InternetExposure": { "description": "Defines asset host's internet exposure", "type": "boolean" }, "OnPublicInternet": { "description": "Defines asset host's internet exposure taken from EPP service", "type": "boolean" }, "ManualInternetExposure": { "description": "Internet exposure set manually by user", "type": "boolean" }, "VulnerabilitiesCritical": { "format": "int32", "description": "A number of vulnerabilitites with critical serverity", "type": "integer" }, "VulnerabilitiesHigh": { "format": "int32", "description": "A number of vulnerabilitites with high serverity", "type": "integer" }, "VulnerabilitiesMedium": { "format": "int32", "description": "A number of vulnerabilitites with medium serverity", "type": "integer" }, "VulnerabilitiesLow": { "format": "int32", "description": "A number of vulnerabilitites with low serverity", "type": "integer" }, "VulnerabilitiesInformational": { "format": "int32", "description": "A number of vulnerabilitites with informational serverity", "type": "integer" }, "Change": { "$ref": "#/definitions/ScanChange" }, "LastReportId": { "format": "uuid", "description": "A last report unique identifier", "type": "string" }, "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "Archived": { "description": "A flag that indicates if asset is archived", "type": "boolean" }, "DnsName": { "description": "Asset DNS name", "type": "string" }, "WinsName": { "description": "Asset wins name", "type": "string" }, "RiskScore": { "format": "double", "description": "Asset risk score", "type": "number" }, "RiskScoreState": { "$ref": "#/definitions/AssetRiskScoreStateEnum" }, "RiskScoreLastCalculatedOn": { "format": "date-time", "description": "Last asset risk score successfull calculation date", "type": "string" }, "Importance": { "format": "int32", "description": "Asset importance for risk score", "type": "integer" }, "CcrId": { "description": "An endpoint agent unique identifier installed on device", "type": "string" }, "CorrelationId": { "description": "An asset correlation id", "type": "string" }, "CorrelationVersion": { "description": "An asset correlation version", "type": "string" }, "DisplayName": { "description": "Asset display name", "type": "string" }, "Hostname": { "description": "Asset host name", "type": "string" }, "IpAddress": { "description": "Asset IP address", "type": "string" }, "MacAddress": { "description": "Asset mac address", "type": "string" }, "OperatingSystem": { "description": "Asset operating system", "type": "string" }, "DomainName": { "description": "Asset domain name", "type": "string" } }, "additionalProperties": false }, "AuthModeInput": { "type": "object", "properties": { "WindowsMode": { "$ref": "#/definitions/WindowsModes" }, "NtlmUserName": { "type": "string" }, "NtlmPassword": { "type": "string" }, "NtlmDomain": { "type": "string" }, "NtlmUseWSUS": { "type": "boolean" }, "NtlmUseMicrosoftUpdateServer": { "type": "boolean" }, "NtlmOfflineScanningActive": { "type": "boolean" }, "NtlmRemoteRegistryEnabled": { "type": "boolean" }, "NtlmRemoteRegistryStopPrevented": { "type": "boolean" }, "NtlmMsProductsUpdateEnabled": { "type": "boolean" }, "SSHEncryptionKeyName": { "type": "string" }, "SSHEncryptionKey": { "format": "byte", "type": "string" }, "SSHPort": { "type": "string" }, "SSHUsername": { "type": "string" }, "SSHPassPhrase": { "type": "string" }, "SSHPassword": { "type": "string" }, "SSHKey": { "type": "string" }, "SSHKeySpecified": { "type": "boolean" }, "SSHAuthenticationType": { "$ref": "#/definitions/SSHAuthenticationTypes" }, "NtlmAccountType": { "$ref": "#/definitions/AccountTypes" }, "CredentialType": { "$ref": "#/definitions/CredentialTypes" }, "XmlType": { "type": "string", "readOnly": true }, "WinrmUserName": { "type": "string" }, "WinrmPassword": { "type": "string" }, "WinrmUseWSUS": { "type": "boolean" }, "WinrmUseMicrosoftUpdateServer": { "type": "boolean" }, "WinrmOfflineScanningActive": { "type": "boolean" }, "WinrmMsProductsUpdateEnabled": { "type": "boolean" }, "WinrmPort": { "type": "string" }, "WinrmIsCertificateCheckSkipped": { "type": "boolean" }, "WinrmUseSSL": { "type": "boolean" }, "WinrmAccountType": { "$ref": "#/definitions/AccountTypes" }, "ApiPort": { "type": "string" }, "ApiDeviceType": { "type": "string" }, "ApiUserName": { "type": "string" }, "ApiPassword": { "type": "string" }, "ApiAccessToken": { "type": "string" }, "ApiAuthenticationType": { "$ref": "#/definitions/ApiAuthenticationTypes" }, "ApiIsCertificateCheckSkipped": { "type": "boolean" }, "ApiUseSSL": { "type": "boolean" }, "ApiEncryptionKey": { "format": "byte", "type": "string" }, "ApiEncryptionKeyName": { "description": "A key used to encrypt credential typed by user", "type": "string" }, "ApiIsEncryptionEnabled": { "type": "boolean" }, "SnmpPort": { "type": "string" }, "SnmpUserName": { "type": "string" }, "SnmpAuthenticationProtocol": { "type": "string" }, "SnmpPassword": { "type": "string" }, "SnmpIsEncryptionEnabled": { "type": "boolean" }, "SnmpPrivacyProtocol": { "type": "string" }, "SnmpPrivacyPassword": { "type": "string" } }, "additionalProperties": false }, "AuthenticationContextViewModel": { "type": "object", "properties": { "IsConsultant": { "description": "A flag that indicates that the user is consultant", "type": "boolean" }, "LoggedUserId": { "format": "uuid", "description": "A logged user account", "type": "string" }, "UserFirstName": { "description": "User's first name", "type": "string" }, "UserLastName": { "description": "An user name", "type": "string" }, "UserTimeZone": { "description": "User's time zone", "type": "string" }, "UserTimeZoneOffset": { "description": "An user time zone UTC offset", "type": "string" }, "UserAssignedToManyOrganizations": { "description": "Is user assigned to more than one organization", "type": "boolean" }, "SuccessfulLoginCount": { "format": "int32", "description": "Number of successful logins", "type": "integer" }, "AccountConfiguration": { "description": "A dictionary with account configuration e.g. enabled ticket management, dashboard visibility,", "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "AggregatedPrivileges": { "description": "An array with user privileges", "type": "array", "items": { "type": "string" } }, "IsActive": { "description": "A flag that indicates if the organization is active", "type": "boolean" }, "IsConsultantsOrganization": { "description": "A flag that indicates if it is a consultant organization", "type": "boolean" }, "OrganizationId": { "format": "uuid", "description": "Organization unique identifier", "type": "string" }, "PsbAccountId": { "format": "uuid", "description": "PSB Account unique identifier", "type": "string" }, "OrganizationName": { "description": "Organization name", "type": "string" }, "IsOrganizationManagedRemotely": { "description": "Is organizations synchronized with the managed service", "type": "boolean" }, "OrganizationType": { "$ref": "#/definitions/OrganizationTypes" }, "OrganizationIsTrial": { "description": "A flag that indicates if organization is trial", "type": "boolean" }, "TopOrganizationType": { "$ref": "#/definitions/OrganizationTypes" }, "TopOrganizationIds": { "description": "List of organizations where user is directly assigned, but only of highest type", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "AuthenticationMode": { "description": "Authentication Mode Enum.", "enum": [ "TwoFactorOnlyIfRequired", "AlwaysTwoFactor" ], "type": "string" }, "BaseFilterModel": { "type": "object", "properties": { "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "BatchAddTagsToAssetsViewModel": { "required": [ "AssetIds", "Tags" ], "type": "object", "properties": { "AssetIds": { "description": "A list of unique identifiers for Assets", "type": "array", "items": { "format": "uuid", "type": "string" } }, "Tags": { "description": "A string that contains tags to add or remove", "type": "array", "items": { "type": "string" } }, "Operation": { "$ref": "#/definitions/UpdateOperationsEnum" } }, "additionalProperties": false }, "BatchAddTagsToScansViewModel": { "required": [ "ScanIds", "Tags" ], "type": "object", "properties": { "Tags": { "description": "A string that contains tags to add or remove", "type": "array", "items": { "type": "string" } }, "Operation": { "$ref": "#/definitions/UpdateOperationsEnum" }, "ScanGroupIds": { "description": "A list of the scan group's unique identifiers to change the state for all its scans", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ScanIds": { "description": "A list of unique identifiers for Scans where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "StartPage": { "format": "int32", "description": "A start page", "type": "integer" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "VulnerabilityScansFilterModel": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } }, "additionalProperties": false }, "BatchConfigurationScanTemplatesViewModel": { "type": "object", "properties": { "Configuration": { "description": "A scan template configuration XML", "type": "string" }, "ScanTemplatesIds": { "description": "A list of unique identifiers for scan template IDs to change state", "type": "array", "items": { "format": "uuid", "type": "string" } } }, "additionalProperties": false }, "BatchMoveScanViewModel": { "required": [ "NewScanGroupId", "ScanIds" ], "type": "object", "properties": { "NewScanGroupId": { "format": "uuid", "description": "A new scan group unique identifier", "type": "string" }, "ScanGroupIds": { "description": "A list of the scan group's unique identifiers to change the state for all its scans", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ScanIds": { "description": "A list of unique identifiers for Scans where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "StartPage": { "format": "int32", "description": "A start page", "type": "integer" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "VulnerabilityScansFilterModel": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } }, "additionalProperties": false }, "BatchNetworkScanViewModel": { "description": "Base view model for discovery scans batch operations.", "required": [ "ScanIds" ], "type": "object", "properties": { "ScanIds": { "description": "A list of scan unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } } }, "additionalProperties": false }, "BatchScanTemplatesViewModel": { "type": "object", "properties": { "ScanTemplatesIds": { "description": "A list of unique identifiers for scan template IDs to change state", "type": "array", "items": { "format": "uuid", "type": "string" } } }, "additionalProperties": false }, "BatchScanViewModel": { "required": [ "ScanIds" ], "type": "object", "properties": { "ScanGroupIds": { "description": "A list of the scan group's unique identifiers to change the state for all its scans", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ScanIds": { "description": "A list of unique identifiers for Scans where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "StartPage": { "format": "int32", "description": "A start page", "type": "integer" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "VulnerabilityScansFilterModel": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } }, "additionalProperties": false }, "BatchSchedulingTemplatesViewModel": { "type": "object", "properties": { "SchedulingTemplatesIds": { "description": "A list of unique identifiers of scheduling template IDs to modify", "type": "array", "items": { "format": "uuid", "type": "string" } } }, "additionalProperties": false }, "BatchUpdateAssetsBusinessOwnerResponsibilitiesViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset business owner responsibilities", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsBusinessOwnerViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset business owner name", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsContactsViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset contacts", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsContractAndInvoicingViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset contract and invoicing", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsCountryViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset country", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsCustomerPersonalDataCategoryViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset customer personal data category", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsCustomerPersonalDataStoredViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset customer personal data stored", "type": "boolean" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsCustomerPersonalDataVolumeViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset customer personal data valume", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsDepartmentViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset department", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsEmployeePersonalDataCategoryViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset employee personal data category", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsEmployeePersonalDataStoredViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset employee personal data stored", "type": "boolean" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsEmployeePersonalDataVolumeViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset employee personal data valume", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsImportanceViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Importance": { "format": "int32", "description": "An asset importnace for risk score", "maximum": 1, "minimum": -1, "type": "integer" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsIntellectualPropertyRightsViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset intellectual property rights", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsInternetExposureViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "A value indicating whether asset host is exposed to internet", "type": "boolean" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsManufacturerViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset manufacturer", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsNetworkEnvironmentViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset network environment", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsNotes": { "type": "object", "properties": { "AssetIds": { "description": "A list of asset unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "Note": { "description": "A note to update", "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsPurposeOfApplicationViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset purpose of application", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsServerHostedInViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset server hosted in", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsServiceOwnerResponsibilitiesViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset service owner responsibilities", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsServiceOwnerViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset service owner", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsTechnicalDocumentationViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset technical documentation", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsUndefinedResponsibilitiesViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset undefined responsibilities", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsVendorResponsibilitiesViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset vendor responsibilities", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateAssetsVendorViewModel": { "required": [ "AssetHostIds" ], "type": "object", "properties": { "Value": { "description": "An asset vendor", "type": "string" }, "AssetHostIds": { "description": "A list of unique identifiers for Assets host where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TransactionId": { "type": "string" } }, "additionalProperties": false }, "BatchUpdateScanConfigurationViewModel": { "required": [ "Configuration", "ScanIds" ], "type": "object", "properties": { "Configuration": { "description": "A new schedule unique identifier", "minLength": 1, "type": "string" }, "ScanGroupIds": { "description": "A list of the scan group's unique identifiers to change the state for all its scans", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ScanIds": { "description": "A list of unique identifiers for Scans where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "StartPage": { "format": "int32", "description": "A start page", "type": "integer" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "VulnerabilityScansFilterModel": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } }, "additionalProperties": false }, "BatchUpdateScanScheduleViewModel": { "required": [ "NewScheduleId", "ScanIds" ], "type": "object", "properties": { "NewScheduleId": { "format": "uuid", "description": "A new schedule unique identifier", "type": "string" }, "ScanGroupIds": { "description": "A list of the scan group's unique identifiers to change the state for all its scans", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ScanIds": { "description": "A list of unique identifiers for Scans where the state is changed", "type": "array", "items": { "format": "uuid", "type": "string" } }, "StartPage": { "format": "int32", "description": "A start page", "type": "integer" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "VulnerabilityScansFilterModel": { "$ref": "#/definitions/VulnerabilityScansFilterModel" } }, "additionalProperties": false }, "BatchUpdateScheduleNetworkScanViewModel": { "description": "View model for discovery scans update schedule operation.", "required": [ "NewScheduleId", "ScanIds" ], "type": "object", "properties": { "NewScheduleId": { "format": "uuid", "description": "A new schedule unique identifier", "type": "string" }, "ScanIds": { "description": "A list of scan unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } } }, "additionalProperties": false }, "BatchUpdateTemplateNetworkScanViewModel": { "description": "View model for discovery scans update scan template operation.", "required": [ "NewTemplateId", "ScanIds" ], "type": "object", "properties": { "NewTemplateId": { "format": "uuid", "description": "A unique identifier's new template", "type": "string" }, "ScanIds": { "description": "A list of scan unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } } }, "additionalProperties": false }, "CVSSVersion": { "format": "int32", "description": "Represents possible types of CVSS Versions.", "enum": [ 2, 3 ], "type": "integer" }, "ChangeTicketStatusViewModel": { "description": "New ticket status parameters.", "type": "object", "properties": { "NewStatusId": { "format": "uuid", "description": "New ticket status", "type": "string" }, "OrderRescanOfAllConnectedHosts": { "description": "If hosts should be queued for scanning", "type": "boolean" }, "AutoCloseVulnerabilityInstances": { "description": "When changing the ticket status to fixed, choose if you want to automatically close all vulnerabilities", "type": "boolean" } }, "additionalProperties": false }, "Collection[AddUsersToGroupViewModel]": { "type": "array", "items": { "$ref": "#/definitions/AddUsersToGroupViewModel" } }, "Collection[ChangelogDataViewModel]": { "type": "array", "items": { "$ref": "#/definitions/ChangelogDataViewModel" } }, "Collection[DiscoveryScansListViewModel]": { "type": "array", "items": { "$ref": "#/definitions/DiscoveryScansListViewModel" } }, "Collection[GroupCountViewModel]": { "type": "array", "items": { "$ref": "#/definitions/GroupCountViewModel" } }, "Collection[MessageNotificationViewModel]": { "type": "array", "items": { "$ref": "#/definitions/MessageNotificationViewModel" } }, "Collection[NameIdItem[Guid]]": { "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "Collection[NameValueItem[Int32]]": { "type": "array", "items": { "$ref": "#/definitions/NameValueItem[Int32]" } }, "Collection[NameValueItem[String]]": { "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "Collection[NumberOfVulnerabilityByCategoryViewModel]": { "type": "array", "items": { "$ref": "#/definitions/NumberOfVulnerabilityByCategoryViewModel" } }, "Collection[OrganizationBasicInfoViewModel]": { "type": "array", "items": { "$ref": "#/definitions/OrganizationBasicInfoViewModel" } }, "Collection[ReportFindingsAndChangeViewModel]": { "type": "array", "items": { "$ref": "#/definitions/ReportFindingsAndChangeViewModel" } }, "Collection[ReportScanHistoryViewModel]": { "type": "array", "items": { "$ref": "#/definitions/ReportScanHistoryViewModel" } }, "Collection[RoleViewModel]": { "type": "array", "items": { "$ref": "#/definitions/RoleViewModel" } }, "Collection[RssDataViewModel]": { "type": "array", "items": { "$ref": "#/definitions/RssDataViewModel" } }, "Collection[ScanPortSimpleViewModel]": { "type": "array", "items": { "$ref": "#/definitions/ScanPortSimpleViewModel" } }, "Collection[ScanPortViewModel]": { "type": "array", "items": { "$ref": "#/definitions/ScanPortViewModel" } }, "Collection[ScanViewModel]": { "type": "array", "items": { "$ref": "#/definitions/ScanViewModel" } }, "Collection[ScanningProgressViewModel]": { "type": "array", "items": { "$ref": "#/definitions/ScanningProgressViewModel" } }, "Collection[SimpleTicketViewModel]": { "type": "array", "items": { "$ref": "#/definitions/SimpleTicketViewModel" } }, "Collection[SimpleUserViewModel]": { "type": "array", "items": { "$ref": "#/definitions/SimpleUserViewModel" } }, "Collection[SummaryReportUpdateViewModel]": { "type": "array", "items": { "$ref": "#/definitions/SummaryReportUpdateViewModel" } }, "Collection[SystemTimeZonesViewModel]": { "type": "array", "items": { "$ref": "#/definitions/SystemTimeZonesViewModel" } }, "Collection[TagViewModel]": { "type": "array", "items": { "$ref": "#/definitions/TagViewModel" } }, "Collection[VulnerabilityCategoryViewModel]": { "type": "array", "items": { "$ref": "#/definitions/VulnerabilityCategoryViewModel" } }, "Collection[VulnerabilityScansListViewModel]": { "type": "array", "items": { "$ref": "#/definitions/VulnerabilityScansListViewModel" } }, "Collection[VulnerabilityStatusViewModel]": { "type": "array", "items": { "$ref": "#/definitions/VulnerabilityStatusViewModel" } }, "Collection[VulnerabilityStatuses]": { "type": "array", "items": { "$ref": "#/definitions/VulnerabilityStatuses" } }, "Collection[WebScanReportVulnerabilityCategoryViewModel]": { "type": "array", "items": { "$ref": "#/definitions/WebScanReportVulnerabilityCategoryViewModel" } }, "Collection[WebScanVulnerabilityCategory]": { "type": "array", "items": { "$ref": "#/definitions/WebScanVulnerabilityCategory" } }, "CompliantLevel": { "description": "Represents compliant indicator possible values.", "enum": [ "NotCompliant", "Compliant" ], "type": "string" }, "CompliantType": { "description": "Enumerable for compliant types (PCI ...)", "enum": [ "Standard", "PCI" ], "type": "string" }, "ConfigType": { "enum": [ "SystemScan", "WebScan", "DiscoveryScan" ], "type": "string" }, "ContactInformation": { "type": "object", "properties": { "Address": { "description": "Address", "type": "string" }, "City": { "description": "City", "type": "string" }, "Company": { "description": "Company name", "type": "string" }, "Contact": { "description": "Contact person", "type": "string" }, "Country": { "description": "Country", "type": "string" }, "Email": { "description": "Email address", "type": "string" }, "Province": { "description": "Province", "type": "string" }, "Telephone": { "description": "Contact telephone number", "type": "string" }, "Title": { "description": "Contact person title", "type": "string" }, "URL": { "description": "URL", "type": "string" }, "ZIP": { "description": "ZIP code", "type": "string" } }, "additionalProperties": false }, "CreateDiscoveryScanDefinitionViewModel": { "description": "Represents a Discovery Scan create parameters.", "required": [ "ScanNodeId", "ScanTargets", "ScheduleOption", "TemplateId" ], "type": "object", "properties": { "ScanTargets": { "description": "A list of discovery scan targets", "type": "array", "items": { "$ref": "#/definitions/DiscoveryScanDefinitionScanTargetViewModel" } }, "MessageNotification": { "description": "Message notifications", "type": "array", "items": { "$ref": "#/definitions/MessageNotificationViewModel" } }, "ScanNodeId": { "format": "uuid", "description": "A unique identifier for a discovery scan node", "type": "string" }, "ScheduleOption": { "$ref": "#/definitions/ScheduleOptionViewModel" }, "TemplateId": { "format": "uuid", "description": "A discovery scan template unique identifier", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "CreateDiscoveryScanTemplateViewModel": { "required": [ "Name" ], "type": "object", "properties": { "Name": { "description": "A discovery scan template name", "minLength": 1, "type": "string" }, "Description": { "description": "A discovery scan template description", "type": "string" }, "Configuration": { "$ref": "#/definitions/DiscoveryScanCustomConfigurationViewModel" } }, "additionalProperties": false }, "CreateEncryptionKeyViewModel": { "description": "Represents encryption key.", "type": "object", "properties": { "File": { "description": "A file with secretkey", "type": "string" }, "Id": { "format": "uuid", "description": "An encryption key unique identifier", "type": "string" }, "Name": { "description": "An encryption key name", "type": "string" }, "IsDefault": { "description": "Is encryption key default", "type": "boolean" }, "Description": { "description": "An encryption key description", "type": "string" }, "Format": { "description": "An encryption key format", "type": "string" } }, "additionalProperties": false }, "CreateScanGroupViewModel": { "description": "Parameters to create a new Scan Group.", "required": [ "MessageNotification", "ResponsiblePersonId", "ScanGroupName" ], "type": "object", "properties": { "SystemScanSettingsEnabled": { "description": "A scan type that will be enabled. Either SystemScanSettingsEnabled or WebScanSettingsEnabled may be enabled", "type": "boolean" }, "WebScanSettingsEnabled": { "description": "A scan type that will be enabled. Either SystemScanSettingsEnabled or WebScanSettingsEnabled may be enabled", "type": "boolean" }, "ScanGroupName": { "description": "A scan group name", "minLength": 1, "type": "string" }, "ScanTargets": { "description": "Scan targets", "type": "array", "items": { "$ref": "#/definitions/TargetScanViewModel" } }, "ScanDescription": { "description": "A scan description", "type": "string" }, "ResponsiblePersonId": { "format": "uuid", "description": "An ID of a person in charge", "type": "string" }, "MaxSystemScans": { "format": "int32", "description": "Maximum System Scans", "type": "integer" }, "MaxWebScans": { "format": "int32", "description": "Maximum Web Scans", "type": "integer" }, "SystemScanTemplateId": { "format": "uuid", "description": "A unique identifier for System Scan template", "type": "string" }, "WebScanTemplateId": { "format": "uuid", "description": "A unique identifier for Web Scan template", "type": "string" }, "SystemScanNodeId": { "format": "uuid", "description": "A unique identifier for System Scan node", "type": "string" }, "WebScanNodeId": { "format": "uuid", "description": "A unique identifier for Web Scan node", "type": "string" }, "SystemScanScheduleId": { "format": "uuid", "description": "A unique identifier for System Scan node", "type": "string" }, "WebScanScheduleId": { "format": "uuid", "description": "Web Scan schedule unique identifier", "type": "string" }, "MessageNotification": { "description": "A message notification", "type": "array", "items": { "$ref": "#/definitions/MessageNotificationViewModel" } }, "Tags": { "description": "Scan Group tags", "type": "array", "items": { "type": "string" } }, "ScanningMode": { "$ref": "#/definitions/ScanningMode" }, "AssetMonitoringConfigurations": { "description": "Asset monitoring configurations", "type": "array", "items": { "$ref": "#/definitions/ScanGroupAssetMonitoringViewModel" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "CreateScanNodeSettingsViewModel": { "description": "Scan node settings for creating.", "required": [ "ScanNodeType" ], "type": "object", "properties": { "Name": { "description": "Scan node name", "type": "string" }, "Description": { "description": "Scan node description", "type": "string" }, "NodeIdentifier": { "format": "uuid", "description": "Node unique identifier for scan node", "type": "string" }, "ScanNodeType": { "$ref": "#/definitions/ScanNodeTypes" }, "LastSeenWarnMinutes": { "format": "int32", "description": "How many minutes a scan node is not available before a warning appears", "type": "integer" }, "DefaultLastSeenWarnMinutes": { "format": "int32", "description": "Default value how many minutes a scan node is not available before a warning appears", "type": "integer" }, "IsUsingDefaultLastSeenWarnMinutes": { "description": "Is using deafult setting for condition to show warning about last seen scan node", "type": "boolean" }, "PoolingOnNode": { "$ref": "#/definitions/PoolingOnNode" }, "PoolingOnNodeViewModel": { "$ref": "#/definitions/ScanNodePoolingOnNodeViewModel" } }, "additionalProperties": false }, "CreateTicketViewModel": { "description": "Create ticket view model.", "type": "object", "properties": { "DeadlineDate": { "format": "date-time", "description": "A deadline date and time (UTC)", "type": "string" }, "Description": { "description": "A description", "type": "string" }, "Estimate": { "format": "int32", "description": "An estimate. In hours", "type": "integer" }, "Name": { "description": "A ticket name", "type": "string" }, "Priority": { "format": "int32", "description": "A ticket priority", "type": "integer" }, "WorkHours": { "format": "int32", "description": "Work hours. In hours", "type": "integer" }, "WorkRemaining": { "format": "int32", "description": "Work remaining. In hours", "type": "integer" }, "AssignedToId": { "format": "uuid", "description": "An unique identifier of user assigned to ticket", "type": "string" }, "VulnerabilityInstanceIds": { "description": "A list of vulnerability instances unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "VulnerabilityIds": { "description": "A list of vulnerability unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "WebScanVulnerabilitiesSearchKeyViewModel": { "description": "A list of search keys for vulnerability instances", "type": "array", "items": { "$ref": "#/definitions/WebScanVulnerabilitiesSearchKeyViewModel" } }, "WSVulnerabilityInstanceIds": { "description": "A list of unique identifiers for Web Scan vulnerability instances", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TicketVulnerabilitiesOnSiteFilter": { "$ref": "#/definitions/VulnerabilitiesOnSiteFilter" }, "TicketVulnerabilitiesOnHostFilter": { "$ref": "#/definitions/VulnerabilitiesOnHostFilter" } }, "additionalProperties": false }, "CreateWebScanViewModel": { "description": "Parameters for updating the existing Scan Group.", "required": [ "MessageNotification" ], "type": "object", "properties": { "ScanTargetUrl": { "description": "Target URL for a Web Scan", "type": "string" }, "Name": { "description": "A Web Scan name", "type": "string" }, "AssignedToId": { "format": "uuid", "description": "Unique identifier for the assigned user of a Web Scan", "type": "string" }, "ScanGroupId": { "format": "uuid", "description": "A Scan Group unique identifier", "type": "string" }, "CustomConfiguration": { "$ref": "#/definitions/WebScanCustomConfigurationViewModel" }, "ScheduleId": { "format": "uuid", "description": "Web Scan schedule unique identifier", "type": "string" }, "Recording": { "$ref": "#/definitions/WebScanRecordingUploadViewModel" }, "MessageNotification": { "description": "A Web Scan message notification", "type": "array", "items": { "$ref": "#/definitions/MessageNotificationViewModel" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "CredentialTypes": { "enum": [ "None", "NTLM", "SSH", "WINRM", "Api", "SNMP" ], "type": "string" }, "DayOfWeek": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "DeleteActionTypeEnum": { "description": "How data will be deleted.", "enum": [ "Normal", "InBackground" ], "type": "string" }, "DeviceInfoDto": { "type": "object", "properties": { "CcrId": { "type": "string" }, "DeviceServiceDeviceVisibleType": { "type": "string" }, "DeviceServiceDeviceType": { "type": "string" } }, "additionalProperties": false }, "Dictionary[Guid][Boolean]": { "properties": { "key": { "type": "Guid" }, "value": { "type": "Boolean" } } }, "Dictionary[Guid][String[]]": { "properties": { "key": { "type": "Guid" }, "value": { "type": "String[]" } } }, "Dictionary[string][AffectedHostsFilterViewModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "AffectedHostsFilterViewModel" } } }, "Dictionary[string][AffectedSitesFilterViewModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "AffectedSitesFilterViewModel" } } }, "Dictionary[string][BaseFilterModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "BaseFilterModel" } } }, "Dictionary[string][HostsFilterViewModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "HostsFilterViewModel" } } }, "Dictionary[string][Int32]": { "properties": { "key": { "type": "string" }, "value": { "type": "Int32" } } }, "Dictionary[string][LogsFilterViewModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "LogsFilterViewModel" } } }, "Dictionary[string][NetworkFilterViewModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "NetworkFilterViewModel" } } }, "Dictionary[string][Object]": { "properties": { "key": { "type": "string" }, "value": { "type": "Object" } } }, "Dictionary[string][PortsFilterModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "PortsFilterModel" } } }, "Dictionary[string][SummaryReportsFilterModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "SummaryReportsFilterModel" } } }, "Dictionary[string][TicketsFilterViewModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "TicketsFilterViewModel" } } }, "Dictionary[string][UserFilterViewModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "UserFilterViewModel" } } }, "Dictionary[string][VulnerabilitiesAndFindingsFilterModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "VulnerabilitiesAndFindingsFilterModel" } } }, "Dictionary[string][VulnerabilitiesOnHostFilter]": { "properties": { "key": { "type": "string" }, "value": { "type": "VulnerabilitiesOnHostFilter" } } }, "Dictionary[string][VulnerabilitiesOnSiteFilter]": { "properties": { "key": { "type": "string" }, "value": { "type": "VulnerabilitiesOnSiteFilter" } } }, "Dictionary[string][VulnerabilityFilterViewModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "VulnerabilityFilterViewModel" } } }, "Dictionary[string][VulnerabilityScanTemplatesFilterModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "VulnerabilityScanTemplatesFilterModel" } } }, "Dictionary[string][VulnerabilityScansFilterModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "VulnerabilityScansFilterModel" } } }, "Dictionary[string][WebScanReportFilterModel]": { "properties": { "key": { "type": "string" }, "value": { "type": "WebScanReportFilterModel" } } }, "Dictionary[string][string]": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "DiscoveredAssetPortsViewModel": { "description": "Discovered asset port and service.", "required": [ "Port", "Protocol" ], "type": "object", "properties": { "Port": { "format": "int32", "description": "Discovered asset port (mandatory)", "type": "integer" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" }, "Service": { "description": "Discovered asset service (lowercase). Use 'http' or 'https' for discovered web applications (optional)", "type": "string" } }, "additionalProperties": false }, "DiscoveredAssetViewModel": { "description": "Discovered assets for custom assets upload.", "required": [ "IpAddress" ], "type": "object", "properties": { "HostName": { "description": "Discovered assets host name (optional)", "type": "string" }, "IpAddress": { "description": "Discovered assets IP address", "minLength": 1, "type": "string" }, "NewPortsOrServicesDiscovered": { "description": "Was a new service or port discovered for this asset when compared to the previous asset upload", "type": "boolean" }, "DiscoveredAssetPorts": { "description": "Collection of discovered ports and services along with the asset (optional)", "type": "array", "items": { "$ref": "#/definitions/DiscoveredAssetPortsViewModel" } } }, "additionalProperties": false }, "DiscoveredPagesViewModel": { "description": "Represents discovered pages.", "type": "object", "properties": { "NumberOfPages": { "format": "int64", "description": "A number of discovered pages", "type": "integer" }, "DiscoveredPagesStructure": { "description": "A structure of discovered pages", "type": "array", "items": { "$ref": "#/definitions/ElementOfStructure" } } }, "additionalProperties": false }, "DiscoveryHostChanges": { "enum": [ "Unchanged", "IPaddress", "OperatingSystem", "Ports", "Status", "NewHost" ], "type": "string" }, "DiscoveryHostScanPortViewModel": { "type": "object", "properties": { "Number": { "format": "int32", "description": "Host number", "type": "integer" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" } }, "additionalProperties": false }, "DiscoveryHostStatuses": { "enum": [ "Offline", "Online", "OnlineWithPing" ], "type": "string" }, "DiscoveryHostViewModel": { "description": "Represents Discovery Scan report hosts.", "type": "object", "properties": { "Change": { "$ref": "#/definitions/DiscoveryScansPortsChangedEnum" }, "Hostname": { "description": "A host name", "type": "string" }, "Id": { "format": "uuid", "description": "A host instance object unique identifier", "type": "string" }, "IPAddress": { "description": "Host IP address", "type": "string" }, "MacAddress": { "description": "Host MAC address", "type": "string" }, "OperatingSystem": { "description": "Host operating system", "type": "string" }, "Ports": { "$ref": "#/definitions/Ports" }, "PreviousIPAddress": { "description": "IP address of previous host", "type": "string" }, "PreviousOperatingSystem": { "description": "Operating system of previous host", "type": "string" }, "PreviousStatus": { "description": "Status of previous host", "type": "string" }, "Status": { "description": "Host status", "type": "string" }, "SystemScanId": { "format": "uuid", "description": "The VulnerabiliyScan's unique identifier", "type": "string" }, "SystemScanLastReportId": { "format": "uuid", "description": "The VulnerabiliyScan's unique identifier latest report", "type": "string" } }, "additionalProperties": false }, "DiscoveryScanAssetMonitoringViewModel": { "type": "object", "properties": { "DiscoveryScanId": { "format": "uuid", "description": "A unique identifier referring to discovery scan", "type": "string" }, "ScanGroupId": { "format": "uuid", "description": "A unique identifier referring to Scan Group", "type": "string" }, "IsActive": { "description": "A flag that indicates whether specific monitoring is active", "type": "boolean" }, "TrackSystemScans": { "description": "A flag that indicates if System Scans should be tracked", "type": "boolean" }, "TrackWebScans": { "description": "A flag that indicates whether Web Scans should be tracked", "type": "boolean" }, "AlwaysAddNewSystemScans": { "description": "A flag that indicates whether new System Scan should be added", "type": "boolean" }, "AlwaysAddNewWebScans": { "description": "A flag that indicates whether new Web Scan should be added", "type": "boolean" }, "RemoveSystemScanWhenUndiscovered": { "description": "A flag that indicates whether undiscovered System Scan should be removed", "type": "boolean" }, "RemoveWebScanWhenUndiscovered": { "description": "A flag that indicates whether undiscovered Web Scan should be removed", "type": "boolean" }, "AssetSourceType": { "$ref": "#/definitions/Radar.Model.Enums.AssetSourceTypes" }, "TrackedHttpPortRangeForWebScan": { "description": "An object that contains information about tracked ports for Web Scans (http service)", "type": "string" }, "TrackedHttpsPortRangeForWebScan": { "description": "An object that contains information about tracked ports for Web Scans (https service)", "type": "string" }, "RunSystemScanImmediatelyAfterAdd": { "description": "A flag that indicates whether the new detected System Scan should be started", "type": "boolean" }, "RunWebScanImmediatelyAfterAdd": { "description": "A flag that indicates whether the new detected Web Scan should be started", "type": "boolean" }, "ScheduleId": { "format": "uuid", "description": "A unique identifier referring to Schedule", "type": "string" }, "RunSystemScanImmediatelyIfNewServicesDiscovered": { "description": "A flag that indicates whether the System Scan with new service detected should be started", "type": "boolean" }, "TrackedSystemScanByHostname": { "description": "A flag that indicates whether System Scans should be tracked by hostname or IP address", "type": "boolean" }, "CrossCheckForSystemScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid System Scan duplicates", "type": "boolean" }, "CrossCheckForWebScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid Web Scan duplicates", "type": "boolean" } }, "additionalProperties": false }, "DiscoveryScanCustomConfigurationViewModel": { "type": "object", "properties": { "ScanMode": { "$ref": "#/definitions/DiscoveryScanModeEnum" }, "TcpPortRange": { "description": "A TCP port range", "type": "string" }, "UdpPortRange": { "description": "A UDP port range", "type": "string" }, "DetectOSEnabled": { "description": "A flag that indicates if operating system detection is enabled", "type": "boolean" }, "ProceedIfNoPing": { "description": "A flag that indicates if \"proceed if no ping\" is in use", "type": "boolean" }, "ScanIntensity": { "$ref": "#/definitions/ScanningPerformances" }, "MultithreadedMode": { "$ref": "#/definitions/NumberOfThreadsEnum" }, "DoubleModeEnabled": { "description": "A flag that indicates if double mode is enabled", "type": "boolean" }, "FragmentScanModeEnabled": { "description": "A flag that indicated if fragment scan mode is enabled", "type": "boolean" }, "RemoveBogusHostsTtl": { "description": "A flag indicating whether TTL-based host filter is enabled", "type": "boolean" }, "DebugMode": { "description": "A flag that indicates if debug mode is enabled", "default": false, "type": "boolean" }, "VerboseMode": { "description": "A flag that indicates if verbose mode is enabled", "default": false, "type": "boolean" } }, "additionalProperties": false }, "DiscoveryScanDefinitionScanTargetViewModel": { "description": "Represents a Discovery Scan targets.", "type": "object", "properties": { "Exclude": { "description": "An IP address exclusion range for discovery scans", "type": "string" }, "Name": { "description": "A display name for a discovery scan", "type": "string" }, "Range": { "description": "A discovery scan IP address range", "type": "string" } }, "additionalProperties": false }, "DiscoveryScanModeEnum": { "enum": [ "HostDiscovery", "Top100PortScan", "Top1000PortScan", "FullRange", "CustomPortScan" ], "type": "string" }, "DiscoveryScanOverviewPortsStatisticsViewModel": { "description": "Ports statistics as name protocol, number and count this ports.", "type": "object", "properties": { "Count": { "format": "int32", "description": "Number of ports", "type": "integer" }, "Label": { "description": "Protocol and port", "type": "string" } }, "additionalProperties": false }, "DiscoveryScanOverviewViewModel": { "type": "object", "properties": { "NetworkHostScanned": { "description": "A discovery scan host scanned amount", "type": "string" }, "NetworkHostStatistics": { "$ref": "#/definitions/NetworkHostStatisticsViewModel" }, "OpenPorts": { "description": "Discovery scan hosts with open ports", "type": "array", "items": { "$ref": "#/definitions/NetworkHostWithPortsViewModel" } }, "Ports": { "description": "Discovery scan hosts", "type": "array", "items": { "$ref": "#/definitions/NetworkHostWithPortsViewModel" } }, "PortsStatistics": { "description": "A list with port statistics", "type": "array", "items": { "$ref": "#/definitions/DiscoveryScanOverviewPortsStatisticsViewModel" } } }, "additionalProperties": false }, "DiscoveryScanReportViewModel": { "type": "object", "properties": { "ScanStartDate": { "format": "date-time", "description": "A scan start date and time", "type": "string" }, "ScanEndDate": { "format": "date-time", "description": "A scan start date and time", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "DiscoveryScanSchedulingModes": { "description": "Represents a scheduling modes.", "enum": [ "None", "ScheduleTemplate", "OneTimeScheduling" ], "type": "string" }, "DiscoveryScanSimpleViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A scan unique identifier", "type": "string" }, "Name": { "description": "A scan name", "type": "string" }, "ScanRunState": { "$ref": "#/definitions/ScanRunStateType" } }, "additionalProperties": false }, "DiscoveryScanTemplatesFilterModel": { "type": "object", "properties": { "ConfigTypes": { "description": "A list of config types", "type": "array", "items": { "$ref": "#/definitions/ConfigType" } }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "DiscoveryScanTemplatesListViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A discovery scan template unique identifier", "type": "string" }, "Name": { "description": "A discovery scan template name", "type": "string" }, "Description": { "description": "A discovery scan template description", "type": "string" }, "Type": { "$ref": "#/definitions/ScanType" }, "AssignedScans": { "format": "int32", "description": "Get or set number of assigned scan groups", "type": "integer" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Created": { "format": "date-time", "description": "Get or set the creation date for a created discovery scan template", "type": "string" }, "IsLocked": { "description": "Get or set a value indicating whether the discovery scan template is locked", "type": "boolean" } }, "additionalProperties": false }, "DiscoveryScanViewModel": { "description": "Represents a Discovery Scan definition view model.", "type": "object", "properties": { "CanStartScan": { "description": "A flag that indicates if the scan can start", "type": "boolean" }, "Exclude": { "description": "An IP address exclusion range for discovery scans", "type": "string" }, "Id": { "format": "uuid", "description": "A discovery scan unique identifier", "type": "string" }, "LastReportId": { "format": "uuid", "description": "A unique identifier of the last discovery scan report", "type": "string" }, "Name": { "description": "An IP address range for discovery scans", "type": "string" }, "Range": { "description": "A discovery scan IP address range", "type": "string" }, "ReportId": { "format": "uuid", "description": "A unique identifier for the discovery scan report object", "type": "string" }, "ResponsibleUser": { "$ref": "#/definitions/NameIdItem[Guid]" }, "ScanLastCompleted": { "format": "date-time", "description": "A date and time when scan last completed", "type": "string" }, "ScanLastSeen": { "format": "date-time", "description": "Date and time when the scan was last seen (scan is alive)", "type": "string" }, "ScanNode": { "$ref": "#/definitions/NameIdItem[Guid]" }, "ScanNodeId": { "format": "uuid", "description": "A unique identifier for a discovery scan node", "type": "string" }, "ScanRunState": { "$ref": "#/definitions/ScanRunStateType" }, "ScanStatistics": { "description": "A statistics object of a discovery scan" }, "ScanTemplate": { "$ref": "#/definitions/NameIdItem[Guid]" }, "ScheduleOption": { "$ref": "#/definitions/ScheduleOptionViewModel" }, "AssetMonitorings": { "description": "Asset monitoring related to a discovery scan", "type": "array", "items": { "$ref": "#/definitions/AssetMonitoringSimpleViewModel" } }, "TemplateId": { "format": "uuid", "description": "A discovery scan template unique identifier", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "DiscoveryScansListSummaryViewModel": { "description": "Summary information retrieved by the list view.", "type": "object", "properties": { "LiveHosts": { "format": "int32", "description": "Number of hosts discovered so far", "type": "integer" }, "QueuedScans": { "format": "int32", "description": "Number of queued scans", "type": "integer" }, "RunningScans": { "format": "int32", "description": "Number of running scans", "type": "integer" }, "TotalScans": { "format": "int32", "description": "Total number of scans", "type": "integer" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "DiscoveryScansListViewModel": { "description": "A list that represents each row on Discovery Scans.", "type": "object", "properties": { "CanStartScan": { "description": "A flag that indicates if the scan can start", "type": "boolean" }, "CreatedBy": { "$ref": "#/definitions/NameIdItem[Guid]" }, "HostWentOffline": { "format": "int32", "description": "A number of hosts which went offline since the last scan (in comparison to the previous scan)", "type": "integer" }, "HostWentOnline": { "format": "int32", "description": "A number of hosts which went online since the last scan (in comparison to the previous scan)", "type": "integer" }, "Id": { "format": "uuid", "description": "A scan unique identifier", "type": "string" }, "LastReportId": { "format": "uuid", "description": "A unique identifier of the last discovery scan report", "type": "string" }, "LiveHostsCount": { "format": "int32", "description": "A number of hosts discovered during the last scan", "type": "integer" }, "Name": { "description": "Name of the scan", "type": "string" }, "PortsChanged": { "description": "A flag that indicates a change in ports in the last discovery scan (in comparison to the previous scan)", "type": "boolean" }, "Range": { "description": "A defined scanning range", "type": "string" }, "RunDateTime": { "format": "date-time", "description": "A date and time when scan will be run once (in run once mode)", "type": "string" }, "ScanLastCompleted": { "format": "date-time", "description": "A date and time when scan last completed", "type": "string" }, "ScanLastSeen": { "format": "date-time", "description": "Date and time when the scan was last seen (scan is alive)", "type": "string" }, "ScanNodeId": { "format": "uuid", "type": "string" }, "ScanNodeName": { "type": "string" }, "ScanRunState": { "$ref": "#/definitions/ScanRunStateType" }, "ScanStatistics": { "description": "Optional statistics if the scan is running" }, "ScanTemplate": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Schedule": { "$ref": "#/definitions/NameIdItem[Guid]" }, "HasAssetMonitoring": { "description": "Defines if the discovery scan has asset-related monitoring", "type": "boolean" } }, "additionalProperties": false }, "DiscoveryScansPortsChangedEnum": { "enum": [ "Many", "Ports", "No", "Status", "NewHost", "IP", "OS" ], "type": "string" }, "DiscoveryTemplatesListDetailsViewModel": { "type": "object", "properties": { "AssignedDiscoveryScans": { "description": "List of assigned discovery scans", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "Configuration": { "$ref": "#/definitions/DiscoveryScanCustomConfigurationViewModel" }, "Id": { "format": "uuid", "description": "A discovery scan template unique identifier", "type": "string" }, "Name": { "description": "A discovery scan template name", "type": "string" }, "Description": { "description": "A discovery scan template description", "type": "string" }, "Type": { "$ref": "#/definitions/ScanType" }, "AssignedScans": { "format": "int32", "description": "Get or set number of assigned scan groups", "type": "integer" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Created": { "format": "date-time", "description": "Get or set the creation date for a created discovery scan template", "type": "string" }, "IsLocked": { "description": "Get or set a value indicating whether the discovery scan template is locked", "type": "boolean" } }, "additionalProperties": false }, "DownloadUrlResponse": { "description": "Response model for download URL endpoints.\nReturns a presigned S3 URL for downloading files.", "type": "object", "properties": { "DownloadUrl": { "description": "The presigned URL to download the file.\nThis URL is valid for a limited time (configured via DownloadablesUrlTtlMinutes)", "type": "string" }, "FileName": { "description": "The original filename that will be used when downloading", "type": "string" } }, "additionalProperties": false }, "ElementOfStructure": { "description": "Represents single element of discovered pages structure.", "type": "object", "properties": { "children": { "description": "A list of descending elements", "type": "array", "items": { "$ref": "#/definitions/ElementOfStructure" } }, "name": { "description": "An element name", "type": "string" }, "NumberOfElements": { "format": "int64", "description": "A number of descending elements", "type": "integer" } }, "additionalProperties": false }, "EncryptionKeyViewModel": { "description": "Represent encryption key.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "An encryption key unique identifier", "type": "string" }, "Name": { "description": "An encryption key name", "type": "string" }, "IsDefault": { "description": "Is encryption key default", "type": "boolean" }, "Description": { "description": "An encryption key description", "type": "string" }, "Format": { "description": "An encryption key format", "type": "string" } }, "additionalProperties": false }, "EndpointAgentScanSchedule": { "description": "How often Radar Endpoint Agent scan should be executed.", "enum": [ "EveryFourHours", "EverySixHours", "EveryTwelveHours", "EveryTwentyFourHours" ], "type": "string" }, "EndpointAgentScanScheduleViewModel": { "description": "How often Radar Endpoint Agent scan should be executed.", "type": "object", "properties": { "EndpointAgentScanSchedule": { "$ref": "#/definitions/EndpointAgentScanSchedule" } }, "additionalProperties": false }, "ExecutionMode": { "format": "int32", "enum": [ 0, 1, 2 ], "type": "integer" }, "FSecure.Radar.SecurityCentre.Model.Enums.Assets.AssetSourceTypes": { "enum": [ "DiscoveryScan", "NonauthenticatedSystemScan", "AuthenticatedSystemScan", "EndpointAgentScan" ], "type": "string" }, "FilterBasicFieldWithScanned[AssetBasicFieldEnum]": { "type": "object", "properties": { "Scanned": { "$ref": "#/definitions/ScannedWhenModeEnum" }, "ScannedNumber": { "format": "int32", "description": "A number of units used when checking the time of scan. The default value is 1", "type": "integer" }, "ScannedWhenUnit": { "$ref": "#/definitions/ScannedWhenUnitEnum" }, "Name": { "$ref": "#/definitions/AssetBasicFieldEnum" }, "Operator": { "$ref": "#/definitions/Operator" }, "Value": { "type": "string" } }, "additionalProperties": false }, "FilterBasicField[AffectedSiteBasicFieldEnum]": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/AffectedSiteBasicFieldEnum" }, "Operator": { "$ref": "#/definitions/Operator" }, "Value": { "type": "string" } }, "additionalProperties": false }, "FilterBasicField[TargetRelatedBasicFieldEnum]": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/TargetRelatedBasicFieldEnum" }, "Operator": { "$ref": "#/definitions/Operator" }, "Value": { "type": "string" } }, "additionalProperties": false }, "FilterBasicField[VulnerabilityBasicFieldEnum]": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/VulnerabilityBasicFieldEnum" }, "Operator": { "$ref": "#/definitions/Operator" }, "Value": { "type": "string" } }, "additionalProperties": false }, "FilteredScansCountViewModel": { "type": "object", "properties": { "ScansCount": { "format": "int32", "type": "integer" }, "AssetsCount": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "GeneralSettingsContactDetailsViewModel": { "description": "Person contact information.", "type": "object", "properties": { "FirstName": { "description": "A person first name", "type": "string" }, "LastName": { "description": "A person last name", "type": "string" }, "EmailAddress": { "description": "Person email address", "type": "string" } }, "additionalProperties": false }, "GeneralSettingsViewModel": { "description": "Aggregated properties for general settings.", "type": "object", "properties": { "ScanningRestriction": { "$ref": "#/definitions/ScanningRestrictionViewModel" }, "VulnerabilityStatuses": { "description": "A list of vulnerability statuses", "type": "array", "items": { "$ref": "#/definitions/VulnerabilityStatusViewModel" } }, "TicketSettings": { "$ref": "#/definitions/TicketSettingsViewModel" }, "EncryptionKeys": { "description": "A list of encryption keys", "type": "array", "items": { "$ref": "#/definitions/EncryptionKeyViewModel" } }, "OrganizationTimeZoneId": { "description": "Time zone unique identifier", "type": "string" }, "PrimaryContactDetails": { "$ref": "#/definitions/GeneralSettingsContactDetailsViewModel" }, "StoreReportsPeriod": { "$ref": "#/definitions/StoreReportsPeriods" }, "AutoCloseTickets": { "description": "Automatically closes tickets when all vulnerability instances in the ticket are closed", "type": "boolean" }, "ReopenAutomaticallyTickets": { "description": "Reopen tickets automatically when at least one vulnerability instances in the ticket becomes open", "type": "boolean" }, "DaysBeforeDeadlineToNotifyTicketFollowers": { "format": "int32", "description": "Number of days before ticket deadline when participants must be informed about it", "type": "integer" }, "DaysBeforeDeadlineToNotifyTicketFollowersEnabled": { "description": "A flag that indicates if notification to all ticket participants has to be send when number of days specifed in DaysBeforeDeadlineToNotifyTicketFollowers property had happend", "type": "boolean" }, "DeadlineReachedNotification": { "description": "A flag that indicates if notification to all ticket participants has to be send when deadline has been occured", "type": "boolean" }, "AutoMarkInternetExposure": { "description": "A flag which marks if new assets with public IP should be marked as exposed to the internet. (default true)", "type": "boolean" }, "AutoMarkDuplicatedFindings": { "description": "A flag which marks if new findings should be automatically marked as duplicated. (default false)", "type": "boolean" }, "ProductCustomization": { "$ref": "#/definitions/ProductCustomizationViewModel" }, "SummaryReportsMaxPackageSize": { "format": "int32", "description": "Maximum size of summary reports package in bytes", "type": "integer" }, "ArchiveAssetsPeriod": { "$ref": "#/definitions/ArchiveAssetsPeriods" }, "StoreAssetsPeriod": { "$ref": "#/definitions/StoreAssetsPeriods" }, "EndpointAgentScanSchedule": { "$ref": "#/definitions/EndpointAgentScanSchedule" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "GroupCountViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A unique identifier for Scan Node Groups", "type": "string" }, "Name": { "description": "A Scan Node name", "type": "string" }, "SystemScanTemplateId": { "format": "uuid", "description": "A unique identifier for System Scan template", "type": "string" }, "WebScanTemplateId": { "format": "uuid", "description": "A unique identifier for Web Scan template", "type": "string" }, "Count": { "format": "int64", "type": "integer" }, "NumberOfRunningScans": { "format": "int64", "description": "A number of running scans", "type": "integer" }, "NumberOfQueuedScans": { "format": "int64", "description": "A number of queued scans", "type": "integer" }, "HasAssetMonitoring": { "description": "Defined scan group has one or more asset monitorings", "type": "boolean" }, "AverageScanProgress": { "format": "double", "description": "Average scan progress", "type": "number" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "HostsFilterViewModel": { "type": "object", "properties": { "Scanned": { "description": "A flag indicating that a query should return scanned hosts for a vulnerability scan", "type": "boolean" }, "NotAddedToGroup": { "description": "A flag indicating that a query should return hosts not added to a vulnerability scan", "type": "boolean" }, "AddedToGroup": { "description": "A flag indicating that a query should return hosts added to a vulnerability scan", "type": "boolean" }, "ShowAllStatuses": { "description": "A flag indicating that a query should return all hosts without taking into account statuses", "type": "boolean" }, "ShowAnyChanges": { "description": "A flag indicates that query should return any hosts without taking into account changes", "type": "boolean" }, "Changes": { "description": "Filter hosts by list of changes", "type": "array", "items": { "$ref": "#/definitions/DiscoveryHostChanges" } }, "Statuses": { "description": "Filter hosts by list of statuses", "type": "array", "items": { "$ref": "#/definitions/DiscoveryHostStatuses" } }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "HostsGroupViewModel": { "type": "object", "properties": { "NewHostsCount": { "format": "int32", "description": "New host counter", "type": "integer" }, "NotScannedHostsCount": { "format": "int32", "description": "A counter for unscanned hosts", "type": "integer" } }, "additionalProperties": false }, "HttpStatusCode": { "format": "int32", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511 ], "type": "integer" }, "ISimpleMessage": { "description": "Interface for simple message API.", "type": "object", "properties": { "ResultMessage": { "description": "Result message", "type": "string" }, "ResultCode": { "$ref": "#/definitions/RadarStatusEnum" }, "ResultCodeLocaleKey": { "description": "Result code tanslated to dot standard", "type": "string", "readOnly": true }, "Exception": { "description": "Exception returned (if occurs)" }, "Properties": { "type": "array", "items": { "type": "string" } }, "Parameters": { "description": "A dictionary with parameters to format the result message after translation to the target language in the Radar client application.\nThis property is optional and is not send to the client when empty", "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "ITagView": { "type": "object", "properties": { "Component": { "description": "A component name", "type": "string" }, "Type": { "description": "Tag type. E.g. Scan, Ticket, Scan Group,", "type": "string" }, "Source": { "description": "Indicates the source of the tag. E.g. System Scan", "type": "string" }, "TechnicalName": { "description": "A technical name", "type": "string" }, "FriendlyName": { "description": "A friendly name", "type": "string" }, "Manual": { "description": "A flag that indicates whether the tag was entered manually", "type": "boolean" } }, "additionalProperties": false }, "IVulnerabilitiesAndFindingsBaseViewModel": { "description": "Represents vulnerability and findings base interface.", "type": "object", "properties": { "RiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "CVSSBaseScore": { "format": "double", "description": "A CVSS base score value. Range [0,10]", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "A vulnerability CVSS v3 base score. Range [0,10]", "type": "number" }, "Title": { "description": "A title", "type": "string" }, "IsExploitable": { "description": "Is vulnerability exploitable", "type": "boolean" } }, "additionalProperties": false }, "InstallerUrlViewModel": { "description": "View model used to download the installation file.", "type": "object", "properties": { "Os": { "description": "Operating system name for which link is provided for", "type": "string" }, "DownloadLink": { "format": "uri", "description": "Url to download installer", "type": "string" } }, "additionalProperties": false }, "InternetDiscoveryAssetMonitoringViewModel": { "required": [ "Query" ], "type": "object", "properties": { "Query": { "description": "Internet discovery query to search for assets", "minLength": 1, "type": "string" }, "ScanGroupId": { "format": "uuid", "description": "A unique identifier referring to Scan Group", "type": "string" }, "IsActive": { "description": "A flag that indicates whether specific monitoring is active", "type": "boolean" }, "TrackSystemScans": { "description": "A flag that indicates if System Scans should be tracked", "type": "boolean" }, "TrackWebScans": { "description": "A flag that indicates whether Web Scans should be tracked", "type": "boolean" }, "AlwaysAddNewSystemScans": { "description": "A flag that indicates whether new System Scan should be added", "type": "boolean" }, "AlwaysAddNewWebScans": { "description": "A flag that indicates whether new Web Scan should be added", "type": "boolean" }, "RemoveSystemScanWhenUndiscovered": { "description": "A flag that indicates whether undiscovered System Scan should be removed", "type": "boolean" }, "RemoveWebScanWhenUndiscovered": { "description": "A flag that indicates whether undiscovered Web Scan should be removed", "type": "boolean" }, "AssetSourceType": { "$ref": "#/definitions/Radar.Model.Enums.AssetSourceTypes" }, "TrackedHttpPortRangeForWebScan": { "description": "An object that contains information about tracked ports for Web Scans (http service)", "type": "string" }, "TrackedHttpsPortRangeForWebScan": { "description": "An object that contains information about tracked ports for Web Scans (https service)", "type": "string" }, "RunSystemScanImmediatelyAfterAdd": { "description": "A flag that indicates whether the new detected System Scan should be started", "type": "boolean" }, "RunWebScanImmediatelyAfterAdd": { "description": "A flag that indicates whether the new detected Web Scan should be started", "type": "boolean" }, "ScheduleId": { "format": "uuid", "description": "A unique identifier referring to Schedule", "type": "string" }, "RunSystemScanImmediatelyIfNewServicesDiscovered": { "description": "A flag that indicates whether the System Scan with new service detected should be started", "type": "boolean" }, "TrackedSystemScanByHostname": { "description": "A flag that indicates whether System Scans should be tracked by hostname or IP address", "type": "boolean" }, "CrossCheckForSystemScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid System Scan duplicates", "type": "boolean" }, "CrossCheckForWebScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid Web Scan duplicates", "type": "boolean" } }, "additionalProperties": false }, "KeyValuePair[Guid]": { "type": "object", "properties": { "Key": { "format": "uuid", "type": "string" }, "Value": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "LocalizationEnum": { "description": "Represents possible localization values.", "enum": [ "en_US", "fk", "ab", "aa", "af_ZA", "sq_AL", "am", "ar", "ar_DZ", "ar_BH", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SD", "ar_SY", "ar_TN", "ar_AE", "ar_YE", "hy", "ay", "az", "ba", "eu_ES", "be_BY", "bn", "dz", "bh", "bi", "br", "bg_BG", "my", "km", "ca_ES", "zh_TW", "zh_HK", "zh_MO", "zh_CN", "zh_SG", "co", "hr_HR", "cs_CZ", "da_DK", "pt_BR", "nl_NL", "nl_BE", "en_GB", "en_AU", "en_BZ", "en_BW", "en_CA", "en_CB", "en_DK", "en_IE", "en_JM", "en_NZ", "en_PH", "en_ZA", "en_TT", "en_ZW", "eo", "et_EE", "fo_FO", "fa_IR", "fj", "fi_FI", "fr_FR", "fr_BE", "fr_CA", "fr_LU", "fr_MC", "fr_CH", "fy", "gl_ES", "ka_GE", "de_DE", "de_AT", "de_BE", "de_LI", "de_LU", "de_CH", "el_GR", "kl_GL", "gn", "gu", "ha", "he_IL", "hi_IN", "hu_HU", "is_IS", "id_ID", "ia", "ie", "iu", "ik", "ga_IE", "it_IT", "it_CH", "ja_JP", "jw", "kn", "ks", "ks_IN", "kk", "kw_GB", "rw", "ky", "rn", "ko_KR", "ku_TR", "lo", "la", "lv_LV", "ln", "lt_LT", "mk_MK", "mg", "ml", "ms_BN", "ms_MY", "mt_MT", "mi", "mr_IN", "mo", "mn", "na", "ne_NP", "ne_IN", "nb_NO", "nn_NO", "oc", "or", "om", "ps", "pl", "pl_PL", "pt_PT", "pa", "qu", "rm", "ro_RO", "ru_RU", "ru_UA", "se_NO", "sm", "sg", "sa", "gd", "sr_SR", "sh", "st", "tn", "sn", "sd", "si", "ss", "sk_SK", "sl_SI", "so", "es_ES", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_SV", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PY", "es_PE", "es_PR", "es_UY", "es_US", "es_VE", "su", "sw_KE", "sv_SE", "sv_FI", "tl_PH", "tg", "ta", "tt", "te", "th_TH", "bo", "ti", "to", "ts", "tr_TR", "tk", "tw", "ug", "uk_UA", "ur", "ur_IN", "ur_PK", "uz", "vi_VN", "vo", "cy", "wo", "xh", "yi", "yo", "za", "zu" ], "type": "string" }, "LogViewModel": { "description": "Class representing single log entry.", "type": "object", "properties": { "Date": { "format": "date-time", "description": "Log event timestamp", "type": "string" }, "EventType": { "$ref": "#/definitions/MsgType" }, "Id": { "format": "uuid", "description": "Log entry unique identifier", "type": "string" }, "IsConsultant": { "description": "Is the user consultant", "type": "boolean" }, "MsgLevel": { "$ref": "#/definitions/MsgLevel" }, "RemoteIP": { "description": "IP address of a request that caused the log entry (action, error, etc.)", "type": "string" }, "Subject": { "description": "General information about the log entry", "type": "string" }, "UserEmail": { "description": "User who caused the log entry (action, error, etc.)", "type": "string" }, "UserId": { "format": "uuid", "description": "ID of the user who caused the log entry (action, error, etc.)", "type": "string" } }, "additionalProperties": false }, "LogsFilterViewModel": { "type": "object", "properties": { "EventType": { "$ref": "#/definitions/MsgType" }, "UserEmail": { "description": "User email address", "type": "string" }, "SearchPhrase": { "description": "A search phrase", "type": "string" }, "DateFrom": { "format": "date-time", "description": "A period lower date and time", "type": "string" }, "DateTo": { "format": "date-time", "description": "A period upper date and time", "type": "string" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "ManualVulnerabilityViewModel": { "description": "Manual vulnerability view model.", "type": "object", "properties": { "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "ReportId": { "format": "uuid", "description": "A report unique identifier", "type": "string" }, "VulnerabilityId": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "VulnerabilityScanId": { "format": "uuid", "description": "A unique identifier for vulnerability scan", "type": "string" }, "VulnerabilityScanDetailId": { "format": "uuid", "description": "A unique identifier for vulnerability scan details", "type": "string" } }, "additionalProperties": false }, "MessageNotificationViewModel": { "description": "A messsage notification helper.", "required": [ "NotificationLevel" ], "type": "object", "properties": { "EmailAddresses": { "description": "An email address. Specify the required email addresses for notifications. Enter more email addresses by separating them with a comma", "type": "string" }, "NotificationLevel": { "$ref": "#/definitions/NotificationType" }, "NotificationLevelId": { "format": "int32", "description": "A notification level identifier", "type": "integer" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "MonthState": { "enum": [ "None", "Day", "The" ], "type": "string" }, "MsgLevel": { "enum": [ "NONE", "ERROR", "WARNING", "INFO", "DEBUG", "VERBOSE" ], "type": "string" }, "MsgType": { "enum": [ "WebScanCreated", "SystemScanCreated", "DiscoveryScanCreated", "WebScanModified", "SystemScanModified", "DiscoveryScanModified", "SystemScanStarted", "WebScanStarted", "DiscoveryScanStarted", "WebScanFinished", "SystemScanFinished", "DiscoveryScanFinished", "WebScanDeleted", "SystemScanDeleted", "DiscoveryScanDeleted", "ScanGroupCreated", "ScanGroupModified", "ScanGroupDeleted", "Operations", "Login", "Workflow", "SystemScanStopRequest", "DiscoveryScanStopRequest", "WebScanStopRequest", "SystemScanTerminated", "DiscoveryScanTerminated", "WebScanTerminated", "ScanTemplateCreated", "ScanTemplateModified", "ScanTemplateDeleted", "ScheduleTemplateCreated", "ScheduleTemplateModified", "ScheduleTemplateDeleted", "TicketCreated", "TicketModified", "TicketClosed", "TicketReopened", "UserGroupCreated", "UserGroupModified", "UserGroupDeleted", "RoleCreated", "RoleModified", "RoleDeleted", "TicketDeleted", "DiscoveryScanTemplateDeleted", "SystemScanScannedIpAddress", "WebScanScannedIpAddress", "DataSynchronization", "InvalidScanNodeIdentifier", "BackgroundJobs", "RequestBlocked", "ScanNodeActionRequest", "AssetArchived", "AssetDeleted", "AssetRestored", "AgentScanScannedClientID", "AgentScanFinished", "UserAttachedToOrganization", "UserDetachedFromOrganization", "UserAttachedToUserGroup", "UserDetachedFromUserGroup", "UserCreated", "UserDeleted", "UserActivated", "UserDeactivated", "UserModified", "OrganizationModified", "FlexibleScanNodesManagement", "AgentScanningEnabled", "AgentScanningDisabled", "Configuration" ], "type": "string" }, "NameIdItem[Guid]": { "type": "object", "properties": { "Name": { "type": "string" }, "Id": { "format": "uuid", "type": "string" } }, "additionalProperties": false }, "NameIdItem[Int32]": { "type": "object", "properties": { "Name": { "type": "string" }, "Id": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "NameOperator": { "type": "object", "properties": { "Operator": { "type": "string" }, "Value": { "type": "string" } }, "additionalProperties": false }, "NameValueItem[Int32]": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "NameValueItem[String]": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } }, "additionalProperties": false }, "NetworkFilterViewModel": { "description": "Filter view model class for discvoery scans list view.", "type": "object", "properties": { "Names": { "description": "An array of operators by Name", "type": "array", "items": { "$ref": "#/definitions/NameOperator" } }, "Ranges": { "description": "An array of operators by Range", "type": "array", "items": { "$ref": "#/definitions/NameOperator" } }, "HostNames": { "description": "An array of operators by Host name", "type": "array", "items": { "$ref": "#/definitions/NameOperator" } }, "Scanned": { "$ref": "#/definitions/ScannedWhenModeEnum" }, "ScannedNumber": { "format": "int32", "description": "Scanned number", "type": "integer" }, "ScannedWhenUnit": { "$ref": "#/definitions/ScannedWhenUnitEnum" }, "AllScanRunStates": { "description": "A flag that indicates if all the scan run states should be included in the result", "type": "boolean" }, "ScanRunStates": { "description": "An array of scan run states", "type": "array", "items": { "$ref": "#/definitions/ScanRunStateType" } }, "ScanGroup": { "description": "An array of unique identifiers for a scan group", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "ScanTemplateId": { "format": "uuid", "description": "A unique identifier for a scan template", "type": "string" }, "ScanNodeId": { "format": "uuid", "description": "A scan node unique identifier", "type": "string" }, "CreatedBy": { "format": "uuid", "description": "A unique identifier referring to the user that created the item", "type": "string" }, "AutomationAssetsOnly": { "description": "A flag that indicates whether only automation assets are returned", "type": "boolean" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "NetworkHostStatisticsViewModel": { "description": "Represents Discovery Scan report host grouped information.", "type": "object", "properties": { "NetworkHostLive": { "format": "int32", "description": "A discovery scan live host amount", "type": "integer" }, "NetworkHostOffline": { "format": "int32", "description": "A discovery scan offline host amount", "type": "integer" }, "NetworkHostOnline": { "format": "int32", "description": "A discovery scan online host amount", "type": "integer" } }, "additionalProperties": false }, "NetworkHostWithPortsViewModel": { "type": "object", "properties": { "ChangeDecrement": { "format": "int32", "description": "A discovery hosts ports decrement change amount", "type": "integer" }, "ChangeIncrement": { "format": "int32", "description": "A discovery hosts port increment change amount", "type": "integer" }, "HostName": { "description": "Discovery host name", "type": "string" }, "Ip": { "description": "Discovery host IP address", "type": "string" }, "NumberPorts": { "format": "int32", "description": "A discovery host ports number", "type": "integer" } }, "additionalProperties": false }, "NewTagViewModel": { "description": "View model to add existing tag on an entity.", "type": "object", "properties": { "FriendlyName": { "description": "User readable tag name. Leave empty when adding an existing tag", "type": "string" }, "TechnicalName": { "description": "Internal tag technical name. Leave empty when creating a new manual tag", "type": "string" } }, "additionalProperties": false }, "NodeWarningType": { "description": "A list of scan node warnings.", "enum": [ "LowDiskSpace", "LowDiskSpaceSSUpdateEngine", "LowDiskSpaceWSUpdateEngine", "LowDiskSpaceDSUpdateEngine", "LowDiskSpaceUpdateProduct", "TimeDeviationGreaterThen5Minutes", "CongestedProcessorQueue", "LowMemory" ], "type": "string" }, "NotificationDetailsLevels": { "description": "Represent level of details in email notification", "enum": [ "AllDetails", "OnlyFriendlyNames", "OnlyLink" ], "type": "string" }, "NotificationPeriod": { "enum": [ "Immediately", "Hourly", "Daily", "Weekly" ], "type": "string" }, "NotificationType": { "description": "Represents notification type possible values.", "enum": [ "Never", "ScanEndsHigh", "ScanEndsMedium", "ScanEndsLow", "ScanEnds", "ScanStarts", "ScanStartsEnds", "ChangePortList", "ChangeHostList", "ChangePortOrHostList", "ChangeOS", "ScanEndsCritical" ], "type": "string" }, "NumberOfScansViewModel": { "type": "object", "properties": { "Total": { "format": "int32", "description": "Total number for scans", "type": "integer" }, "SystemScanCount": { "format": "int32", "description": "Number of System Scans", "type": "integer" }, "WebScanCount": { "format": "int32", "description": "Number of Web Scans", "type": "integer" } }, "additionalProperties": false }, "NumberOfThreadsEnum": { "enum": [ "THS_1", "THS_2", "THS_4", "THS_8", "THS_16", "THS_24", "THS_32" ], "type": "string" }, "NumberOfVulnerabilitiesChangesViewModel": { "description": "Represents a view model of a vulnerability changes.", "type": "object", "properties": { "StatisticsDate": { "format": "date-time", "description": "Date and time of statistics generation", "type": "string" }, "Year": { "format": "int32", "description": "Vulnerability changes for a year", "type": "integer" }, "Week": { "format": "int32", "description": "Vulnerability changes for a week", "type": "integer" }, "Quarter": { "format": "int32", "description": "A vulnerability change for quarter", "type": "integer" }, "Month": { "format": "int32", "description": "A vulnerability change for month", "type": "integer" }, "ScanCount": { "format": "int32", "description": "A number of scans", "type": "integer" }, "CriticalCount": { "format": "int32", "description": "A number of critical vulnerabilities", "type": "integer" }, "HighCount": { "format": "int32", "description": "A number of high vulnerabilities", "type": "integer" }, "MediumCount": { "format": "int32", "description": "A number of medium vulnerabilities", "type": "integer" }, "LowCount": { "format": "int32", "description": "A number of low vulnerabilities", "type": "integer" }, "InformationalCount": { "format": "int32", "description": "A number of informational findings", "type": "integer" }, "AverageSeverity": { "format": "double", "description": "Average severity", "type": "number" }, "VulnCount": { "format": "double", "description": "Vulnerability count", "type": "number" }, "NumberOfAssets": { "format": "int32", "description": "A number of assets", "type": "integer" }, "NumberOfEndpointAgents": { "format": "int32", "description": "A number of Radar Endpoint Agents", "type": "integer" } }, "additionalProperties": false }, "NumberOfVulnerabilityByCategoryViewModel": { "description": "Represents number of vulnerabilities by vulnerability category.", "type": "object", "properties": { "CategoryName": { "description": "A vulnerability category name", "type": "string" }, "Count": { "format": "int32", "description": "A number of vulnerabilities", "type": "integer" }, "CategoryReferenceId": { "description": "Category reference ID for a vulnerability ", "type": "string" } }, "additionalProperties": false }, "NumberOfVulnerabilityDefinitionsViewModel": { "description": "Represents number of vulnerabilites grouped by severity.", "type": "object", "properties": { "Total": { "format": "int32", "description": "A total number for vulnerabilities", "type": "integer" }, "CriticalCount": { "format": "int32", "description": "Number of critical-severity vulnerabilities", "type": "integer" }, "HighCount": { "format": "int32", "description": "Number of high-severity vulnerabilities", "type": "integer" }, "MediumCount": { "format": "int32", "description": "Number of medium-severity vulnerabilities", "type": "integer" }, "LowCount": { "format": "int32", "description": "Number of low-severity vulnerabilities", "type": "integer" }, "InformationalCount": { "format": "int32", "description": "Number of informational vulnerabilities", "type": "integer" } }, "additionalProperties": false }, "NumberOfVulnerabiltiesViewModel": { "description": "Numbers of vulnerabilities of different types.", "type": "object", "properties": { "Total": { "format": "int32", "description": "Total number for vulnerabilities", "type": "integer" }, "CriticalCount": { "format": "int32", "description": "A number of critical vulnerabilities", "type": "integer" }, "HighCount": { "format": "int32", "description": "A number of high vulnerabilities", "type": "integer" }, "MediumCount": { "format": "int32", "description": "A number of medium vulnerabilities", "type": "integer" }, "LowCount": { "format": "int32", "description": "A number of low vulnerabilities", "type": "integer" }, "InformationalCount": { "format": "int32", "description": "A number of informational findings", "type": "integer", "readOnly": true } }, "additionalProperties": false }, "Operator": { "enum": [ "Is", "IsNot", "EqualTo", "MoreThan", "LessThan" ], "type": "string" }, "OrganizationTimeZoneViewModel": { "description": "Organization time zone view model.", "required": [ "OrganizationTimeZoneId" ], "type": "object", "properties": { "OrganizationTimeZoneId": { "description": "Time zone unique identifier", "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OrganizationTypes": { "description": "Type of a organization in Security Center hierarchy.", "enum": [ "Root", "SolutionProvider", "ServicePartner", "Company", "BusinessUnit" ], "type": "string" }, "PagedData[AssetMonitoringListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/AssetMonitoringListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[AssetsListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/AssetsListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[DiscoveryHostViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/DiscoveryHostViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[DiscoveryScanTemplatesListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/DiscoveryScanTemplatesListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[DiscoveryScansListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/DiscoveryScansListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[IVulnerabilitiesAndFindingsBaseViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/IVulnerabilitiesAndFindingsBaseViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[LogViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/LogViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[ScanNodeViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/ScanNodeViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[ScanReportHistoryListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/ScanReportHistoryListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[ScanTemplatesListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/ScanTemplatesListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[ScheduledSummaryReportsListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/ScheduledSummaryReportsListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[SchedulingTemplatesViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/SchedulingTemplatesViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[TicketGroupedVulnerabilityOnHostViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/TicketGroupedVulnerabilityOnHostViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[TicketGroupedVulnerabilityOnSiteViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/TicketGroupedVulnerabilityOnSiteViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[TicketViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/TicketViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[TicketVulnerabilityOnHostViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/TicketVulnerabilityOnHostViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[TicketVulnerabilityOnSiteViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/TicketVulnerabilityOnSiteViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[UserListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/UserListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[VulnerabilitiesAndFindingsViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[VulnerabilitiesCoverageListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesCoverageListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[VulnerabilitiesListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[VulnerabilityAffectedAssetsViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/VulnerabilityAffectedAssetsViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[VulnerabilityAffectedHostsGroupedViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/VulnerabilityAffectedHostsGroupedViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[VulnerabilityAffectedHostsViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/VulnerabilityAffectedHostsViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[VulnerabilityAffectedSitesGroupedViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/VulnerabilityAffectedSitesGroupedViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[VulnerabilityAffectedSitesViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/VulnerabilityAffectedSitesViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[VulnerabilityScansListViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/VulnerabilityScansListViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PagedData[WebScanReportVulnerabilityViewModel]": { "type": "object", "properties": { "TotalItemCount": { "format": "int32", "description": "A total items count", "type": "integer" }, "AdditionalSummary": { "$ref": "#/definitions/Dictionary[string][Object]" }, "PageSize": { "format": "int32", "description": "A page size", "type": "integer" }, "NumberOfPages": { "format": "int32", "description": "A number of pages", "type": "integer" }, "SortPrimary": { "description": "A string that is primary ascending sort method in the result data", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is primary descending sort method in the result data", "type": "boolean" }, "Items": { "description": "A list of items", "type": "array", "items": { "$ref": "#/definitions/WebScanReportVulnerabilityViewModel" } }, "PaginationToken": { "description": "Pagination token", "type": "string" } }, "additionalProperties": false }, "PeriodTypes": { "description": "Time selector values.", "enum": [ "Day", "Week", "Month", "Quarter", "Year" ], "type": "string" }, "PluginSelectionViewModel": { "type": "object", "properties": { "Plugins": { "description": "Get or set list of plugin ids", "type": "array", "items": { "format": "int32", "type": "integer" } }, "PluginExecutionMode": { "$ref": "#/definitions/ExecutionMode" } }, "additionalProperties": false }, "PoolingOnNode": { "enum": [ "InitiatedByTheScanNode", "InitiatedByTheSecurityCenter" ], "type": "string" }, "PortLastChanges": { "description": "Represents possible changes for a single port.", "enum": [ "State", "Service", "Banner" ], "type": "string" }, "Ports": { "type": "object", "properties": { "New": { "type": "array", "items": { "$ref": "#/definitions/DiscoveryHostScanPortViewModel" } }, "Old": { "type": "array", "items": { "$ref": "#/definitions/DiscoveryHostScanPortViewModel" } }, "Removed": { "type": "array", "items": { "$ref": "#/definitions/DiscoveryHostScanPortViewModel" } } }, "additionalProperties": false }, "PrivilegeFlag": { "enum": [ "VulnerabilityScan_SystemScan_View", "VulnerabilityScan_SystemScan_Action", "VulnerabilityScan_SystemScan_Edit", "VulnerabilityScan_WebScan_View", "VulnerabilityScan_WebScan_Action", "VulnerabilityScan_WebScan_Edit", "VulnerabilityScan_NetworkScan_View", "VulnerabilityScan_NetworkScan_Action", "VulnerabilityScan_NetworkScan_Edit", "Report_View", "Report_Edit", "VulnerabilityScan_SystemScan_AddDelete", "Ticketing_View", "Ticketing_Edit", "Ticketing_Own", "Settings_Account_AccountInfo_View", "Settings_Account_AccountInfo_Edit", "Settings_ManageUsers_UserList_View", "Settings_ManageUsers_UserList_Edit", "Settings_ManageUsers_User_AddDelete", "Settings_ManageKarhu_Access", "VulnerabilityScan_WebScan_AddDelete", "VulnerabilityScan_NetworkScan_AddDelete", "Organizations_View", "Organizations_AddDelete", "Organizations_Edit" ], "type": "string" }, "ProductCustomizationViewModel": { "type": "object", "properties": { "ProductCustomizationEnabled": { "description": "Flag indicating if product customization options (branding) are applied to this organization", "type": "boolean" }, "IsFromUpperOrganization": { "description": "Informs if product customization settings comes from organization higher in hierarchy", "type": "boolean" }, "OrganizationName": { "description": "Allows to apply vendor name to Radar reports delivered to end-customers and tooltip under company logo", "type": "string" }, "RequestSupportUrl": { "description": "Request support link that replaces the default F-Secure link.\nAllows to navigate end customers to other support form than F-Secure support form", "type": "string" }, "SupportSiteUrl": { "description": "Support link that replaces the default F-Secure link. \nThe users will be re-directed to the support site", "type": "string" }, "LogoId": { "format": "uuid", "description": "Unique identifier of saved logo or null", "type": "string" }, "Base64Logo": { "description": "Portal and summary report logo. Should be in .png format. Required dimension for the logo is 60 x 60 pixels", "type": "string" }, "ProductVersion": { "description": "Current VM Elements product version", "type": "string" }, "CvssVersion": { "$ref": "#/definitions/CVSSVersion" }, "MergedVulnerabilityStatuses": { "description": "Indicates if merged vulnerability statuses feature is enabled", "type": "boolean" } }, "additionalProperties": false }, "ProductInfoViewModel": { "type": "object", "properties": { "PortfolioNamingEnabled": { "description": "A flag that indicates if portfolio naming is enabled", "type": "boolean" }, "ProductName": { "description": "A product name", "type": "string" }, "ShortProductName": { "description": "A shourt product name", "type": "string" }, "CompanyName": { "description": "A product company name", "type": "string" }, "CompanySite": { "description": "A product company site", "type": "string" }, "ProductVersion": { "description": "A product version", "type": "string" }, "IsOnPremiseInstallation": { "description": "A flag that indicates if it is on premise instalation", "type": "boolean" }, "LatestSecurityCenterVersionForOnPremiseInstallation": { "description": "A portal on premise latest version", "type": "string" }, "WebsiteDomainName": { "description": "A web site domain name", "type": "string" }, "EnforceEmbeddedEnabled": { "description": "A flag that indicates if enforce embedded mode is enabled", "type": "boolean" } }, "additionalProperties": false }, "ProtocolTypes": { "enum": [ "TCP", "UDP", "ICMP" ], "type": "string" }, "Radar.Model.Enums.AssetSourceTypes": { "description": "Represents asset monitoring source type possible values.", "enum": [ "DiscoveryScan", "InternetDiscovery", "Custom" ], "type": "string" }, "RadarIPFilteringMode": { "description": "Represents IP filtering mode allowed values", "enum": [ "WhiteList", "BlackList" ], "type": "string" }, "RadarStatusEnum": { "description": "Radar messages list.", "enum": [ "CompanySettings_IPRestrictions", "Company_Settings_IP_Time_Restriction", "CompanySettings_IPRestrictions_FQDN", "FQDN_NotAllowed", "ScanGroup_NotAuthorized", "ScanGroup_NotFound", "ScanGroup_SSScanNode_NotFound", "ScanGroup_ChooseOneScanType", "ScanGroup_SystemScanScanTemplateEmpty", "ScanGroup_Too_Many_Targets", "ScanGroup_SystemScanScanNodeEmpty", "ScanGroup_WebScanScanTemplateEmpty", "ScanGroup_WebScanScanNodeEmpty", "ScanGroup_ChooseOverrideOption", "ScanGroup_Should_Contain_Suffix", "ScanGroup_Name_Length", "ScanGroup_Select_One_Type", "ScanGroup_Name_Required", "ScanGroup_Problem_During_Creation", "ScanGroup_Cannot_Remove_System_Scan_Configuration", "ScanGroup_Cannot_Remove_Web_Scan_Configuration", "ScanGroup_Cannot_Use_Ip_Ranges", "ScanGroup_Scans_NotFound", "Scan_NotAuthorized", "Scan_NotFound", "Recordings_Not_Found", "Scans_NotSpecified", "Scan_Add_CollectionEmpty", "Scan_Add_IPRangeDisallowed", "Scan_Add_InvalidTarget", "Scan_Add_Invalid_Name_Length", "Scan_Edit_InvalidName", "Scan_Edit_InvalidRange", "Scan_Edit_IPRangeDisallowed", "Scan_Edit_IPRangeDisallowed_FQDN", "Scan_Edit_InvalidScanDomain", "Scan_Edit_InvalidPortRangeTcp", "Scan_Edit_InvalidPortRangeUdp", "Scan_Edit_SSH_Username_Missing", "Scan_Edit_SSH_Encryption_Key_Name_Missing", "Scan_Edit_SSH_EncryptionKey_Missing", "Scan_Edit_SSH_Key_Missing", "Scan_Edit_SSH_Password_Missing", "Scan_Edit_SSH_Invalid_Port_Number", "Scan_Edit_SSH_Invalid_Port_Range", "Scan_Edit_SSH_Key_Incorrect_Format", "Scan_Edit_SSH_Key_Missing_Passphrase", "Scan_Edit_SSH_Key_Cannot_Read", "Scan_Edit_SSH_Key_Upload", "Scan_Edit_NTLM_Credentials_Missing", "Scan_Edit_Windows_Update_Option_Missing", "Scan_Edit_WINRM_Credentials_Missing", "Scan_Edit_Api_Invalid_Port_Number", "Scan_Edit_Api_Invalid_Port_Range", "Scan_Edit_Api_Encryption_Key_Name_Missing", "Scan_Edit_Api_Token_Missing", "Scan_Edit_Api_Username_Missing", "Scan_Edit_Api_Password_Missing", "Scan_Edit_Api_DeviceType_Missing", "Scan_Edit_Api_NotAllowed_Password_Encryption_Key_Change", "Scan_Edit_Api_NotAllowed_Token_Encryption_Key_Change", "Scan_Batch_ScanGroupsIds_Or_ScanIds", "Scan_Batch_ScanGroup_No_SystemScan_Configuration", "Scan_Batch_ScanGroup_No_WebScan_Configuration", "Scan_Batch_Unauthorized", "Scan_History_Compare_Dates", "User_NotFound", "User_Inactive", "User_Deactivated", "Organization_Missing", "Account_Inactive", "Account_Deactivated", "Account_Trial_Expired", "Account_Standard_Expired", "Account_NotAssinged_To", "Local_Authentication_Disabled", "OAuth_Invalid_Grant", "OAuth_Common_Error", "OAuth_User_Not_Found", "OAuth_Authentication_Disabled", "OAuth_Token_Invalid", "OAuth_User_Missing", "OAuth_Multifactor_Required_For_Organization", "OAuth_Fusion_Token_Not_Provided", "OAuth_Fusion_Token_Invalid_Token_Format", "OAuth_Fusion_Token_Insufficient_Scope", "OAuth_Fusion_Token_Validation_Error", "OAuth_Fusion_User_Not_Found_In_Database", "OAuth_Missing_Configuration", "OAuth_Fusion_User_Found_But_Not_Assigned", "OAuth_Fusion_Trusted_Addresses_Not_Configured", "OAuth_Fusion_Trusted_Addresses_Not_Allowed", "OAuth_User_Already_In_OneId", "OAuth_User_Merged_With_FSecure_Business_Account", "OAuth_User_Created_And_Merged_With_FSecure_Business_Account", "Account_First_Name_Is_To_Long", "Account_Last_Name_Is_To_Long", "Account_Email_Is_Too_Long", "Account_Phone_Is_Too_Long", "Account_User_Tries_Unlink_Himself", "Account_User_Group_Not_Provided", "Email_Format_Invalid", "Field_Exceeded_Maximum_Allowed_Length", "Account_Password_And_Confirm_Password_Are_Not_The_Same", "UserName_Or_Password_Incorrect", "Welcome_Missing", "LoginSuccess", "Licence_User_Missing", "Licence_File_Missing", "Code_Or_User_Missing", "TwoFactor_RegistrationCode_Missing", "TwoFactor_Token_Missing", "TwoFactor_Token_Incorrect", "TwoFactor_Token_NotDecryptable", "TwoFactor_Token_Already_Used", "TwoFactor_Older_Token_Used", "IP_Restrictions", "Password_New_Equal_Old_Password", "Password_OneId_Not_Saved", "User_Not_Created", "Password_Changed_Shouldbe_Provided", "Password_New_NotEqual", "Password_New_Not_Strong_Enough", "Common_Server_Internal_Error", "Common_BadRequest", "Common_NotFound", "Common_NotAuthorized", "SummaryReport_MissingVulnerabilityStatus", "SummaryReport_Unknown_File_Format", "SummaryReport_Not_Supported", "SummaryReport_Missing_File_Format", "SummaryReport_Unknown_Report_Type", "SummaryReport_Missing_Report_Type", "SummaryReport_MissingXMLFormat", "SummaryReport_NotApplicableForUpdate", "SummaryReport_NoReportToDelete", "SummaryReport_NotFound", "SummaryReport_NotGeneratedYet", "SummaryReport_NotAvailable", "SummaryReport_FailedToCreate", "SummaryReport_Not_Deleted", "SummaryReport_PackageTooBig", "SummaryReport_TryingToGetRequestWithoutRelatedReports", "SummaryReport_ReportIdsNotProvided", "Notification_EmptyEmail", "Notification_NotEmptyEmail", "Tags_NotUpdated", "Tags_Reference_Already_Exists", "Tags_Technical_Name_Exists", "Tags_Friendly_Name_Exists", "Tags_Technical_Name_Not_Found", "Tags_No_Tag_To_Add", "Tags_Can_Only_Remove_Manual_Tag", "Tags_Component_Not_Found", "Task_Activation_Failed", "SystemScanReport_ScanDonotHaveReport", "ScanReport_IncorrectVulnerabilityInstances", "SystemScanReport_Cannot_Change_Info_To_Potential", "SystemScanReport_NotFound", "SystemScanReport_BadParametersInFliter", "ScanReport_AuditorNoteRequired", "ScanReport_StatusNotFound", "EndpointScanReport_NotFound", "Other", "Ok", "Schedule_Iteration_Incorrect_Range_1_4", "Schedule_OnDayOfWeek_Incorrect_Range", "Schedule_Iteration_Incorrect_Range_1_2", "Schedule_Iteration_Incorrect_Range_1_3", "Schedule_Day_Incorrect_Range_1_31", "Schedule_The_Quarterly_Incorrect_Range_1_3", "Schedule_Name_Disallowed_Characters", "Schedule_Hour_Incorrect_Range", "Schedule_Minute_Incorrect_Range", "Schedule_Name_Not_Empty", "Schedule_Template_Debug_Verbose_Options", "Schedule_Run_Indefinetely_Scan_Count_Check", "Schedule_Time_Zone_Id_Not_Found", "Schedule_Incorrect_The_Field", "Schedule_Batch_Missing_Ids", "Templates_SystemScan_Not_Allowed", "Templates_SystemScan_Authentication_Methods_Duplicated", "Templates_WebScan_Not_Allowed", "Templates_DiscoveryScan_Not_Allowed", "Templates_DiscoveryScan_Options_Not_Allowed", "Templates_DiscoveryScan_Port_Range_Should_Be_Null", "Templates_DiscoveryScan_Invalid_Port_Range", "Templates_DiscoveryScan_Detect_Os_Should_Be_Null", "Templates_DiscoveryScan_Proceed_If_No_Ping_Should_Be_Null", "Templates_WebScan_Used_By_Group", "Templates_SystemScan_Used_By_Group", "Templates_DiscoveryScan_Used_By_Network", "Templates_SystemScan_Clone_Missing_Id", "Templates_SystemScan_Edit_Name", "Templates_SystemScan_Edit_Wrong_Id", "Templates_SystemScan_Edit_Name_Not_Allowed", "Templates_Scan_Edit_Template_Locked", "Filter_Not_Found", "Filter_Is_Null", "Filter_Name_Too_Long", "Filter_Empty", "Filter_Name_Empty", "Filter_Already_Exists", "DiscoveryScan_Ids_Not_Found", "DiscoveryScan_Scan_Template_Not_Found", "DiscoveryScan_Scan_Schedule_Not_Found", "DiscoveryScan_Name_Max_Length_Exceeded", "DiscoveryScan_Range_Max_Length_Exceeded", "DiscoveryScan_Exclude_Max_Length_Exceeded", "DebugModeOnlyForConsultants", "DiscoveryScan_Report_Not_Found", "DiscoveryScan_Report_Invalid_Identifier", "DiscoveryScan_Report_Network_Identifier", "Feedback_Should_Contain_Image", "Feedback_Message_Limit", "Feedback_Subject_Limit", "Feedback_Should_Contain_Message", "Feedback_Should_Contain_Subject", "DiscoveryScan_Missing_ScanTarget", "DiscoveryScan_Missing_ScheduleId", "DiscoveryScan_Missing_StartDateTime", "DiscoveryScan_Missing_IPranges", "DiscoveryScan_Invalid_IPranges", "DiscoveryScan_Invalid_Exclude", "DiscoveryScan_Invalid_Scope_Exclude", "DiscoveryScan_Result_Range_Invalid", "DiscoveryScan_Invalid_Characters_Range", "DiscoveryScan_Illegal_Range", "DiscoveryScan_Range_Ip_Duplicates", "DiscoveryScan_Invalid_Characters_Exclude", "DiscoveryScan_Illegal_Exclude", "DiscoveryScan_Not_Allowed_Range", "DiscoveryScan_ScanTemplate_Not_Found", "DiscoveryScan_ScanNode_Not_Found", "DiscoveryScan_Schedule_Not_Found", "DiscoveryScan_Not_Allowed_Scanned_Range", "DiscoveryScan_Not_Allowed_Scanning_Restriction", "DiscoveryScan_ScanId_Not_Found", "DiscoveryScan_Max_IP_Addresses_Exceeded", "DiscoveryScan_StartDateTime_Should_Be_Empty", "DiscoveryScan_ScheduleId_Should_Be_Empty", "Unsupported_File_Format", "WebScanReport_NotFound", "WebScan_Template_Name_Missing", "WebScan_Max_Request_Per_Second_Invalid", "WebScan_Template_Scanning_Restrictions_Pattern_Invalid", "WebScan_Edit_Host_Url_Invalid", "WebScan_Host_Invalid", "Scan_Edit_ScanGroup_Should_Be_Null", "Scan_Edit_ScanGroup_Should_Not_Be_Null", "WebScan_Edit_Recording_FileName_Missing", "WebScan_Edit_Recording_ContentType_Invalid", "WebScan_Edit_Recording_File_Size", "WebScan_Edit_Recording_File_Invalid_Extension", "WebScan_Edit_Recording_Invalid", "WebScan_Edit_WebRecordings_No_In_Base64_Format", "WebScanReport_UserDoesNotHaveCompany", "WebScan_Edit_Recording_Content_Invalid", "WebScan_Template_Scanning_Restrictions_Url_Invalid", "WebScanReport_BadParametersInFliter", "WebScan_Report_Invalid_Identifier", "Vulnerability_Invalid_Identifier", "Vulnerability_Category_Invalid_Identifier", "WebScan_Report_NotGeneratedYet", "WebScan_Recording_InvalidFormat", "Unsupported_Action", "VulnerabilitiesList_Update_Status_Ids_Empty", "VulnerabilitiesList_Update_Status_Invalid_Parameters", "Dashboard_Not_Found", "Dashboard_Widget_Not_Found", "Dashboard_Widget_Template_Not_Found", "Dashboard_Widget_Name_Is_Empty", "Roles_Duplicate", "Role_Not_Found", "Role_Locked", "Role_Name_Empty", "Role_Privileges_Empty", "Role_Privileges_Invalid", "Role_In_Use", "Role_Action_Not_Allowed", "UserGroup_Not_Found", "UserGroup_Locked", "UserGroup_ScanGroup_Restrictions_Not_Allowed", "UserGroup_Action_Not_Allowed", "UserGroup_Name_Empty", "User_FirstName_Empty", "User_LastName_Empty", "User_Save_Action_Invalid", "User_Email_Invalid", "User_Create_Max_Users", "Unique_Ip_Limit_Used", "User_Email_Exists", "User_Email_In_Use", "User_Not_Allowed_To_Manage_Organization", "User_Delete_Own", "User_Delete_Consultant", "User_Activate_Limit_Reached", "User_Action_Not_Allowed", "User_Insufficient_Organization_Privilliges", "User_No_Access_To_Organization", "User_APIKeys_Action_NotAllowed", "User_ApiKeys_ApiSecretKey_Invalid_Size", "User_ApiKeys_ApiAccessKey_Invalid_Size", "User_ApiKeys_Name_Empty", "User_ApiKeys_ApiAccessKey_Empty", "User_ApiKeys_Name_Duplicate", "User_ApiKeys_ApiAccessKey_Duplicate", "User_ApiKeys_ApiAccessKey_Not_Allowed", "User_ApiKeys_ExpirationDate_Invalid", "User_ApiKeys_Key_NotFound", "User_Password_Change_Old_Password_Invalid", "User_Password_Change_New_Password_Invalid", "User_Password_Cannot_Be_Common_Password", "User_Password_Change_Password_Empty", "User_Password_Change_NotAllowed", "User_Change_User_Type_NotAllowed", "Organization_Already_Exists", "Organization_Borgs_Id_Duplicate", "Organization_Subscription_Duplicate", "Organization_Invalid_Email", "Organization_Empty_Name", "Organization_Invalid_TimeZone", "Organization_Empty_Username_For_Custom_Crawler_Credentials", "Organization_Empty_Password_For_Custom_Crawler_Credentials", "Organization_Type_Of_Organization_Changed_From_Root", "Organization_Type_Of_Organization_Changed_To_Root", "Organization_Root_Type_Of_Organization", "Organization_Invalid_Organization_Type_In_Hierarchy", "Organization_Parent_Is_Empty", "Organization_Business_Unit_Cannot_Be_Parent", "Organization_Parent_Not_Found", "Organization_Crawler_Disabled_Globally", "Organization_Primary_Contact_Email_Empty_For_Creation_Of_Administrator_Account", "Organization_Primary_Contact_First_Name_Empty_For_Creation_Of_Administrator_Account", "Organization_Isolated", "Organization_Only_Solution_Provider_Can_Be_Value_Added", "Settings_Ip_Range_Allowed_To_Be_Scanned", "Settings_Unsupported_Syntax_Of_The_Ip_Range_Allowed_To_Be_Scanned_One_Or_More_Ip_Ranges_Are_Invalid", "Settings_Schedule_Has_Been_Deleted", "Settings_Error_Occured_When_Deleting_The_Time_Frame", "Settings_Please_Enter_A_Valid_Name", "Settings_Unsupported_Syntax_For_Ip_Range", "Settings_You_Have_To_Define_A_Time_Frame_Type", "Settings_You_Have_To_Define_A_Time_Frame", "Settings_Incorrect_Start_Time", "Settings_Schedule_Expired", "Settings_Time_Frame_Will_Never_Run", "Organization_NotFound", "User_UserGroup_Empty", "User_User_List_Empty", "Not_Implemented", "Settings_You_Can_Not_Change_State_For_Default_State_Status", "Settings_You_Can_Not_Delete_Default_Status", "Settings_Status_With_Internal_Purpose_Flag_Cannot_Be_Removed", "Settings_You_Can_Not_Set_Default_Status", "Settings_Error_During_Save_Default_Status", "Password_Reset_Invalid_Email", "Password_Reset_User_Not_Found", "Password_Reset_Invalid_Confirmation_Link", "Password_Reset_Invitation_Expired", "Password_Reset_Password_Request_Expired", "Password_Reset_Missing_Two_Passwords", "Password_Reset_Password_Mismatch", "Password_Reset_Failed_Policy", "Password_Reset_Functionality_Disabled", "Password_Reset_Invalid_Verfication_Code", "Settings_The_Key_Name_Cannot_Be_Empty", "Settings_The_Key_Name_Has_Not_Allow_Characters", "Settings_No_Public_Key_File_Has_Been_Chosen", "Settings_Upload_Only_Public_Key", "Settings_Error_Reading_Public_Key", "Settings_Upload_Public_Key_Not_Certificated", "Settings_Upload_Key_Cannot_Read_Pem_Format", "Settings_The_Key_Name_Is_Used", "Settings_Bad_Type_Time_Frame", "Settings_Unsupported_Syntax_Of_The_Ip_Filtering_Range", "Settings_Missing_Or_Incorrect_Scan_Node_Name", "Settings_Missing_Or_Incorrect_Scan_Node_Identifier", "Settings_Incorrect_Last_Seen_Warning_Value", "Settings_You_Have_To_Define_A_Scan_Node_Host_Or_Ip_Address", "Settings_You_Have_To_Define_A_Scan_Node_Port", "Settings_Incorrect_Port_Number", "Settings_You_Cannot_Modify_Existing_Scan_Node_Identifer", "Settings_Scan_Nodes_Scan_Node_Already_Exists", "Settings_Scan_Nodes_Another_Scan_Node_With_The_Same_Identifier_Has_Been_Already_Registered", "Settings_Scan_Nodes_Another_Scan_Node_With_The_Same_Identifier_Has_Been_Already_Registered_Either_Delete", "Settings_Scan_Nodes_Virtual_Node_Have_To_Contain_At_Least_One_Scan_Node", "Settings_Scan_Nodes_Virtual_Node_Have_To_Contain_Scan_Node_In_The_Same_Node_Type", "Settings_Scan_Node_Operation_Delete_Scan_Node_Aborted_Scan_Node_Not_Found", "Settings_Scan_Node_Operation_Delete_Scan_Node_You_Are_Not_Allowed", "Settings_Scan_Node_Operation_Delete_Scan_Node_You_Cannot_Delete_The_Last_Scan_Node_Of_The_Specific_Type", "Settings_Scan_Node_Operation_Delete_Scan_Node_Missing_Shared_Scan_Node", "Settings_Scan_Nodes_Virtual_Node_Require_Scan_Nodes_In_The_Same_Accounts", "Settings_Scan_Nodes_Scan_Node_Is_Already_Assigned_To_Virtual_Node", "Settings_Scan_Node_Not_Found", "Settings_Scan_Node_License_Ordering_Failed", "Settings_Scan_Node_License_Ordering_Connection_Failed", "Unknow_Scan_Run_State", "Discovery_Internet_Problem_With_Search_Query", "Discovery_Internet_Problem_With_Search_Host_Query", "Discovery_Internet_Missing_Configuration_Settings", "Authentication_ApiSecretKey_Missing", "Authentication_ApiKey_NotFound", "Authentication_ApiKey_Inactive", "Authentication_ApiKey_Expired", "Notification_Category_Or_List_Ids_Are_Empty", "Vulnerability_CvssVector_Lack_Of", "Vulnerability_CvssVector_Invalid_Length", "Vulnerability_CvssBaseScore_Invalid_Range", "Vulnerability_Cve_Invalid_Format", "Vulnerability_Family_Invalid_Length", "Vulnerability_Category_Is_Required", "Vulnerability_Name_Invalid_Length", "Vulnerability_Synopsis_Invalid_Length", "Vulnerability_Port_Invalid_Value", "Vulnerability_Ports_Invalid_Value", "Vulnerability_Name_Required", "Vulnerability_Status_Required", "Vulnerability_Type_Required", "Vulnerability_Family_Not_Found", "Vulnerability_Scan_Detail_Not_Found", "Vulnerability_Not_Manual_Change_Not_Allowed", "Solution_To_Long", "Background_To_Long", "Synopsis_To_Long", "Vulnerability_Manual_Not_Removed_From_Ticket", "Vulnerability_For_Vulnerability_Scan_Detail_Not_Found", "Summary_Report_Problem_With_Remove_Vulnerability_Status", "Vulnerability_Severity_Null", "Vulnerability_ScreenShot_Delete_Logical_List_Empty", "Vulnerability_ScreenShot_Lists_Empty", "Vulnerability_Image_Too_Large", "Vulnerability_Image_Extension_Not_Valid", "Scan_Configuration_Invalid", "Date_Range_Not_Valid", "Date_From_Equal_Or_Exceed_Date_To", "Ticket_User_Already_Added", "Ticket_Email_Already_Added", "Ticket_Email_User_With_Email_Already_Added", "Ticket_User_Empty_Fields", "Ticket_Incorrect_Priority_Value", "Ticket_Name_Required", "Ticket_Not_Found", "Ticket_Name_Too_Long", "Ticket_Cannot_Change_To_Same_Status", "Ticket_New_Status_Must_Be_Reopen", "Ticket_Autoclose_Option_Not_Specified", "Ticket_New_Status_Not_Found", "Ticket_Incorrect_Hours_Value", "Ticket_Unique_Identifier_Empty", "Ticket_User_Not_Found", "Ticket_User_Not_Assigned_To_Company", "Global_Configuration_Invalid_Image_Format", "Global_Configuration_Invalid_DataType", "Global_Configuration_Invalid_Value", "Global_Configuration_Missing_File_Image", "Global_Configuration_File_Image_Too_Big", "Global_Configuration_File_Image_Dimensions_Incorrect", "Ticket_Comment_Empty", "Global_Configuration_Image_Not_Found", "Global_Configuration_Key_Not_Found", "Global_Configuration_Duplicate_Name", "Global_Configuration_Parameter_Null_Or_Empty", "DiscoveryScan_Type_Not_Allowed", "Vulnerabilites_Hosts_Filter_Fields_Empty", "Vulnerabilites_Sites_Filter_Fields_Empty", "Vulnerability_Instance_Allready_Added", "Vulnerability_Reference_Too_Long", "Vulnerability_Reference_Url_Too_Long", "Vulnerability_Reference_Custom_Type_Too_Long", "Vulnerability_Reference_Custom_Type_Empty", "Sql_Connection_Does_Not_Exists", "Asset_Monitoring_Tracked_Port_Range_For_Web_Scan_Is_Invalid", "Asset_Monitoring_NotFound", "Asset_Monitoring_Incorrect_Type", "Asset_Monitoring_Schedule_Required_For_Internet_Discovery", "Asset_Monitoring_Type_Cannot_Be_Changed", "Asset_Monitoring_Discovery_Scan_Not_Specified", "Asset_Monitoring_Internet_Discovery_Query_Required", "Asset_Monitoring_Scheduling_Not_Supported", "Asset_Scan_Group_System_Scan_Not_Enabled", "Asset_Scan_Group_Web_Scan_Not_Enabled", "Schedule_NotFound", "Asset_Monitoring_Web_Scan_Settings_Invalid", "Asset_Monitoring_System_Scan_Settings_Invalid", "Filter_Not_Deleted_In_Use_By_Widget", "CleanUpOrganizations_Configuration_Parameters_Not_Found", "SoftDeleteExpiredOrganizations_Configuration_Parameters_Not_Found", "Assignments_Maximum_Number_Of_Users_Per_Account", "Assignments_User_Does_Not_Exist", "Assignments_Organization_Does_Not_Exist", "Virtual_Node_Not_Found", "Virtual_Node_Used_In_Scan_Groups", "Virtual_Node_Used_In_Discovery_Scans", "Virtual_Node_Name_Is_Empty", "Virtual_Node_List_Of_Scan_Nodes_Is_Empty", "MacAddress_Invalid", "Previous_Scan_Node_Action_Not_Deleted", "Scan_Node_Action_Not_Found", "List_Of_Scan_Nodes_Remote_Actions_Is_Empty", "Scan_Node_Logs_Date_From_Is_Not_Valid", "Request_Action_Not_Handled", "Ticket_Notification_Before_Days_Number_Range_Invalid", "Upload_SystemScan_Report_Size_Limit_Reached", "Upload_SystemScan_Report_File_Limit_Reached", "Asset_Management_Asset_Not_Found", "Asset_Management_No_Assets_Hosts_Found", "Asset_Management_Asset_Assigned_To_Scan_Not_Found", "Asset_Management_Vulnerability_Not_Found", "Asset_Management_Note_To_Long", "Asset_Management_Empty_Asset_List", "Asset_Without_Tags", "WebScan_Max_Parallel_Requests_Invalid", "WebScan_Authentication_Modes_Invalid", "WebScan_Attack_Categories_Invalid", "Scan_Template_Invalid_ConfigType", "User_Name_Contains_Illegal_Characters", "User_Created_And_Linked_To_Organization", "Existing_User_Linked_To_Organization", "User_Added_To_Organization", "User_Activation_Failed", "User_Adding_To_FACS_Remove_Queue_Failed", "Discover_Devices_Problem_With_Search_Query", "Devices_List_Cannot_Be_Empty", "Devices_List_Contains_No_Radar", "NumberOfDays_Range_1_1000", "Elements_OAuth_Token_Invalid", "ScanNode_NotFound", "ScanReport_Message_Invalid", "ReportXml_Invalid", "Method_Only_For_Companies", "Method_Only_For_Partners", "SystemScan_Report_Missing_Target_IP", "WebScan_Report_Missing_Target_IP", "Plugin_NotFound", "VulnRiskScore_Message_Invalid", "VulnRiskScore_Message_NotProcessed", "DeviceStatus_Message_NotProcessed", "DeviceRemoteAction_Message_NotProcessed", "FlexibleScanNodesManagement_InvalidDoormanJwtToken", "DeviceStatus_Message_Invalid", "DeviceRemoteAction_Message_Invalid", "DeviceOverview_Message_Invalid", "Not_Handled_Message_Event_Type", "Scan_Edit_SNMP_Invalid_Port_Number", "Scan_Edit_SNMP_Invalid_Port_Range", "Scan_Edit_SNMP_Username_Missing", "Scan_Edit_SNMP_Authentication_Protocol_Missing", "Scan_Edit_SNMP_Password_Missing", "Scan_Edit_SNMP_Privacy_Protocol_Missing", "Scan_Edit_SNMP_Privacy_Password_Missing", "Device_Not_Found" ], "type": "string" }, "RecurrenceType": { "enum": [ "None", "Daily", "Weekly", "Monthly", "YearlyOnDate", "Yearly", "Quarterly" ], "type": "string" }, "ReportFindingsAndChangeViewModel": { "type": "object", "properties": { "VulnRiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "NewCount": { "format": "int32", "description": "A new vulnerability count", "type": "integer" }, "FixedCount": { "format": "int32", "description": "A fixed vulnerability count", "type": "integer" }, "TotalCount": { "format": "int32", "description": "A total vulnerability count", "type": "integer" }, "CvssVersion": { "$ref": "#/definitions/CVSSVersion" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "ReportScanHistoryDataViewModel": { "type": "object", "properties": { "Date": { "format": "date-time", "description": "Date and time when scan occurred", "type": "string" }, "VulnerabilitiesQuantity": { "format": "int64", "description": "Number of vulnerabilities", "type": "integer" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "ReportScanHistoryViewModel": { "type": "object", "properties": { "VulnRiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "ScanHistoryData": { "description": "A list of scan history data", "type": "array", "items": { "$ref": "#/definitions/ReportScanHistoryDataViewModel" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "ReportStatisticsVulnerabilityByStatusViewModel": { "description": "Statistics for status of vulnerability.", "type": "object", "properties": { "CountVulnerbilities": { "format": "int32", "description": "Count vulnerabilities", "type": "integer" }, "GroupedVulnerabilitiesByStatus": { "description": "Counters grouped by status", "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } } }, "additionalProperties": false }, "ReportStatisticsVulnerabilityCountersViewModel": { "description": "Vulnerability and findings statisitics.", "type": "object", "properties": { "TotalVulnerbilities": { "format": "int32", "description": "Total number of vulnerabilities", "type": "integer" }, "TotalFindings": { "format": "int32", "description": "Total number of findings", "type": "integer" }, "NewVulnerablityCounter": { "format": "int32", "description": "Number of new vulnerabilities", "type": "integer" }, "NewFindingsCounter": { "format": "int32", "description": "Number of new findings", "type": "integer" }, "PotentialVulnerabilityCounter": { "format": "int32", "description": "Number of potential vulnerabilities", "type": "integer" }, "InformationalCounter": { "format": "int32", "description": "Number of informational findings", "type": "integer" }, "MitigatedCounter": { "format": "int32", "description": "Number of mitigated vulnerabilities", "type": "integer" }, "ChangedCounter": { "format": "int32", "description": "Number of changed vulnerabilities", "type": "integer" } }, "additionalProperties": false }, "ReportType": { "enum": [ "SystemScan", "WebScan", "Discovery", "EndpointSystemScan", "All" ], "type": "string" }, "RequestScanNodeLicenseViewModel": { "description": "Scan node basic data to request license.", "type": "object", "properties": { "Name": { "description": "Scan node name", "type": "string" }, "Description": { "description": "Scan node description", "type": "string" } }, "additionalProperties": false }, "RoleNameViewModel": { "description": "A RoleNameViewModel.", "type": "object", "properties": { "Name": { "description": "A Role name", "type": "string" }, "RoleId": { "format": "uuid", "description": "A Role unique identifier", "type": "string" } }, "additionalProperties": false }, "RoleViewModel": { "description": "Represents a single role.", "required": [ "RoleId" ], "type": "object", "properties": { "Description": { "description": "A role description", "type": "string" }, "Name": { "description": "A role name", "type": "string" }, "Locked": { "description": "If 'true' role is locked and cannot be edited", "type": "boolean" }, "Privileges": { "description": "A role privileges", "type": "array", "items": { "$ref": "#/definitions/PrivilegeFlag" } }, "RoleId": { "format": "uuid", "description": "A role unique identifier", "type": "string" } }, "additionalProperties": false }, "RssDataViewModel": { "type": "object", "properties": { "Date": { "format": "date-time", "description": "A date and time", "type": "string" }, "Description": { "description": "A description", "type": "string" }, "Guid": { "description": "A unique identifier for RSS data", "type": "string" }, "Link": { "description": "A link", "type": "string" }, "Title": { "description": "A title", "type": "string" } }, "additionalProperties": false }, "SSHAuthenticationTypes": { "enum": [ "Password", "Key" ], "type": "string" }, "SSVulnState": { "enum": [ "New", "Changed", "Reappeared", "Mitigated" ], "type": "string" }, "ScanChange": { "description": "Produceds easy to reach change indicator for changes in the vulnerability conuters.\nIt has also a mode where the change indicator is listed in a pure ASCI.", "type": "object", "properties": { "Info": { "format": "int32", "type": "integer" }, "Low": { "format": "int32", "type": "integer" }, "Medium": { "format": "int32", "type": "integer" }, "High": { "format": "int32", "type": "integer" }, "Critical": { "format": "int32", "type": "integer" }, "InfoFlag": { "type": "boolean" }, "LowFlag": { "type": "boolean" }, "MediumFlag": { "type": "boolean" }, "HighFlag": { "type": "boolean" }, "CriticalFlag": { "type": "boolean" } }, "additionalProperties": false }, "ScanConfigViewModel": { "description": "Scan configuration.", "type": "object", "properties": { "CompliantType": { "format": "int32", "description": "A compliant type", "type": "integer" }, "Config": { "description": "Configuration parameters in XML format", "type": "string" }, "ConfigType": { "format": "int32", "description": "A configuration type", "type": "integer" }, "CreatedBy": { "format": "uuid", "description": "A unique identifier referring to the user that created the item", "type": "string" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "Description": { "description": "A configuration description", "type": "string" }, "Id": { "format": "uuid", "description": "A unique identifier for a scan configuration", "type": "string" }, "IsLocked": { "description": "A flag that indicates whether configuration is locked", "type": "boolean" }, "ModifiedBy": { "format": "uuid", "description": "A unique identifier referring to the user who modified the user entry last time", "type": "string" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Name": { "description": "A configuration name", "type": "string" } }, "additionalProperties": false }, "ScanGroupAssetMonitoringViewModel": { "description": "Asset monitoring view model used a scan group create and or a scan group update.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "Asset monitoring unique identifier", "type": "string" }, "DiscoveryScanId": { "format": "uuid", "description": "A unique identifier referring to discovery scan (required only in case of discovery scan asset monitoring)", "type": "string" }, "Query": { "description": "Internet discovery query (required only in case of internet discovery asset monitoring)", "type": "string" }, "IsActive": { "description": "A flag that indicates whether specific monitoring is active", "type": "boolean" }, "TrackSystemScans": { "description": "A flag that indicates if System Scans should be tracked", "type": "boolean" }, "TrackWebScans": { "description": "A flag that indicates whether Web Scans should be tracked", "type": "boolean" }, "AlwaysAddNewSystemScans": { "description": "A flag that indicates whether new System Scan should be added", "type": "boolean" }, "AlwaysAddNewWebScans": { "description": "A flag that indicates whether new Web Scan should be added", "type": "boolean" }, "RemoveSystemScanWhenUndiscovered": { "description": "A flag that indicates whether undiscovered System Scan should be removed", "type": "boolean" }, "RemoveWebScanWhenUndiscovered": { "description": "A flag that indicates whether undiscovered Web Scan should be removed", "type": "boolean" }, "AssetSourceType": { "$ref": "#/definitions/Radar.Model.Enums.AssetSourceTypes" }, "TrackedHttpPortRangeForWebScan": { "description": "An object that contains information about tracked ports for Web Scans (http service)", "type": "string" }, "TrackedHttpsPortRangeForWebScan": { "description": "An object that contains information about tracked ports for Web Scans (https service)", "type": "string" }, "RunSystemScanImmediatelyAfterAdd": { "description": "A flag that indicates whether the new detected System Scan should be started", "type": "boolean" }, "RunWebScanImmediatelyAfterAdd": { "description": "A flag that indicates whether the new detected Web Scan should be started", "type": "boolean" }, "RunSystemScanImmediatelyIfNewServicesDiscovered": { "description": "A flag that indicates whether the System Scan with new service detected should be started", "type": "boolean" }, "TrackedSystemScanByHostname": { "description": "A flag that indicates whether System Scans should be tracked by hostname or IP address", "type": "boolean" }, "CrossCheckForSystemScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid System Scan duplicates", "type": "boolean" }, "CrossCheckForWebScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid Web Scan duplicates", "type": "boolean" }, "ScheduleId": { "format": "uuid", "description": "A unique identifier referring to Schedule", "type": "string" }, "NumberOfSystemScans": { "format": "int32", "description": "Number of added System Scan targets", "type": "integer" }, "NumberOfWebScans": { "format": "int32", "description": "Number of added Web Scan targets", "type": "integer" }, "DiscoveryScan": { "$ref": "#/definitions/SimpleDiscoveryScanAssetMonitoringViewModel" }, "InternetDiscovery": { "$ref": "#/definitions/SimpleInternetDiscoveryAssetMonitoringViewModel" } }, "additionalProperties": false }, "ScanGroupSimpleViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A Scan Group unique identifier", "type": "string" }, "Name": { "description": "A Scan Group name", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "ScanGroupViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A Scan Group unique identifier", "type": "string" }, "AssignedTo": { "format": "uuid", "description": "A unique identifier of users to whom this Scan Group is assigned", "type": "string" }, "AssignedToUser": { "$ref": "#/definitions/NameIdItem[Guid]" }, "CreatedBy": { "format": "uuid", "description": "A unique identifier referring to the user that created the item", "type": "string" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "Description": { "description": "A description", "type": "string" }, "DiscoveryConfigTemplate": { "format": "uuid", "description": "A unique identifier for discovery config templates", "type": "string" }, "DynamicScope": { "description": "A flag that indicates dynamic scope", "type": "boolean" }, "CrossCheckForSystemScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid System Scan duplicates", "type": "boolean", "readOnly": true }, "CrossCheckForWebScanDuplicates": { "description": "A flag that indicates if Asset update source automation should avoid Web Scan duplicates", "type": "boolean", "readOnly": true }, "MaxSSSimultaneousScans": { "format": "int32", "description": "A maximum number of simultaneous System Scans", "type": "integer" }, "MaxWSSimultaneousScans": { "format": "int32", "description": "A maximum number of simultaneous Web Scans", "type": "integer" }, "ModifiedBy": { "format": "uuid", "description": "A unique identifier referring to the user who modified the user entry last time", "type": "string" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Name": { "description": "A Scan Group name", "type": "string" }, "ScheduleId": { "format": "uuid", "description": "A unique identifier for Schedules", "type": "string" }, "SSConfigTemplateId": { "format": "uuid", "description": "A unique identifier for System Scan config templates", "type": "string" }, "SSScanNodeId": { "format": "uuid", "description": "A unique identifier for System Scan Scan Nodes", "type": "string" }, "WSConfigTemplateId": { "format": "uuid", "description": "A unique identifier for Web Scan config templates", "type": "string" }, "WSScanNodeId": { "format": "uuid", "description": "A unique identifier for Web Scan Scan Nodes", "type": "string" }, "WSScheduleId": { "format": "uuid", "description": "A unique identifier for Web Scan Schedules", "type": "string" }, "SscanConfig": { "$ref": "#/definitions/ScanConfigViewModel" }, "WscanConfig": { "$ref": "#/definitions/ScanConfigViewModel" }, "SsSchedule": { "$ref": "#/definitions/ScheduleViewModel" }, "WsSchedule": { "$ref": "#/definitions/ScheduleViewModel" }, "ScanNodeGroup": { "$ref": "#/definitions/ScanNodeGroupViewModel" }, "WsScanNode": { "$ref": "#/definitions/ScanNodeSettingsViewModel" }, "Tags": { "description": "A list that represents tags pinned to the scan", "type": "array", "items": { "$ref": "#/definitions/TagViewModel" } }, "TargetCreationScheduledInBackgroud": { "description": "Response flag that indicate if large list of targets has beed scheduled to backgroud", "type": "boolean" }, "NumberOfSystemScansAddedManually": { "format": "int32", "description": "Number of System Scan targets added manually", "type": "integer" }, "NumberOfWebScansAddedManually": { "format": "int32", "description": "Number of Web Scan targets added manually", "type": "integer" }, "AssetMonitoringConfigurations": { "description": "Asset monitoring configurations for both a Web Scan and a System Scan", "type": "array", "items": { "$ref": "#/definitions/ScanGroupAssetMonitoringViewModel" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "ScanNodeDetailsViewModel": { "description": "Scan node data.", "type": "object", "properties": { "DiskFreeSpace": { "description": "A dictionary with disks free space. Only for Web Scans", "type": "object", "additionalProperties": { "type": "string" } }, "CurrentLoad": { "description": "Current load thread for scan node", "type": "string" }, "TotalScansPerformed": { "description": "Total scans performed", "type": "string" }, "CpuLoad": { "description": "CPU load", "type": "string" }, "RamUsage": { "description": "RAM usage", "type": "string" }, "Uptime": { "description": "Uptime", "type": "string" }, "EngineLastUpdate": { "format": "date-time", "description": "Engine last update", "type": "string" }, "EngineRevisionNumber": { "description": "Engine revision number", "type": "string" }, "SystemDriveFreeDiskSpace": { "description": "System drive free disk space. Only for System Scans.\nThis property is not propagated in response when null", "type": "string" }, "ScanNodeAgentDriveFreeDiskSpace": { "description": "Free disk space for the scan node agent drive (only for System Scans)", "type": "string" }, "ScanNodeAgentVersion": { "description": "Scan node agent version", "type": "string" }, "ScanNodeAgentLastUpdate": { "format": "date-time", "description": "Scan node agent last update", "type": "string" }, "FreeDiskSpace": { "description": "Free disk space. Only for discovery scans", "type": "string" }, "PrivateIp": { "description": "Private network Ip address", "type": "string" }, "PublicIp": { "description": "Public network Ip address", "type": "string" }, "Warnings": { "description": "Warnigns reported by the scan node", "type": "array", "items": { "$ref": "#/definitions/NodeWarningType" } }, "LicenseExpirationDate": { "format": "date-time", "description": "When license expires", "type": "string" }, "LicenseActive": { "description": "Current licence state", "type": "boolean" }, "NodeId": { "description": "A scan node identificator (the ID that is present in the scan node license file and Radar Update Service)", "type": "string" } }, "additionalProperties": false }, "ScanNodeGroupViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A unique identifier for Scan Node Groups", "type": "string" }, "Name": { "description": "A Scan Node Group name", "type": "string" } }, "additionalProperties": false }, "ScanNodeLicenseOrderResponseViewModel": { "description": "Represents Scan Node license registration response.", "type": "object", "properties": { "DownloadLink": { "format": "uri", "description": "Location to Scan Node license", "type": "string" }, "InstallerDownloadLinks": { "description": "Location to Scan Node installation packages", "type": "array", "items": { "$ref": "#/definitions/InstallerUrlViewModel" } } }, "additionalProperties": false }, "ScanNodeLicensesViewModel": { "description": "An entity that provides information about scan node licenses for specified organization", "type": "object", "properties": { "ActiveScanNodeLicenses": { "format": "int32", "description": "Number of Scan Node Agent licenses, that are already utilized in this organization's subscription", "type": "integer" }, "ScanNodeLicensesLimit": { "format": "int32", "description": "Number of Scan Node Agent licenses limit for this organization. Null if there's no information", "type": "integer" } }, "additionalProperties": false }, "ScanNodePoolingOnNodeViewModel": { "type": "object", "properties": { "HostIp": { "description": "Host or IP", "type": "string" }, "Port": { "format": "int32", "description": "Port number", "type": "integer" }, "DomainName": { "description": "Domain name", "type": "string" }, "UserName": { "description": "User name", "type": "string" }, "Password": { "description": "Password for communication", "type": "string" }, "ClearPassword": { "description": "Should password clear", "type": "boolean" } }, "additionalProperties": false }, "ScanNodeSettingsViewModel": { "description": "Scan node.", "type": "object", "properties": { "Build": { "format": "int32", "description": "A Scan Node build number", "type": "integer" }, "CreatedBy": { "format": "uuid", "description": "A unique identifier referring to the user that created the item", "type": "string" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "CurrentLoad": { "format": "int32", "description": "A current load", "type": "integer" }, "Description": { "description": "A Scan Node description", "type": "string" }, "DomainName": { "description": "A Scan Node domain name", "type": "string" }, "EnableStateDiscovery": { "description": "A flag that indicates whether the discovery state is enabled", "type": "boolean" }, "FullDescription": { "description": "A Scan Node full description", "type": "string" }, "HardwareInfo": { "description": "A hardware info", "type": "string" }, "HostIP": { "description": "A host IP", "type": "string" }, "Id": { "format": "uuid", "description": "A Scan Node unique identifier", "type": "string" }, "InstallationActive": { "description": "A flag that indicates whether installation is active", "type": "boolean" }, "IsSharedNode": { "description": "A flag that indicates the status of shared mode", "type": "boolean" }, "LastSeen": { "format": "date-time", "description": "A date and time when Scan Node was last seen", "type": "string" }, "LastSeenWarnMinutes": { "format": "int32", "description": "A number of minutes after the warning should be set", "type": "integer" }, "LicenceCreateDateUTC": { "format": "date-time", "description": "Date and time (UTC) when license was created", "type": "string" }, "LicenceExpiryDateUTC": { "format": "date-time", "description": "Date and time (UTC) when license expires", "type": "string" }, "LicenceState": { "format": "int32", "description": "A license state", "type": "integer" }, "Major": { "format": "int32", "type": "integer" }, "MaxSimultaneousScans": { "format": "int32", "description": "A number of maximum simultaneous scans", "type": "integer" }, "Minor": { "format": "int32", "type": "integer" }, "ModifiedBy": { "format": "uuid", "description": "A unique identifier referring to the user who modified the user entry last time", "type": "string" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Name": { "description": "A Scan Node name", "type": "string" }, "NetworkLocationType": { "format": "int32", "description": "A network location type", "type": "integer" }, "NodeId": { "description": "A node identifier", "type": "string" }, "NodeType": { "format": "int32", "description": "A Scan Node type", "type": "integer" }, "Password": { "description": "A password", "type": "string" }, "Port": { "description": "A port number", "type": "string" }, "Proto": { "type": "string" }, "Registered": { "description": "A flag that indicates whether Scan Node is registered", "type": "boolean" }, "Revision": { "format": "int32", "description": "A revision number", "type": "integer" }, "ScanNodeGroupId": { "format": "uuid", "description": "A unique identifier for Scan Node Groups", "type": "string" }, "State": { "format": "int32", "description": "A Scan Node state", "type": "integer" }, "Username": { "description": "An user name", "type": "string" } }, "additionalProperties": false }, "ScanNodeTypes": { "description": "Represents Scan Node types possible values.", "enum": [ "SystemScan", "WebScan", "DiscoveryScan" ], "type": "string" }, "ScanNodeViewModel": { "description": "Physical or virtual scan node.", "type": "object", "properties": { "IsVirtualScanNode": { "description": "Indicates whether this is a virtual scan node", "type": "boolean" }, "CountPhysicalScanNode": { "format": "int32", "description": "Counter physical scan node", "type": "integer" }, "Warnings": { "description": "Warnigns reported by the scan node", "type": "array", "items": { "$ref": "#/definitions/NodeWarningType" } }, "LicenseExpirationDate": { "format": "date-time", "description": "When license expires", "type": "string" }, "LicenseActive": { "description": "Current licence state", "type": "boolean" }, "ChildItems": { "description": "Physical scan nodes in the virtual scan group", "type": "array", "items": { "$ref": "#/definitions/ScanNodeVirtualDetailsViewModel" } }, "ScanNodeStatusWarningSummary": { "format": "int32", "description": "Number of physical scan nodes with status of warning", "type": "integer" }, "ScanNodeStatusErrorSummary": { "format": "int32", "description": "Number of physical scan nodes with status of error", "type": "integer" }, "ScanNodeStatusPauseSummary": { "format": "int32", "description": "Number of physical scan nodes with status of pause", "type": "integer" }, "Id": { "format": "uuid", "description": "Scan Node unique identifier", "type": "string" }, "Name": { "description": "Scan node name", "type": "string" }, "Descriptions": { "description": "Scan node description", "type": "array", "items": { "type": "string" } }, "ScanStatus": { "$ref": "#/definitions/StatsModel" }, "CurrentLoad": { "format": "int32", "description": "Current load thread for scan node", "type": "integer" }, "MaxSimultaneousScans": { "format": "int32", "description": "Max. of simultaneous scans", "type": "integer" }, "EngineLastUpdate": { "format": "date-time", "description": "Time of last updated engine", "type": "string" }, "EngineLastAvailableRevisionNumber": { "description": "Scan node engine last available revision number", "type": "string" }, "LastSeen": { "format": "date-time", "description": "Time of last seen scan node", "type": "string" }, "NodeType": { "$ref": "#/definitions/ScanNodeTypes" }, "IsSharedNode": { "description": "Information about shared scan node", "type": "boolean" }, "IsActive": { "description": "Information about active scan node", "type": "boolean" }, "ShowLastSeenWarning": { "description": "Show the last warning seen", "type": "boolean" }, "IsDefaultShowLastSeenWarning": { "description": "Information about using default setting for last seen warning", "type": "boolean" }, "ShowEngineLastUpdateWarning": { "description": "Show the warning for the last updated engine ", "type": "boolean" } }, "additionalProperties": false }, "ScanNodeVirtualDetailsViewModel": { "description": "Details of scan node.", "type": "object", "properties": { "Warnings": { "description": "Warnings reported by the scan node", "type": "array", "items": { "$ref": "#/definitions/NodeWarningType" } }, "LicenseExpirationDate": { "format": "date-time", "description": "Indicates when license expires", "type": "string" }, "LicenseActive": { "description": "Current license state", "type": "boolean" }, "Id": { "format": "uuid", "description": "Scan Node unique identifier", "type": "string" }, "Name": { "description": "Scan node name", "type": "string" }, "Descriptions": { "description": "Scan node description", "type": "array", "items": { "type": "string" } }, "ScanStatus": { "$ref": "#/definitions/StatsModel" }, "CurrentLoad": { "format": "int32", "description": "Current load thread for scan node", "type": "integer" }, "MaxSimultaneousScans": { "format": "int32", "description": "Max. of simultaneous scans", "type": "integer" }, "EngineLastUpdate": { "format": "date-time", "description": "Time of last updated engine", "type": "string" }, "EngineLastAvailableRevisionNumber": { "description": "Scan node engine last available revision number", "type": "string" }, "LastSeen": { "format": "date-time", "description": "Time of last seen scan node", "type": "string" }, "NodeType": { "$ref": "#/definitions/ScanNodeTypes" }, "IsSharedNode": { "description": "Information about shared scan node", "type": "boolean" }, "IsActive": { "description": "Information about active scan node", "type": "boolean" }, "ShowLastSeenWarning": { "description": "Show the last warning seen", "type": "boolean" }, "IsDefaultShowLastSeenWarning": { "description": "Information about using default setting for last seen warning", "type": "boolean" }, "ShowEngineLastUpdateWarning": { "description": "Show the warning for the last updated engine ", "type": "boolean" }, "CountPhysicalScanNode": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "ScanNodesFilterViewModel": { "type": "object", "properties": { "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "ScanPortChangeType": { "description": "Represents possible types of port changes.", "enum": [ "ScanPortCreated", "ScanPortDeleted", "ScanPortChanged" ], "type": "string" }, "ScanPortSimpleViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A unique identifier of scan port", "type": "string" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" }, "Number": { "format": "int32", "description": "A port number", "type": "integer" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "ScanPortViewModel": { "description": "Represents port data after scan.", "type": "object", "properties": { "IsReappeared": { "description": "A flag that indicates whether port reappears", "type": "boolean" }, "LastChange": { "description": "A list of latest port changes", "type": "array", "items": { "$ref": "#/definitions/PortLastChanges" } }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "IsOpen": { "description": "A flag that indicates if the port is open", "type": "boolean" }, "Service": { "description": "A Service of the port. This could be for example unknown, http, or ftp", "type": "string" }, "Banner": { "description": "A Banner. Includes information, such as protocol, server, etc", "type": "string" }, "IsServiceDetectedByScanner": { "description": "A flag that indicates if service has been detected by scanner", "type": "boolean" }, "ChangeType": { "$ref": "#/definitions/ScanPortChangeType" }, "Id": { "format": "uuid", "description": "A unique identifier of scan port", "type": "string" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" }, "Number": { "format": "int32", "description": "A port number", "type": "integer" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "ScanReportHistoryFilterModel": { "type": "object", "properties": { "ScanDateFrom": { "format": "date-time", "type": "string" }, "ScanDateTo": { "format": "date-time", "type": "string" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "ScanReportHistoryListViewModel": { "description": "Represents scan report history.", "type": "object", "properties": { "ReportId": { "format": "uuid", "description": "A report unique identifier", "type": "string" }, "LastReportId": { "format": "uuid", "description": "A last report unique identifier", "type": "string" }, "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "OS": { "description": "An operating system", "type": "string" }, "ScanningMode": { "$ref": "#/definitions/ScanningMode" }, "ScanType": { "$ref": "#/definitions/ScanType" }, "Target": { "description": "A scan target", "type": "string" }, "VulnerabilitiesCritical": { "format": "int32", "description": "Number of vulnerabilitites with critical severity", "type": "integer" }, "VulnerabilitiesHigh": { "format": "int32", "description": "Number of vulnerabilitites with high severity", "type": "integer" }, "VulnerabilitiesMedium": { "format": "int32", "description": "Number of vulnerabilitites with medium severity", "type": "integer" }, "VulnerabilitiesLow": { "format": "int32", "description": "Number of vulnerabilitites with low severity", "type": "integer" }, "VulnerabilitiesInformational": { "format": "int32", "description": "Number of vulnerabilitites with informational severity", "type": "integer" }, "Change": { "$ref": "#/definitions/ScanChange" }, "ScanDate": { "format": "date-time", "description": "A date and time when scan completed", "type": "string" }, "Compliant": { "$ref": "#/definitions/CompliantLevel" }, "CompliantType": { "$ref": "#/definitions/CompliantType" } }, "additionalProperties": false }, "ScanReports": { "type": "object", "properties": { "scanid": { "format": "uuid", "type": "string" }, "groupid": { "format": "uuid", "type": "string" }, "scantype": { "$ref": "#/definitions/ScanType" } }, "additionalProperties": false }, "ScanRunStateType": { "description": "Indicates the possible states of the scan", "enum": [ "Idle", "Running", "PausedAwaiting", "Paused", "AwaitingForResources", "StoppedAwaiting", "Terminated", "Corrupted", "Completed", "Initialized" ], "type": "string" }, "ScanTechniques": { "format": "int32", "enum": [ 0, 1 ], "type": "integer" }, "ScanTemplatesListDetailsViewModel[SystemScanCustomConfigurationViewModel]": { "type": "object", "properties": { "AssignedScanGroupsList": { "description": "List of assigned scan groups", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "CustomConfiguration": { "$ref": "#/definitions/SystemScanCustomConfigurationViewModel" }, "Id": { "format": "uuid", "description": "A unique identifier for a scan template", "type": "string" }, "Name": { "description": "A scan template name", "type": "string" }, "Description": { "description": "A scan template description", "type": "string" }, "Type": { "$ref": "#/definitions/ScanType" }, "AssignedGroups": { "format": "int32", "description": "Get or set number of assigned scan groups", "type": "integer" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Created": { "format": "date-time", "description": "Get or set the creation date for a created scan template", "type": "string" }, "IsLocked": { "description": "Get or set a value indicating whether the scan template is locked", "type": "boolean" } }, "additionalProperties": false }, "ScanTemplatesListViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A unique identifier for a scan template", "type": "string" }, "Name": { "description": "A scan template name", "type": "string" }, "Description": { "description": "A scan template description", "type": "string" }, "Type": { "$ref": "#/definitions/ScanType" }, "AssignedGroups": { "format": "int32", "description": "Get or set number of assigned scan groups", "type": "integer" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Created": { "format": "date-time", "description": "Get or set the creation date for a created scan template", "type": "string" }, "IsLocked": { "description": "Get or set a value indicating whether the scan template is locked", "type": "boolean" } }, "additionalProperties": false }, "ScanType": { "enum": [ "SystemScan", "WebScan", "Discovery", "EndpointSystemScan" ], "type": "string" }, "ScanViewModel": { "description": "Represents a single scan.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "A scan unique identifier", "type": "string" }, "Name": { "description": "A scan name", "type": "string" }, "LastReportId": { "format": "uuid", "description": "A unique identifier of the last scan report", "type": "string" }, "Hostname": { "description": "A host name", "type": "string" }, "VirtualHostname": { "description": "A virtual host name", "type": "string" }, "MacAddress": { "description": "Target Mac Address", "type": "string" }, "AssignedTo": { "format": "uuid", "description": "A unique identifier of the user assigned to this scan", "type": "string" }, "AssignedToUser": { "$ref": "#/definitions/NameIdItem[Guid]" }, "CreatedByUser": { "$ref": "#/definitions/NameIdItem[Guid]" }, "ScanLastSeen": { "format": "date-time", "description": "Date and time when the scan was last seen (scan is alive)", "type": "string" }, "ScanRunState": { "$ref": "#/definitions/ScanRunStateType" }, "ScanType": { "$ref": "#/definitions/ScanType" }, "CanStartScan": { "description": "A flag that indicates if the scan can start", "type": "boolean" }, "LastScanStart": { "format": "date-time", "description": "Date and time when the scan was last started", "type": "string" }, "LastScanEnd": { "format": "date-time", "description": "Date and time when the scan was last ended", "type": "string" }, "ScanLastCompleted": { "format": "date-time", "description": "A date and time when scan last completed", "type": "string" }, "ScanStatistics": { "description": "An object that contains information about statistics: risk, ETA, open ports," }, "ScanProgress": { "format": "int32", "description": "A value that represent scan progress. It take values [0 - initialized, 100 - completed]", "type": "integer" }, "Tags": { "description": "A list that represents tags pinned to the scan", "type": "array", "items": { "$ref": "#/definitions/TagViewModel" } }, "GroupId": { "format": "uuid", "description": "A unique identifier referring to Scan Group", "type": "string" }, "Group": { "$ref": "#/definitions/ScanGroupSimpleViewModel" }, "SystemScanTemplateId": { "format": "uuid", "description": "A unique identifier referring to the System Scan template", "type": "string" }, "ScheduleId": { "format": "uuid", "description": "A unique identifier referring to Schedule", "type": "string" }, "ScanGroupScheduleId": { "format": "uuid", "description": "A unique identifier reffering to Scan Group Schedule", "type": "string" }, "IsCustomConfiguration": { "description": "A flag that indicates if System Scan has custom configuration", "type": "boolean" }, "CustomConfiguration": { "$ref": "#/definitions/SystemScanCustomConfigurationViewModel" }, "ScanningMode": { "$ref": "#/definitions/ScanningMode" }, "AssetMonitoring": { "$ref": "#/definitions/AssetMonitoringSimpleViewModel" }, "OpenTCPPorts": { "description": "List of open TCP ports", "type": "array", "items": { "$ref": "#/definitions/ScanPortSimpleViewModel" } }, "OpenUDPPorts": { "description": "List of open UDP ports", "type": "array", "items": { "$ref": "#/definitions/ScanPortSimpleViewModel" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "ScannedWhenModeEnum": { "enum": [ "Never", "Before", "After", "Any", "MinOnce" ], "type": "string" }, "ScannedWhenUnitEnum": { "enum": [ "Hours", "Days", "Months" ], "type": "string" }, "ScanningMode": { "description": "A scanning modes.", "enum": [ "RegularScan", "PCIScan", "PassiveScan" ], "type": "string" }, "ScanningPerformances": { "enum": [ "Paranoid", "Sneaky", "Polite", "Normal", "Aggressive", "Insane" ], "type": "string" }, "ScanningProgressViewModel": { "description": "Represents scanning progress.", "type": "object", "properties": { "Status": { "$ref": "#/definitions/ScanRunStateType" }, "Count": { "format": "int32", "description": "A number of scans in given status", "type": "integer" } }, "additionalProperties": false }, "ScanningRestrictionViewModel": { "description": "Scanning restrictions.", "type": "object", "properties": { "ScanningRestrictionEnabled": { "description": "A flag that indicating if scanning restriction is active", "type": "boolean" }, "AllowedIpRangeToScan": { "description": "An IP range for scan", "type": "string" }, "TimeFrames": { "description": "A list of time frames", "type": "array", "items": { "$ref": "#/definitions/TimeFrameViewModel" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "ScansAndScanGroupsViewModel": { "type": "object", "properties": { "ScanGroups": { "description": "A flag that indicates scan groups", "type": "boolean" }, "Scans": { "description": "A flag that indicates scans", "type": "boolean" } }, "additionalProperties": false }, "ScheduleDetails": { "required": [ "Hour", "Minute", "Type" ], "type": "object", "properties": { "Type": { "description": "Recurrence type", "minLength": 1, "type": "string" }, "MonthState": { "$ref": "#/definitions/MonthState" }, "OnDayOfWeek": { "$ref": "#/definitions/DayOfWeek" }, "DayNumber": { "format": "int32", "description": "Day and number of runs", "type": "integer" }, "The": { "$ref": "#/definitions/The" }, "Minute": { "format": "int32", "description": "A minute", "type": "integer" }, "Hour": { "format": "int32", "description": "An hour", "type": "integer" }, "ScheduleName": { "description": "Schedule name", "type": "string" }, "Timezone": { "description": "Base time zone", "type": "string" }, "EveryIteration": { "description": "Month in the quater", "type": "string" } }, "additionalProperties": false }, "ScheduleOptionViewModel": { "description": "Represents a scheduling one time view model.", "type": "object", "properties": { "ScheduleId": { "format": "uuid", "description": "A discovery scan schedule unique identifier", "type": "string" }, "SchedulingMode": { "$ref": "#/definitions/DiscoveryScanSchedulingModes" }, "StartDateTime": { "format": "date-time", "description": "Time and date time to start scheduling", "type": "string" }, "StartImmediately": { "description": "A flag indicating whether the scheduling should start immediately", "type": "boolean" } }, "additionalProperties": false }, "ScheduleViewModel": { "description": "Represents Schedule view model.", "type": "object", "properties": { "BaseTimeZone": { "description": "Base time zone", "type": "string" }, "CreatedBy": { "format": "uuid", "description": "A unique identifier referring to the user that created the item", "type": "string" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "EndSchedulePeriodDateTime": { "format": "date-time", "description": "Date and time when schedule period ends", "type": "string" }, "Id": { "format": "uuid", "description": "A unique identifier for Schedules", "type": "string" }, "IsActive": { "description": "A flag that indicates whether this item is active", "type": "boolean" }, "ModifiedBy": { "format": "uuid", "description": "A unique identifier referring to the user who modified the user entry last time", "type": "string" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Name": { "description": "A Schedule name. Max length 255 characters", "type": "string" }, "NextRun": { "format": "date-time", "description": "Date and time when the Schedule will run next", "type": "string" } }, "additionalProperties": false }, "ScheduledSummaryReportUpdateViewModel": { "required": [ "ReportId", "ReportName", "SummaryReportFilter" ], "type": "object", "properties": { "ScheduleDetails": { "$ref": "#/definitions/ScheduleDetails" }, "Notification": { "$ref": "#/definitions/TaskNotification" }, "ReportId": { "format": "uuid", "description": "A unique identifier for a summary report", "type": "string" }, "SummaryReportFilter": { "$ref": "#/definitions/SummaryReportFilter" }, "ReportName": { "description": "Summary report name", "minLength": 1, "type": "string" }, "ReportDescription": { "description": "A summary report description", "type": "string" }, "Locale": { "description": "A summary report language", "type": "string" } }, "additionalProperties": false }, "ScheduledSummaryReportsListViewModel": { "type": "object", "properties": { "TaskId": { "format": "uuid", "description": "A unique identifier for a task definition", "type": "string" }, "Id": { "format": "uuid", "description": "A unique identifier for a summary report", "type": "string" }, "ReportName": { "description": "A report name", "type": "string" }, "Author": { "description": "A report author", "type": "string" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "HasAssignedSchedule": { "description": "Indicates whether this report has assigned schedule or not", "type": "boolean" }, "FrequencyTranslationKey": { "description": "Schedule frequency", "type": "string" }, "FrequencyTranslationKeyParams": { "description": "Parameters for the $translate.instant()", "type": "object", "additionalProperties": { "type": "string" } }, "LastReportDate": { "description": "Last report date", "type": "string" }, "Active": { "description": "Indicates whether report is active or not", "type": "boolean" }, "State": { "description": "State (ready, failed etc)", "type": "string" }, "CompanyId": { "description": "CompanyId", "type": "string" } }, "additionalProperties": false }, "SchedulingTemplatesViewModel": { "required": [ "BaseTimeZone", "Hour", "Minute", "Name", "Type" ], "type": "object", "properties": { "Id": { "format": "uuid", "description": "Unique identifier of a scheduling template", "type": "string" }, "Name": { "description": "A scheduling template name", "minLength": 1, "type": "string" }, "Type": { "$ref": "#/definitions/RecurrenceType" }, "MonthState": { "$ref": "#/definitions/MonthState" }, "ScanRunCount": { "format": "int32", "description": "A number that indicates how many times this has run", "type": "integer" }, "RunIndefinitely": { "description": "A flag that indicates run indefinitely", "type": "boolean" }, "ActivePeriodInMinutes": { "format": "int32", "description": "Number of minutes describes an active period", "type": "integer" }, "IsExpired": { "description": "A flag that indicates if it is expired", "type": "boolean" }, "OnDayOfWeek": { "$ref": "#/definitions/DayOfWeek" }, "Iteration": { "format": "int32", "description": "A number of iteration", "type": "integer" }, "DayNumber": { "format": "int32", "description": "Day and number of runs", "type": "integer" }, "The": { "$ref": "#/definitions/The" }, "TheQuarterly": { "$ref": "#/definitions/TheQuarterly" }, "NextRun": { "format": "date-time", "description": "Date and time of the next run", "type": "string" }, "BaseTimeZone": { "description": "Base time zone", "minLength": 1, "type": "string" }, "BaseTimeZoneUTCOffset": { "description": "Base time zone UTC offset", "type": "string" }, "EndSchedulePeriodDateTime": { "format": "date-time", "description": "A date and time when schedule period end", "type": "string" }, "Minute": { "format": "int32", "description": "A minute", "type": "integer" }, "Hour": { "format": "int32", "description": "An hour", "type": "integer" }, "GroupAssociationsCount": { "format": "int32", "description": "A number that indicates how many Scan Groups are associated with this scheduling template", "type": "integer" }, "SystemScanAssociationsCount": { "format": "int32", "description": "A number that indicates how many System Scans are associated with this scheduling template", "type": "integer" }, "WebScanAssociationsCount": { "format": "int32", "description": "A number that indicates how many Web Scans are associated with this scheduling template", "type": "integer" }, "NetworkAssociationsCount": { "format": "int32", "description": "A number that indicates how many discovery scans are associated with this scheduling template", "type": "integer" }, "GroupAssociationsNameList": { "description": "A list of Scan Groups associated with this scheduling template", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "SystemScanAssociationsNameList": { "description": "A list of System Scans associated with this scheduling template", "type": "array", "items": { "type": "string" } }, "WebScanAssociationsNameList": { "description": "A list of Web Scans associated with this scheduling template", "type": "array", "items": { "type": "string" } }, "NetworkAssociationsNameList": { "description": "A list of discovery scans associated with this scheduling template", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "SecuritySettingsViewModel": { "description": "Represents settings of security.", "type": "object", "properties": { "IsManagedRemotely": { "description": "Defines if the organization is managed remotely", "type": "boolean" }, "IpRestrictionDuringLogin": { "$ref": "#/definitions/AccessRestrictViewModel" }, "AlwaysRequireTwoFactorAuthenticationDuringLogin": { "description": "A flag that indicates if two factor authentication is forced during authentication", "type": "boolean" }, "CanUserResetPasswordWithoutLogin": { "description": "A flat that indicates if user can reset themselve password", "type": "boolean" }, "SecurityStance": { "$ref": "#/definitions/UserAccountSecurityStances" }, "EmailNotificationDetailsLevel": { "$ref": "#/definitions/NotificationDetailsLevels" }, "IsolationEnabled": { "description": "Defines if the organization is isolated (users of organizations higher in the hierarchy will not have access to it)", "type": "boolean" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "SimpleDiscoveryScanAssetMonitoringViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "An asset monitoring unique identifier", "type": "string" }, "Name": { "description": "An asset monitoring name", "type": "string" } }, "additionalProperties": false }, "SimpleInternetDiscoveryAssetMonitoringViewModel": { "type": "object", "properties": { "Query": { "description": "Internet discovery query", "type": "string" } }, "additionalProperties": false }, "SimpleTicketViewModel": { "description": "Represents ticket (simplified version).", "type": "object", "properties": { "Id": { "format": "uuid", "description": "A ticket unique identifier", "type": "string" }, "Number": { "format": "int32", "description": "A ticket number", "type": "integer" }, "Name": { "description": "A ticket name", "type": "string" } }, "additionalProperties": false }, "SimpleUserViewModel": { "type": "object", "properties": { "FirstName": { "description": "An user first name", "type": "string" }, "Name": { "description": "An user name", "type": "string" }, "Value": { "format": "uuid", "description": "An user unique identifier", "type": "string" }, "IsLocalOrganizationUser": { "description": "A value that indicates whether this user is assigned to the organization", "type": "boolean" } }, "additionalProperties": false }, "StateVulnerabilitiesAndFindingsFilterModelEnum": { "enum": [ "All", "NewAndCurrentFindings", "OnlyNewFindings", "OnlyMitigatedFindings" ], "type": "string" }, "StatsModel": { "type": "object", "properties": { "CurrentLoad": { "format": "int32", "type": "integer" }, "MaxLoad": { "format": "int32", "type": "integer" }, "TotalScansPerformed": { "format": "int32", "type": "integer" }, "EngineLastUpdate": { "format": "date-time", "type": "string" }, "ScanNodeVersion": { "type": "string" }, "ControllerLastUpdate": { "format": "date-time", "type": "string" }, "EngineRevisionNumber": { "format": "int32", "type": "integer", "readOnly": true } }, "additionalProperties": false }, "StatusGroups": { "description": "It is a kind of general \"category\" for the vulnerability statuses.\nEvery vulnerability status falls into one of these categories. Then, when the vulnerability instance is marked with the specific, custom status,\nwe still know and can check whether it means that the vulnerability is \"closed\" or still a pending issue (open / in progress)", "enum": [ "Closed", "Open" ], "type": "string" }, "StatusTypes": { "description": "In the KSC database, there is one table which stores statuses for both: tickets and vulnerability instances.\nStatusType is needed to identify whether the particular status belongs to vulnerability instances (is in use there) or one of the ticket status category : open/close", "enum": [ "Vulnerability", "TicketOpen", "TicketClosed", "StatusIsDeleted" ], "type": "string" }, "StoreAssetsPeriodViewModel": { "description": "How long assets should be kept in the system.", "type": "object", "properties": { "StoreAssetsPeriod": { "$ref": "#/definitions/StoreAssetsPeriods" } }, "additionalProperties": false }, "StoreAssetsPeriods": { "description": "How long assets should be kept in the system.", "enum": [ "Forever", "Month", "Quarter", "HalfYear", "Year", "TwoYears" ], "type": "string" }, "StoreReportsPeriodViewModel": { "description": "How long scanning reports should be kept.", "type": "object", "properties": { "StoreReportsPeriod": { "$ref": "#/definitions/StoreReportsPeriods" } }, "additionalProperties": false }, "StoreReportsPeriods": { "description": "How long scanning reports should stay in the system.", "enum": [ "Month", "Quarter", "HalfYear", "Year", "TwoYears" ], "type": "string" }, "SummaryReportFilter": { "description": "Summary report filter.", "type": "object", "properties": { "SelectedScopeType": { "description": "Scope selected", "type": "string" }, "IncludeHighLevel": { "description": "A flag that indicates if high level severity vulnerabilities are included", "type": "boolean" }, "IncludeMediumLevel": { "description": "A flag that indicates if medium level severity vulnerabilities will be included", "type": "boolean" }, "IncludeLowLevel": { "description": "A flag that indicates if low level severity vulnerabilities are included", "type": "boolean" }, "IncludeInfoLevel": { "description": "A flag that indicates if informational vulnerabilities are included", "type": "boolean" }, "IncludeCriticalLevel": { "description": "A flag that indicates if critical vulnerabilities are included", "type": "boolean" }, "CVSSVersion": { "$ref": "#/definitions/CVSSVersion" }, "IncludeStatuses": { "description": "A dictionary of vulnerability statuses", "type": "object", "additionalProperties": { "type": "boolean" } }, "ShowStatusNamesOnReport": { "description": "A flag that indicates if a status name appears", "type": "boolean" }, "ShowAuditorNotes": { "description": "A flag that indicates if auditor notes appear", "type": "boolean" }, "ShowTags": { "description": "A flag that indicates if show tags", "type": "boolean" }, "ShowChangeIndicator": { "description": "A flag that indicates if show change indicator", "type": "boolean" }, "IncludePotential": { "description": "A flag that indicates if include potential vulnerabilities", "type": "boolean" }, "IncludeExploitable": { "description": "A flag that indicates whether to include vulnerabilities where a public exploit is available", "type": "boolean" }, "IncludeImages": { "description": "A flag that indicates if include images", "type": "boolean" }, "IncludeExternalReferences": { "description": "A flag that indicates if external references are included", "type": "boolean" }, "Customer": { "$ref": "#/definitions/ContactInformation" }, "Vendor": { "$ref": "#/definitions/ContactInformation" }, "IncludeLastReportsForScans": { "description": "A list of scans whose last reports will be included in report", "type": "array", "items": { "$ref": "#/definitions/SummaryReportFilterScans" } }, "IncludeLastReportsForScanGroups": { "description": "A list of Scan Groups that have their latest reports included in the report", "type": "array", "items": { "$ref": "#/definitions/SummaryReportFilterScans" } }, "IncludeAllVulnStatuses": { "description": "Include vulnerabilities with any status in organization", "type": "boolean" }, "IncludeAssets": { "description": "A list of assets ids to include in report", "type": "array", "items": { "format": "uuid", "type": "string" } }, "Tags": { "description": "List of tags", "type": "array", "items": { "$ref": "#/definitions/TagView" } }, "TagOperator": { "$ref": "#/definitions/TagOperator" }, "TagsScan": { "description": "A list of TagView objects", "type": "array", "items": { "$ref": "#/definitions/TagView" } }, "TagOperatorScan": { "$ref": "#/definitions/TagOperator" }, "IsDynamicScope": { "description": "A dynamic summary report means all scans from specific scan groups", "type": "boolean" }, "ResponsiblePeopleForVulns": { "description": "A list of responsible people for vulnerabilities", "uniqueItems": true, "type": "array", "items": { "format": "uuid", "type": "string" } }, "ShowResponsiblePerson": { "description": "A flag that indicates if a responsible person is shown", "type": "boolean" }, "IncludeVulnsFromAllFamilies": { "description": "A flag that indicates if include vulnerabiities from all families", "type": "boolean" }, "IncludeVulnsFamily": { "description": "A list of vulnerability families that must be included", "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "IncludeVulnsFromAllWsCategories": { "description": "A flag that indicates if include vulnerabilites of all Web Scan categories", "type": "boolean" }, "IncludeVulnsWsCategory": { "description": "A list of Web Scan vulnerabilites categories to include", "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "IncludeLocalExploitableVulns": { "description": "A flag that indicates if include local exploitable vulnerabilities", "type": "boolean" }, "IncludeRemoteExploitableVulns": { "description": "A flag that indicates if include remote exploitable vulnerabilites", "type": "boolean" }, "IncludeAllVulns": { "description": "A flag that indicates if include all vulnerabilities", "type": "boolean" }, "IncludeScanTypeList": { "description": "A list with scan types", "type": "array", "items": { "$ref": "#/definitions/ScanType" }, "readOnly": true }, "IncludeSystemScans": { "type": "boolean", "readOnly": true }, "IncludeWebScans": { "type": "boolean", "readOnly": true }, "AllExistingAndNewlyCreated": { "type": "boolean" } }, "additionalProperties": false }, "SummaryReportFilterScans": { "description": "Scan filter for summary report.", "type": "object", "properties": { "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "GroupId": { "format": "uuid", "description": "A Scan Group unique identifier", "type": "string" }, "ScanType": { "$ref": "#/definitions/ScanType" } }, "additionalProperties": false }, "SummaryReportFormats": { "format": "int32", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer" }, "SummaryReportRegenerateViewModel": { "description": "Summary report regenerate parameters.", "required": [ "BaseReportId", "NewReportName" ], "type": "object", "properties": { "BaseReportId": { "format": "uuid", "description": "A unique identifier for a base report", "type": "string" }, "NewReportName": { "description": "A new summary report name", "minLength": 1, "type": "string" }, "NewReportDescription": { "description": "A description of the new summary report", "type": "string" } }, "additionalProperties": false }, "SummaryReportsFilterModel": { "type": "object", "properties": { "ReportName": { "description": "A report name", "type": "string" }, "HasNoSortingField": { "description": "A flag that indicates no sorting field. It is set to true", "type": "boolean", "readOnly": true }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "SystemScanCustomConfigurationViewModel": { "description": "Represents System Scan custom configuration.", "type": "object", "properties": { "TcpPortRange": { "description": "Get or set scan TCP port range", "type": "string" }, "UdpPortRange": { "description": "Get or set scan UDP port range", "type": "string" }, "TcpScanTechnique": { "$ref": "#/definitions/ScanTechniques" }, "ScanningPerformance": { "$ref": "#/definitions/ScanningPerformances" }, "SkipBackported": { "description": "Gets or sets a value indicating whether the skip backported feature is enabled", "type": "boolean" }, "ExtendedScanLog": { "description": "Gets or sets a value indicating whether the extended scan logs are enabled", "type": "boolean" }, "AuthenticationModes": { "description": "An authentication modes", "type": "array", "items": { "$ref": "#/definitions/AuthModeInput" } }, "PluginSelection": { "$ref": "#/definitions/PluginSelectionViewModel" } }, "additionalProperties": false }, "SystemScanReportTopViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "CvssBaseScore": { "format": "double", "description": "A CVSS base score", "type": "number" }, "RiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "Name": { "description": "A vulnerability name (diplay name)", "type": "string" } }, "additionalProperties": false }, "SystemScanReportViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A System Scan unique identifier", "type": "string" }, "CompliantType": { "$ref": "#/definitions/CompliantType" }, "ScanEndDate": { "format": "date-time", "description": "Date and time when scan ends", "type": "string" }, "ScanStartDate": { "format": "date-time", "description": "Date and time when scan starts", "type": "string" }, "OS": { "description": "An operating system", "type": "string" }, "MacAddress": { "description": "MAC address", "type": "string" }, "Compliant": { "$ref": "#/definitions/CompliantLevel" } }, "additionalProperties": false }, "SystemScanVulnerabilitiesAndFindingsManualViewModel": { "type": "object", "properties": { "VulnerabilityType": { "$ref": "#/definitions/VulnTypes" }, "VulnerabilityStatusId": { "format": "uuid", "description": "A vulnerability status", "type": "string" }, "Port": { "description": "A port number", "type": "string" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" }, "Findings": { "description": "Findings", "type": "string" }, "VulnerabilityName": { "description": "A vulnerability name", "type": "string" }, "Synopsis": { "description": "A synopsis", "type": "string" }, "VulnerabilityDescription": { "description": "A vulnerability description", "type": "string" }, "Solution": { "description": "A solution", "type": "string" }, "CvssBaseScore": { "format": "double", "description": "A CVSS base score", "type": "number" }, "CvssV3BaseScore": { "format": "double", "description": "A CVSS base score", "type": "number" }, "CvssVector": { "description": "A CVSS vector", "type": "string" }, "CvssV3Vector": { "description": "A CVSS vector", "type": "string" }, "VulnerabilityCategory": { "description": "A vulnerability family", "type": "string" }, "DenialOfService": { "description": "A flag that indicates if it is denial of service", "type": "boolean" }, "ReferencesOrLinks": { "description": "References or links", "type": "array", "items": { "$ref": "#/definitions/VulnerabilityReferenceViewModel" } }, "Cves": { "description": "A comma-delimited CVEs", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "SystemTimeZonesViewModel": { "description": "System time zone view model.", "type": "object", "properties": { "Id": { "description": "A time zone identifier", "type": "string" }, "DisplayName": { "description": "A display name", "type": "string" }, "BaseUtcOffset": { "description": "A base UTC offset", "type": "string" } }, "additionalProperties": false }, "TagOperator": { "description": "A tag operators.", "enum": [ "All", "Any" ], "type": "string" }, "TagReferenceType": { "enum": [ "Vulnerability", "Scan", "Ticket", "ScanGroup", "Asset" ], "type": "string" }, "TagView": { "type": "object", "properties": { "Manual": { "description": "A flag that indicates if a tag has been added manually", "type": "boolean" }, "FriendlyName": { "description": "Friendly name for a tag", "type": "string" }, "Component": { "description": "A component where a tag is connected to. For example, ScanGroup", "type": "string" }, "Type": { "description": "Tag type", "type": "string" }, "Source": { "description": "Source", "type": "string" }, "TechnicalName": { "description": "Technical name for a tag", "type": "string" } }, "additionalProperties": false }, "TagViewModel": { "description": "Represent tag.", "type": "object", "properties": { "FriendlyName": { "description": "A tag friendly name", "type": "string" }, "TechnicalName": { "description": "A tag technical name", "type": "string" }, "IsInherited": { "description": "A flag that indicates whether a tag is inherited", "type": "boolean" }, "IsManual": { "description": "A flag that indicates that a tag has been manually created", "type": "boolean" }, "ReferenceType": { "$ref": "#/definitions/TagReferenceType" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "TargetRelatedBasicFieldEnum": { "description": "Type of fields for affected hosts on which filter can be set.", "enum": [ "Name", "Hostname", "IPAddress", "OS", "Ports", "TargetSite", "TextFilter" ], "type": "string" }, "TargetScanViewModel": { "description": "Represent target scan parameters. Set FQDN or IP address. You can also define FQDN or IP together with friendly name.\nIf the friendly name is a valid domain name it will be used for the Web domain field.", "required": [ "ScanTarget" ], "type": "object", "properties": { "ScanTarget": { "description": "A fully qualified domain name or IP address", "minLength": 1, "type": "string" }, "Name": { "description": "A friendly name", "type": "string" }, "VirtualHostname": { "description": "A web domain name", "type": "string" }, "MacAddress": { "description": "A target MAC address", "type": "string" } }, "additionalProperties": false }, "TaskDefinition": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "createdBy": { "type": "string" }, "active": { "type": "boolean" }, "createdOn": { "type": "string" }, "orgId": { "type": "string" }, "updatedOn": { "type": "string" }, "lastReportDate": { "type": "string" }, "expirationPeriod": { "type": "string" }, "locale": { "type": "string" }, "schedule": { "$ref": "#/definitions/TaskSchedule" }, "state": { "type": "string" }, "notification": { "$ref": "#/definitions/TaskNotification" }, "template": { "$ref": "#/definitions/TaskTemplate" }, "taskId": { "format": "uuid", "type": "string" } }, "additionalProperties": false }, "TaskDefinitionCreateModel": { "required": [ "ReportName", "SummaryReportFilter" ], "type": "object", "properties": { "TaskDefinition": { "$ref": "#/definitions/TaskDefinition" }, "ScheduleDetails": { "$ref": "#/definitions/ScheduleDetails" }, "Notification": { "$ref": "#/definitions/TaskNotification" }, "GenerateReportInstance": { "description": "Flag indicating whether user wants to generate new report instance instantly or not", "type": "boolean" }, "SummaryReportFilter": { "$ref": "#/definitions/SummaryReportFilter" }, "ReportName": { "description": "Summary report name", "minLength": 1, "type": "string" }, "ReportDescription": { "description": "A summary report description", "type": "string" }, "Locale": { "description": "A summary report language", "type": "string" } }, "additionalProperties": false }, "TaskNotification": { "type": "object", "properties": { "format": { "type": "string" }, "linkExpirationPeriod": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "TaskReport": { "type": "object", "properties": { "ReportId": { "format": "uuid", "type": "string" }, "Expires": { "format": "date-time", "type": "string" }, "TaskId": { "format": "uuid", "type": "string" }, "TaskTemplate": { "$ref": "#/definitions/TaskTemplate" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "ReportType": { "type": "string" }, "State": { "type": "string" }, "CreatedBy": { "description": "A unique identifier referring to the user that created the item", "type": "string" }, "Formats": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "TaskReportsResponse": { "type": "object", "properties": { "reports": { "type": "array", "items": { "$ref": "#/definitions/TaskReport" } }, "name": { "type": "string" }, "description": { "type": "string" }, "createdBy": { "type": "string" }, "active": { "type": "boolean" }, "createdOn": { "type": "string" }, "orgId": { "type": "string" }, "updatedOn": { "type": "string" }, "lastReportDate": { "type": "string" }, "expirationPeriod": { "type": "string" }, "locale": { "type": "string" }, "schedule": { "$ref": "#/definitions/TaskSchedule" }, "state": { "type": "string" }, "notification": { "$ref": "#/definitions/TaskNotification" }, "template": { "$ref": "#/definitions/TaskTemplate" }, "taskId": { "format": "uuid", "type": "string" } }, "additionalProperties": false }, "TaskSchedule": { "type": "object", "properties": { "period": { "type": "string" }, "executeAt": { "type": "string" }, "scheduleName": { "type": "string" }, "dayOfWeek": { "type": "string" }, "time": { "type": "string" }, "monthDay": { "type": "string" }, "everyIteration": { "type": "string" }, "baseTimeZone": { "type": "string" }, "monthState": { "$ref": "#/definitions/MonthState" }, "the": { "$ref": "#/definitions/The" } }, "additionalProperties": false }, "TaskTemplate": { "type": "object", "properties": { "name": { "type": "string", "readOnly": true }, "rawFilter": { "type": "string" }, "parameters": { "$ref": "#/definitions/TaskTemplateParameters" } }, "additionalProperties": false }, "TaskTemplateParameters": { "type": "object", "properties": { "includeassets": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "includenetworkscangroups": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "includelastreportsforscans": { "type": "array", "items": { "$ref": "#/definitions/ScanReports" } }, "includerefs": { "type": "boolean" }, "severitylevel": { "type": "array", "items": { "type": "string" } }, "showauditornotes": { "type": "boolean" }, "showtags": { "type": "boolean" }, "showstatusnamesonreport": { "type": "boolean" }, "includeallvulnsstates": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "tagsscan": { "type": "array", "items": { "type": "string" } }, "vulnerabilityfamilies": { "type": "array", "items": { "type": "string" } }, "vulnsstates": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "wsvulnerabilitycategories": { "type": "array", "items": { "type": "string" } }, "scopetype": { "type": "string" } }, "additionalProperties": false }, "The": { "enum": [ "None", "First", "Second", "Third", "Fourth", "Last" ], "type": "string" }, "TheQuarterly": { "enum": [ "None", "First", "Second", "Third" ], "type": "string" }, "ThreatTypes": { "enum": [ "Weakness", "Attack", "Nonclassified" ], "type": "string" }, "TicketActivityView": { "type": "object", "properties": { "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "UserId": { "format": "uuid", "description": "User unique identifier", "type": "string" }, "Firstname": { "description": "User first name", "type": "string" }, "Surname": { "description": "User surname", "type": "string" }, "TextContent": { "description": "Ticket activity description", "type": "string" } }, "additionalProperties": false }, "TicketCommentViewModel": { "type": "object", "properties": { "Comment": { "description": "A ticket comment", "type": "string" } }, "additionalProperties": false }, "TicketFollowerEnum": { "enum": [ "UserTypeAssigned", "UserTypeFollower" ], "type": "string" }, "TicketFollowerViewModel": { "type": "object", "properties": { "Email": { "description": "Follower email address", "type": "string" }, "UserId": { "format": "uuid", "description": "Follower user unique identifier", "type": "string" } }, "additionalProperties": false }, "TicketFollowersViewModel": { "type": "object", "properties": { "Name": { "description": "Follower name", "type": "string" }, "Email": { "description": "Follower email", "type": "string" }, "UserId": { "format": "uuid", "description": "Follower unique identifier", "type": "string" }, "TicketId": { "format": "uuid", "description": "A ticket unique identifier", "type": "string" }, "TicketUserId": { "format": "uuid", "description": "Unique identifier of the user that is connected to the ticket", "type": "string" }, "Type": { "$ref": "#/definitions/TicketFollowerEnum" } }, "additionalProperties": false }, "TicketGroupedVulnerabilityOnHostViewModel": { "description": "Grouped vulnerabilities on host attached to ticket.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "Name": { "description": "A vulnerability name", "type": "string" }, "VulnerabilitiesInstancesCount": { "format": "int32", "description": "A number of vulnerability instances in a vulnerability", "type": "integer" }, "TotalNumberOfVulnerabilityInstancesPerVulnerability": { "format": "int32", "description": "A number of vulnerability instances for a vulnerability that is not attached to any ticket", "type": "integer" } }, "additionalProperties": false }, "TicketGroupedVulnerabilityOnSiteViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability instance unique identifier", "type": "string" }, "Category": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Plugin": { "$ref": "#/definitions/NameIdItem[Int32]" }, "ClassVariant": { "description": "A class variant", "type": "string" }, "ManualId": { "format": "uuid", "description": "A manual vulnerability unique identifier", "type": "string" }, "VulnerabilitiesInstancesCount": { "format": "int32", "description": "A number of vulnerability instances in a vulnerability category", "type": "integer" }, "TotalNumberOfVulnerabilityInstancesPerCategory": { "format": "int32", "description": "A number of vulnerability instances in a category except those that are currently attached to the ticket", "type": "integer" } }, "additionalProperties": false }, "TicketSettingsViewModel": { "description": "Represents settings of ticket.", "type": "object", "properties": { "DaysBeforeTicketDeadline": { "format": "int32", "description": "Days before tikects deadline", "type": "integer" }, "DeadlineReachedNotification": { "description": "A flag that indicates if deadline reached notification is turned on", "type": "boolean" } }, "additionalProperties": false }, "TicketStatusViewModel": { "description": "Model represents a ticket status.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "A ticket status unique identifier", "type": "string" }, "Name": { "description": "Ticket status name", "type": "string" }, "StatusType": { "$ref": "#/definitions/StatusTypes" } }, "additionalProperties": false }, "TicketViewModel": { "description": "Portal ticketing system ticket ViewModel.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "A ticket unique identifier", "type": "string" }, "CreatedBy": { "$ref": "#/definitions/NameIdItem[Guid]" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "DeadlineDate": { "format": "date-time", "description": "A deadline date and time (UTC)", "type": "string" }, "Description": { "description": "A ticket description", "type": "string" }, "Estimate": { "format": "int32", "description": "An estimate. In hours", "type": "integer" }, "ModifiedBy": { "format": "uuid", "description": "A unique identifier referring to the user who modified the user entry last time", "type": "string" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Name": { "description": "A ticket name", "type": "string" }, "Number": { "format": "int32", "description": "A ticket number", "type": "integer" }, "Priority": { "format": "int32", "description": "A ticket priority", "type": "integer" }, "Status": { "$ref": "#/definitions/VulnerabilityStatusViewModel" }, "WorkHours": { "format": "int32", "description": "A number of work hours", "type": "integer" }, "WorkRemaining": { "format": "int32", "description": "A number of work remaining hours", "type": "integer" }, "AssignedTo": { "$ref": "#/definitions/NameIdItem[Guid]" }, "VulnerabilitiesCount": { "format": "int32", "description": "Number of vulnerabilities attached to ticket", "type": "integer" } }, "additionalProperties": false }, "TicketVulnerabilityOnHostViewModel": { "description": "Vulnerability on host attached to ticket.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "vulnerability instance unique identifier", "type": "string" }, "Vulnerability": { "$ref": "#/definitions/NameIdItem[Guid]" }, "CVSSBaseScore": { "format": "double", "description": "Severity", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "Severity, CVSS v3", "type": "number" }, "Port": { "format": "int32", "description": "Port number", "type": "integer" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" }, "Host": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Status": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Type": { "$ref": "#/definitions/ScanType" }, "PluginId": { "format": "int32", "description": "Plugin unique identifier", "type": "integer" }, "Ticket": { "$ref": "#/definitions/NameIdItem[Guid]" }, "ScanGroup": { "$ref": "#/definitions/NameIdItem[Guid]" }, "TotalNumberOfVulnerabilityInstancesPerVulnerability": { "format": "int32", "description": "A number of vulnerability instances for a vulnerability that is not attached to any ticket", "type": "integer" } }, "additionalProperties": false }, "TicketVulnerabilityOnSiteViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability instance unique identifier", "type": "string" }, "Category": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Status": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Host": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Plugin": { "$ref": "#/definitions/NameIdItem[Int32]" }, "Ticket": { "$ref": "#/definitions/NameIdItem[Guid]" }, "ScanGroup": { "$ref": "#/definitions/NameIdItem[Guid]" }, "ClassVariant": { "description": "A class variant", "type": "string" }, "ManualId": { "format": "uuid", "description": "A manual vulnerability unique identifier", "type": "string" }, "TotalNumberOfVulnerabilityInstancesPerCategory": { "format": "int32", "description": "A number of vulnerability instances for a category that is not attached to any ticket", "type": "integer" } }, "additionalProperties": false }, "TicketsFilterViewModel": { "description": "Tickets Filter viewModel.", "type": "object", "properties": { "StatusIds": { "description": "A list of status unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "DeadlineDateFrom": { "format": "date-time", "description": "A deadline from date and time", "type": "string" }, "DeadlineDateTo": { "format": "date-time", "description": "A deadline to date and time", "type": "string" }, "AssignedToId": { "format": "uuid", "description": "A unique identifier of the user who is assigned to the ticket", "type": "string" }, "OnlyTicketsPastDeadline": { "description": "A flag that indicates that the result shows only tickets that are past the deadline", "type": "boolean" }, "OnlyMyTickets": { "description": "A flag that indicates that the result shows only my tickets", "type": "boolean" }, "TicketIds": { "description": "Tickets IDs to filter data", "type": "array", "items": { "format": "uuid", "type": "string" } }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "TicketsSummaryViewModel": { "type": "object", "properties": { "NumberOfVulnerabilities": { "format": "int32", "description": "A number of vulnerabilities", "type": "integer" }, "NumberOfClosedVulnerabilities": { "format": "int32", "description": "A number of closed vulnerabilities", "type": "integer" }, "NumberOfOpenVulnerabilities": { "format": "int32", "description": "A number of open vulnerabilities", "type": "integer" }, "NumberOfTickets": { "format": "int32", "description": "A number of tickets", "type": "integer" }, "NumberOfOpenTickets": { "format": "int32", "description": "A number of open tickets", "type": "integer" }, "NumberOfClosedTickets": { "format": "int32", "description": "A number of close tickets", "type": "integer" } }, "additionalProperties": false }, "TimeFrameViewModel": { "description": "Represents time frame for restrictions.", "type": "object", "properties": { "IpRangeAllowed": { "description": "An IP range", "type": "string" }, "WindowsType": { "description": "A Windows type. Generally there are two types of time scanning restrictions: allowed and denied", "type": "string" }, "Schedule": { "$ref": "#/definitions/SchedulingTemplatesViewModel" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "UpdateDiscoveryScanDefinitionViewModel": { "description": "Represents a Discovery Scan update parameters.", "required": [ "Id", "ScanNodeId", "ScanTarget", "ScheduleOption", "TemplateId" ], "type": "object", "properties": { "Id": { "format": "uuid", "description": "A unique identifier for a discovery scan", "type": "string" }, "ScanTarget": { "$ref": "#/definitions/DiscoveryScanDefinitionScanTargetViewModel" }, "MessageNotification": { "description": "Message notifications", "type": "array", "items": { "$ref": "#/definitions/MessageNotificationViewModel" } }, "ScanNodeId": { "format": "uuid", "description": "A unique identifier for a discovery scan node", "type": "string" }, "ScheduleOption": { "$ref": "#/definitions/ScheduleOptionViewModel" }, "TemplateId": { "format": "uuid", "description": "A discovery scan template unique identifier", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "UpdateDiscoveryScanTemplateViewModel": { "required": [ "Id", "Name" ], "type": "object", "properties": { "Id": { "format": "uuid", "description": "A discovery scan template unique identifier", "type": "string" }, "Name": { "description": "A discovery scan template name", "minLength": 1, "type": "string" }, "Description": { "description": "A discovery scan template description", "type": "string" }, "Configuration": { "$ref": "#/definitions/DiscoveryScanCustomConfigurationViewModel" } }, "additionalProperties": false }, "UpdateOperationsEnum": { "description": "An enum for update operations.", "enum": [ "Add", "Remove" ], "type": "string" }, "UpdateScanGroupViewModel": { "description": "Parameters for updating the existing Scan Group.", "required": [ "GroupId", "MessageNotification", "ResponsiblePersonId", "ScanGroupName" ], "type": "object", "properties": { "GroupId": { "format": "uuid", "description": "A Scan Group unique identifier", "type": "string" }, "OverrideCustomSettings": { "description": "A flag that indicate that custom settings will be overridden.\nBy setting one of: OverrideSSSchedule, OverrideWSSchedule, OverrideSSTemplate, OverrideWSTemplate to true you are about to override custom settings of schedules and scan templates.\nIf you are SURE (!!) you want to override them with group settings set OverrideCustomSettings to true", "type": "boolean" }, "OverrideSSSchedule": { "description": "A flag that indicates that the System Scan schedule settings will be overridden", "type": "boolean" }, "OverrideWSSchedule": { "description": "A flag that indicates that the Web Scan schedule settings will be overridden", "type": "boolean" }, "OverrideSSTemplate": { "description": "A flag to indicate that the System Scan template settings are overridden", "type": "boolean" }, "OverrideWSTemplate": { "description": "A flag that indicates that the Web Scan template settings will be overridden", "type": "boolean" }, "SystemScanSettingsEnabled": { "description": "A scan type that will be enabled. Either SystemScanSettingsEnabled or WebScanSettingsEnabled may be enabled", "type": "boolean" }, "WebScanSettingsEnabled": { "description": "A scan type that will be enabled. Either SystemScanSettingsEnabled or WebScanSettingsEnabled may be enabled", "type": "boolean" }, "ScanGroupName": { "description": "A scan group name", "minLength": 1, "type": "string" }, "ScanDescription": { "description": "A scan description", "type": "string" }, "ResponsiblePersonId": { "format": "uuid", "description": "An ID of a person in charge", "type": "string" }, "MaxSystemScans": { "format": "int32", "description": "Maximum System Scans", "type": "integer" }, "MaxWebScans": { "format": "int32", "description": "Maximum Web Scans", "type": "integer" }, "SystemScanTemplateId": { "format": "uuid", "description": "A unique identifier for System Scan template", "type": "string" }, "WebScanTemplateId": { "format": "uuid", "description": "A unique identifier for Web Scan template", "type": "string" }, "SystemScanNodeId": { "format": "uuid", "description": "A unique identifier for System Scan node", "type": "string" }, "WebScanNodeId": { "format": "uuid", "description": "A unique identifier for Web Scan node", "type": "string" }, "SystemScanScheduleId": { "format": "uuid", "description": "A unique identifier for System Scan node", "type": "string" }, "WebScanScheduleId": { "format": "uuid", "description": "Web Scan schedule unique identifier", "type": "string" }, "MessageNotification": { "description": "A message notification", "type": "array", "items": { "$ref": "#/definitions/MessageNotificationViewModel" } }, "Tags": { "description": "Scan Group tags", "type": "array", "items": { "type": "string" } }, "ScanningMode": { "$ref": "#/definitions/ScanningMode" }, "AssetMonitoringConfigurations": { "description": "Asset monitoring configurations", "type": "array", "items": { "$ref": "#/definitions/ScanGroupAssetMonitoringViewModel" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "UpdateScanNodeSettingsViewModel": { "description": "Scan node settings for update.", "required": [ "Id", "ScanNodeType" ], "type": "object", "properties": { "Id": { "format": "uuid", "description": "Scan node id", "type": "string" }, "Name": { "description": "Scan node name", "type": "string" }, "Description": { "description": "Scan node description", "type": "string" }, "NodeIdentifier": { "format": "uuid", "description": "Node unique identifier for scan node", "type": "string" }, "ScanNodeType": { "$ref": "#/definitions/ScanNodeTypes" }, "LastSeenWarnMinutes": { "format": "int32", "description": "How many minutes a scan node is not available before a warning appears", "type": "integer" }, "DefaultLastSeenWarnMinutes": { "format": "int32", "description": "Default value how many minutes a scan node is not available before a warning appears", "type": "integer" }, "IsUsingDefaultLastSeenWarnMinutes": { "description": "Is using deafult setting for condition to show warning about last seen scan node", "type": "boolean" }, "PoolingOnNode": { "$ref": "#/definitions/PoolingOnNode" }, "PoolingOnNodeViewModel": { "$ref": "#/definitions/ScanNodePoolingOnNodeViewModel" } }, "additionalProperties": false }, "UpdateSystemScanViewModel": { "description": "Represents parameters to update existing system scan.", "required": [ "MessageNotification", "ScanId" ], "type": "object", "properties": { "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "Name": { "description": "A scan name", "type": "string" }, "Hostname": { "description": "A System Scan host name", "type": "string" }, "VirtualHostname": { "description": "A System Scan virtual host name", "type": "string" }, "AssignedTo": { "format": "uuid", "description": "A System Scan assigned user unique identifier", "type": "string" }, "IsCustomConfiguration": { "description": "A flag to indicate that the System Scan template settings are overridden", "type": "boolean" }, "CustomConfiguration": { "$ref": "#/definitions/SystemScanCustomConfigurationViewModel" }, "SystemScanScheduleId": { "format": "uuid", "description": "Unique identifier for a System Scan schedule", "type": "string" }, "MessageNotification": { "description": "A message notification", "type": "array", "items": { "$ref": "#/definitions/MessageNotificationViewModel" } }, "MacAddress": { "description": "A MAC address", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "UpdateWebScanRecordingItemViewModel": { "description": "Represents upadate Web Scan recording item.", "type": "object", "properties": { "RequestHeaderMd5": { "description": "A request header", "type": "string" }, "IsLoginRequest": { "description": "A flag indicating a login request", "type": "boolean" }, "IsDeleted": { "type": "boolean" } }, "additionalProperties": false }, "UpdateWebScanViewModel": { "description": "Parameters to create Web Scan.", "required": [ "MessageNotification" ], "type": "object", "properties": { "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "ScanTargetUrl": { "description": "Target URL for a Web Scan", "type": "string" }, "Name": { "description": "A Web Scan name", "type": "string" }, "AssignedToId": { "format": "uuid", "description": "Unique identifier for the assigned user of a Web Scan", "type": "string" }, "ScanGroupId": { "format": "uuid", "description": "A Scan Group unique identifier", "type": "string" }, "CustomConfiguration": { "$ref": "#/definitions/WebScanCustomConfigurationViewModel" }, "ScheduleId": { "format": "uuid", "description": "Web Scan schedule unique identifier", "type": "string" }, "Recording": { "$ref": "#/definitions/WebScanRecordingUploadViewModel" }, "MessageNotification": { "description": "A Web Scan message notification", "type": "array", "items": { "$ref": "#/definitions/MessageNotificationViewModel" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "UserAccountSecurityStances": { "description": "Defines security stance for user account", "enum": [ "DenyAll", "AllowAll" ], "type": "string" }, "UserDetailsViewModel": { "type": "object", "properties": { "AccessRights": { "description": "A list of access rights to which user is assigned", "type": "array", "items": { "$ref": "#/definitions/UserGroupViewModel" } }, "AuthenticationMode": { "$ref": "#/definitions/AuthenticationMode" }, "RequireTwoFactorAutheticationFromAnyCompany": { "description": "A flag that indicates if user needs to be verifed against two factor authentication because some organization require it", "type": "boolean" }, "Email": { "description": "An user email address", "type": "string" }, "FirstName": { "description": "Name of the user", "type": "string" }, "Id": { "format": "uuid", "description": "A unique user identifier", "type": "string" }, "IsConsultant": { "description": "Value that indicates if the user is a consultant", "type": "boolean" }, "LanguageCode": { "$ref": "#/definitions/LocalizationEnum" }, "LastName": { "description": "An user last name", "type": "string" }, "NotificationPeriod": { "$ref": "#/definitions/NotificationPeriod" }, "Phone": { "description": "An user phone number", "type": "string" }, "TimeZone": { "description": "An user time zone", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "UserFilterViewModel": { "description": "Filter view model class for user list view.", "type": "object", "properties": { "UserGroupId": { "format": "uuid", "description": "An user group unique identifier", "type": "string" }, "Locked": { "description": "Flag that indicates whether the user group can be edited", "type": "boolean" }, "UserName": { "description": "User name", "type": "string" }, "Email": { "description": "User email address", "type": "string" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "UserGroupViewModel": { "type": "object", "properties": { "Description": { "description": "An user group description", "type": "string" }, "GroupSID": { "description": "An user group SID", "type": "string" }, "Name": { "description": "An user group name", "type": "string" }, "Locked": { "description": "Flag indicating if user group can be edited", "type": "boolean" }, "RoleNames": { "description": "A role with name list", "type": "array", "items": { "$ref": "#/definitions/RoleNameViewModel" } }, "UserGroupId": { "format": "uuid", "description": "A unique identifier of the user group", "type": "string" }, "Users": { "description": "A number of users assigned to user group", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } } }, "additionalProperties": false }, "UserGroupsListViewModel": { "type": "object", "properties": { "Name": { "description": "An user group name", "type": "string" }, "NumberOfUsers": { "format": "int32", "description": "A number of users assigned to the user group", "type": "integer" }, "UserGroupId": { "format": "uuid", "description": "A unique identifier of the user group", "type": "string" }, "Locked": { "description": "Flag indicating if user group can be edited", "type": "boolean" } }, "additionalProperties": false }, "UserListViewModel": { "type": "object", "properties": { "Email": { "description": "An user email address", "type": "string" }, "FirstName": { "description": "Name of the user", "type": "string" }, "Id": { "format": "uuid", "description": "Id of the user", "type": "string" }, "IsActive": { "description": "A value indicating whether the user account is active", "type": "boolean" }, "IsConsultant": { "description": "Value that indicates if the user is a consultant", "type": "boolean" }, "LastName": { "description": "An user last name", "type": "string" }, "UserGroups": { "description": "A list of user groups that a user is a member", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } } }, "additionalProperties": false }, "UserViewModel": { "description": "Represents a user.", "type": "object", "properties": { "AddressId": { "format": "uuid", "description": "A unique identifier referring to the address", "type": "string" }, "Comment": { "description": "A comment. Max length 255 characters", "type": "string" }, "CreatedBy": { "format": "uuid", "description": "A unique identifier referring to the user that created the item", "type": "string" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "DefaultGroup": { "format": "uuid", "description": "An unique identifier referring to the default user group", "type": "string" }, "Email": { "description": "An email address. Max 255 characters", "type": "string" }, "Forename": { "description": "An user forename", "type": "string" }, "IsActive": { "description": "A flag that indicates that the user is active", "type": "boolean" }, "IsConsultant": { "description": "A flag that indicates that the user is consultant", "type": "boolean" }, "ModifiedBy": { "format": "uuid", "description": "A unique identifier referring to the user who modified the user entry last time", "type": "string" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Name": { "description": "A name of user. Max length 255 characters", "type": "string" }, "Phone": { "description": "User's phone number. Max length 50 characters", "type": "string" }, "OAuthUUID": { "description": "User's OneId UUID", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "VulnReferenceTypeEnum": { "enum": [ "CVE", "BUGTRAQ", "EXPLOIT", "CUSTOM" ], "type": "string" }, "VulnRiskLevels": { "enum": [ "Information", "Low", "Medium", "High", "Critical" ], "type": "string" }, "VulnTypes": { "description": "RiskGroupID = Security_Hole AND TrustLevel GREATER THAN 50) THEN Certain\nRiskGroupID = Security_Hole AND TrustLevel LESS or EQUAL THAN 50) THEN Potential\nRiskGroupID = Information) THEN Informational", "enum": [ "Certain", "Potential", "Informational" ], "type": "string" }, "VulnerabilitiesAndFindingsAggregatedDetailedViewModel": { "type": "object", "properties": { "Synopsis": { "description": "A synopsis", "type": "string" }, "Description": { "description": "A description", "type": "string" }, "Solution": { "description": "A solution", "type": "string" }, "Findings": { "description": "Findings", "type": "string" }, "Tags": { "description": "A list with tags", "type": "array", "items": { "$ref": "#/definitions/TagViewModel" } }, "CVSSVector": { "description": "CVSS vector", "type": "string" }, "CVSSV3Vector": { "description": "A vulnerability CVSS v3 vector", "type": "string" }, "DenialOfService": { "description": "A flag that indicates denial of service", "type": "boolean" }, "BugTraqReferences": { "description": "A list of BugTraq references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "CVEReferences": { "description": "A list of CVE references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "ExploitReferences": { "description": "A Exploit references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "PluginIds": { "description": "A list of unique identifiers for plug-ins", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "IsExploitable": { "description": "Is vulnerability exploitable", "type": "boolean" }, "TagTechnicalName": { "type": "string" }, "RiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "CVSSBaseScore": { "format": "double", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "type": "number" }, "Title": { "type": "string" }, "FindingsCount": { "format": "int32", "type": "integer" } }, "additionalProperties": false }, "VulnerabilitiesAndFindingsDetailedReferenceViewModel": { "description": "Represents vulnerabilities and findings detailed reference.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "Name": { "description": "A name", "type": "string" }, "Url": { "description": "A URL", "type": "string" }, "Type": { "description": "Vulnerability reference type", "type": "string" } }, "additionalProperties": false }, "VulnerabilitiesAndFindingsDetailedViewModel": { "type": "object", "properties": { "LastAuditorNote": { "description": "A last auditor note", "type": "string" }, "Synopsis": { "description": "A synopsis", "type": "string" }, "Description": { "description": "A description", "type": "string" }, "Solution": { "description": "A solution", "type": "string" }, "Findings": { "description": "Findings", "type": "string" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" }, "Port": { "format": "int32", "description": "A port", "type": "integer" }, "Tags": { "description": "List of tags", "type": "array", "items": { "$ref": "#/definitions/TagViewModel" } }, "CVSSVector": { "description": "A CVSS vector", "type": "string" }, "CVSSV3Vector": { "description": "A vulnerability CVSS v3 vector", "type": "string" }, "DenialOfService": { "description": "A flag that indicates if it is denial of service", "type": "boolean" }, "IsExploitable": { "description": "A flag that indicates if the vulnerability has a known exploit", "type": "boolean" }, "VulnerabilityCategory": { "description": "A vulnerability family", "type": "string" }, "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "BugTraqReferences": { "description": "A list of BUGTRAQ references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "CVEReferences": { "description": "A list of CVE references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "ExploitReferences": { "description": "A list of Exploit references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "OtherReferences": { "description": "A list of other references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "IdentifierId": { "description": "Unique identifier of vulnerability instance occurrence within target", "type": "string" }, "Id": { "format": "uuid", "type": "string" }, "PluginId": { "format": "int32", "description": "A plug-in unique identifier", "type": "integer" }, "PluginGuidId": { "format": "uuid", "description": "A plugin identifier", "type": "string" }, "RiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "CVSSBaseScore": { "format": "double", "description": "A CVSS base score", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "A vulnerability CVSS v3 base score", "type": "number" }, "Potential": { "description": "A flag that indicates whether the vulnerability is potential", "type": "boolean" }, "State": { "$ref": "#/definitions/SSVulnState" }, "Status": { "$ref": "#/definitions/VulnerabilityStatusViewModelShort" }, "Title": { "description": "A title (display name)", "type": "string" }, "TagCollection": { "description": "A list of collections", "type": "array", "items": { "$ref": "#/definitions/ITagView" } }, "ManualId": { "format": "uuid", "description": "A manual identifier", "type": "string" }, "IsTicketAssigned": { "description": "Flag indicates that vulnerability instance is assigned to ticket", "type": "boolean" }, "FirstSeenOn": { "format": "date-time", "description": "Date when vulnerability instance was seen for first time", "type": "string" }, "LastSeenOn": { "format": "date-time", "description": "Date of vulnerability last occurance in scan report", "type": "string" } }, "additionalProperties": false }, "VulnerabilitiesAndFindingsFilterModel": { "description": "Vulnerability and findings filter model.", "type": "object", "properties": { "Findings": { "$ref": "#/definitions/StateVulnerabilitiesAndFindingsFilterModelEnum" }, "VulnerabilityStatusIds": { "description": "A list of unique identifiers for vulnerability statuses", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ShowAllStatuses": { "description": "A flag that indicates whether to show vulnerabilities with all statuses", "type": "boolean" }, "ShowAllOpenStatuses": { "description": "A flag that indicates whether to show vulnerabilities with open statuses", "type": "boolean" }, "ExcludePotentialFindings": { "description": "A flag that indicates whether to exclude potential findings in results", "type": "boolean" }, "IgnoreTagFilter": { "description": "A flag that indicates whether to ignore tag filter", "type": "boolean" }, "Severities": { "description": "A list of severities", "type": "array", "items": { "$ref": "#/definitions/VulnRiskLevels" } }, "ShowAllSeverities": { "type": "boolean" }, "ShowOnlyWithTags": { "description": "A list of tags to filter results", "type": "array", "items": { "type": "string" } }, "IsExploitable": { "type": "boolean" }, "ShowSeenDates": { "description": "A flag indicates that last seen (occurs in incomming report) vulnerability instance date is present in result set", "type": "boolean" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "VulnerabilitiesAndFindingsHistoryViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability history unique identifier", "type": "string" }, "CreatedBy": { "format": "uuid", "description": "A unique identifier referring to the user that created the item", "type": "string" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "VulnScanDetailId": { "format": "uuid", "description": "A vulnerability instance unique identifier", "type": "string" }, "StatusId": { "format": "uuid", "description": "A vulnerability status unique identifier", "type": "string" } }, "additionalProperties": false }, "VulnerabilitiesAndFindingsUpdateStatusViewModel": { "description": "A list of categories and vulnerability instances to be changed ordered by status and notes.", "type": "object", "properties": { "CategoryIds": { "description": "A Web Scan category", "type": "array", "items": { "format": "uuid", "type": "string" } }, "Ids": { "description": "A vulnerability instance", "type": "array", "items": { "format": "uuid", "type": "string" } }, "Potential": { "description": "If a vulnerability instance is potential (option only for System Scan)", "type": "boolean" }, "Status": { "format": "uuid", "description": "Status unique identifier", "type": "string" }, "AuditorNote": { "description": "Note for a vulnerability instance", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilitiesAndFindingsViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "type": "string" }, "PluginId": { "format": "int32", "description": "A plug-in unique identifier", "type": "integer" }, "PluginGuidId": { "format": "uuid", "description": "A plugin identifier", "type": "string" }, "RiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "CVSSBaseScore": { "format": "double", "description": "A CVSS base score", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "A vulnerability CVSS v3 base score", "type": "number" }, "Potential": { "description": "A flag that indicates whether the vulnerability is potential", "type": "boolean" }, "State": { "$ref": "#/definitions/SSVulnState" }, "Status": { "$ref": "#/definitions/VulnerabilityStatusViewModelShort" }, "Title": { "description": "A title (display name)", "type": "string" }, "TagCollection": { "description": "A list of collections", "type": "array", "items": { "$ref": "#/definitions/ITagView" } }, "ManualId": { "format": "uuid", "description": "A manual identifier", "type": "string" }, "IsExploitable": { "description": "Flag indicates whether a vulnerability is exploitable", "type": "boolean" }, "IsTicketAssigned": { "description": "Flag indicates that vulnerability instance is assigned to ticket", "type": "boolean" }, "FirstSeenOn": { "format": "date-time", "description": "Date when vulnerability instance was seen for first time", "type": "string" }, "LastSeenOn": { "format": "date-time", "description": "Date of vulnerability last occurance in scan report", "type": "string" }, "IdentifierId": { "description": "Unique identifier of vulnerability instance occurrence within target", "type": "string" } }, "additionalProperties": false }, "VulnerabilitiesChangesViewModel": { "description": "Represents a view model of a vulnerability changes.", "type": "object", "properties": { "LastUpdated": { "format": "date-time", "description": "Date and time of last generation of statistics", "type": "string" }, "VulnerabilitiesChanges": { "description": "Vulnerability changes grouped by severity", "type": "array", "items": { "$ref": "#/definitions/NumberOfVulnerabilitiesChangesViewModel" } } }, "additionalProperties": false }, "VulnerabilitiesCoverageListViewModel": { "description": "A list of vulnerabilities coverage.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "Name": { "description": "Vulnerability name", "type": "string" }, "Type": { "$ref": "#/definitions/ScanType" }, "PluginId": { "format": "int32", "description": "ID of a plug-in that discovers this vulnerability", "type": "integer" }, "CVSSBaseScore": { "format": "double", "description": "Severity score", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "Severity score CVSS v3", "type": "number" }, "RiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "IsExploitable": { "description": "Is there a public exploit for the vulnerability", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilitiesDetailsListUpdateStatusesViewModel": { "type": "object", "properties": { "VulnerabilityAffectedHostsIds": { "description": "A list of the unique identifiers for the vulnerability's affected hosts", "type": "array", "items": { "format": "uuid", "type": "string" } }, "StatusId": { "format": "uuid", "description": "A vulnerability status unique identifier", "type": "string" }, "AuditorNote": { "description": "An auditor note", "type": "string" }, "Potential": { "description": "A flag that indicates if the vulnerability is potential", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilitiesInstancesViewModel": { "description": "Model to perform actions on vulnerabilities instances.", "type": "object", "properties": { "VulnerabilityInstanceIds": { "description": "A list of vulnerability instances unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "VulnerabilityIds": { "description": "A list of vulnerability unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "WebScanVulnerabilitiesSearchKeyViewModel": { "description": "A list of search keys for vulnerability instances", "type": "array", "items": { "$ref": "#/definitions/WebScanVulnerabilitiesSearchKeyViewModel" } }, "WSVulnerabilityInstanceIds": { "description": "A list of unique identifiers for Web Scan vulnerability instances", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TicketVulnerabilitiesOnSiteFilter": { "$ref": "#/definitions/VulnerabilitiesOnSiteFilter" }, "TicketVulnerabilitiesOnHostFilter": { "$ref": "#/definitions/VulnerabilitiesOnHostFilter" } }, "additionalProperties": false }, "VulnerabilitiesListSystemScanDetailsViewModel": { "description": "Vulnerability details of a System Scan.", "type": "object", "properties": { "BugTraqReferences": { "description": "A BugTraq references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "CVEReferences": { "description": "A CVE references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "ExploitReferences": { "description": "A Exploit references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "OtherReferences": { "description": "An other references", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "DenialOfService": { "description": "A flag that indicates if the vulnerability causes denial of service", "type": "boolean" }, "IsExploitable": { "description": "A flag that indicates if the vulnerability has a known exploit", "type": "boolean" }, "PluginLastModified": { "format": "date-time", "description": "Date when the plug-in discovering this page was last discovered", "type": "string" }, "VulnerabilityCategory": { "description": "A vulnerability family", "type": "string" }, "ReleaseDate": { "format": "date-time", "description": "Plugin release date.\nRelease date means: a date when plugin was released to production via update system", "type": "string" }, "Tickets": { "description": "A list of tickets that contain the vulnerability", "type": "array", "items": { "$ref": "#/definitions/SimpleTicketViewModel" }, "readOnly": true }, "AffectedAssetsViemModel": { "type": "array", "items": { "$ref": "#/definitions/AffectedAssetViewModel" } }, "VulnerabilityLastFound": { "format": "date-time", "description": "Date when the vulnerability was last found", "type": "string" }, "Synopsis": { "description": "Vulnerability synopsis", "type": "string" }, "Description": { "description": "Vulnerability description", "type": "string" }, "Solution": { "description": "Vulnerability solution", "type": "string" }, "Tags": { "description": "Vulnerability tags", "type": "array", "items": { "$ref": "#/definitions/TagViewModel" } }, "CVSSVector": { "description": "Severity vector", "type": "string" }, "CVSSV3Vector": { "description": "Severity vector CVSS v3", "type": "string" }, "Id": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "Name": { "description": "Vulnerability name", "type": "string" }, "Type": { "$ref": "#/definitions/ScanType" }, "PluginId": { "format": "int32", "description": "ID of a plug-in that discovers this vulnerability", "type": "integer" }, "ManualId": { "format": "uuid", "description": "Id when vulnerability was manually added", "type": "string" }, "CVSSBaseScore": { "format": "double", "description": "Severity score", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "Severity score. CVSS v3", "type": "number" }, "RiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "AffectedAssets": { "format": "int32", "description": "How many assets are affected", "type": "integer" }, "AffectedTargets": { "format": "int32", "description": "How many targets are affected", "type": "integer" }, "ReferenceId": { "description": "Vulnerability category reference unique identifier. Used in Web Scans", "type": "string" }, "Variant": { "description": "A class variant of Web Scan vulnerability scan details", "type": "string" }, "TicketAssigned": { "description": "A flag indicate that the vulnerability is handled in one or more tickets", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilitiesListUpdateStatusesViewModel": { "type": "object", "properties": { "Filter": { "$ref": "#/definitions/VulnerabilityFilterViewModel" }, "WebScanVulnerabilities": { "description": "A Web Scan complex category object contains plug-in number, manual ID, variant, and vulnerability ID to change the status of vulnerability instances", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesListWebScanCategoriesViewModel" } }, "SystemScanVulnerabilityIds": { "description": "System Scan category unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "Potential": { "description": "A vulnerability instance potential flag (option only for System Scan)", "type": "boolean" }, "StatusId": { "format": "uuid", "description": "A vulnerability instance status unique identifier", "type": "string" }, "AuditorNote": { "description": "A vulnerability instance auditor note", "type": "string" } }, "additionalProperties": false }, "VulnerabilitiesListUpdatedViewModel": { "type": "object", "properties": { "WebScanVulnerabilityInstanceIds": { "description": "A list of wev scan vulnerability instance unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "SystemScanVulnerabilityInstanceIds": { "description": "A list of System Scan vulnerability instance unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilitiesListViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "Name": { "description": "Vulnerability name", "type": "string" }, "Type": { "$ref": "#/definitions/ScanType" }, "PluginId": { "format": "int32", "description": "ID of a plug-in that discovers this vulnerability", "type": "integer" }, "ManualId": { "format": "uuid", "description": "Id when vulnerability was manually added", "type": "string" }, "CVSSBaseScore": { "format": "double", "description": "Severity score", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "Severity score. CVSS v3", "type": "number" }, "RiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "AffectedAssets": { "format": "int32", "description": "How many assets are affected", "type": "integer" }, "AffectedTargets": { "format": "int32", "description": "How many targets are affected", "type": "integer" }, "ReferenceId": { "description": "Vulnerability category reference unique identifier. Used in Web Scans", "type": "string" }, "Variant": { "description": "A class variant of Web Scan vulnerability scan details", "type": "string" }, "IsExploitable": { "description": "Is there a public exploit for the vulnerability", "type": "boolean" }, "TicketAssigned": { "description": "A flag indicate that the vulnerability is handled in one or more tickets", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilitiesListWebScanCategoriesViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "PluginId": { "format": "int32", "description": "ID of a plug-in that discovers this vulnerability", "type": "integer" }, "ManualId": { "format": "uuid", "description": "Id when vulnerability was manually added", "type": "string" }, "Variant": { "description": "Vulnerability class variant. Used in Web Scans", "type": "string" } }, "additionalProperties": false }, "VulnerabilitiesListWebScanDetailsViewModel": { "description": "Details for the Web Scan vulnerability.", "type": "object", "properties": { "ThreatType": { "$ref": "#/definitions/ThreatTypes" }, "CategoryReferenceUrl": { "description": "External URL describing the vulnerability category", "type": "string", "readOnly": true }, "VulnerabilityReferences": { "description": "References related to vulnerability provided by OWASP", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "Tickets": { "description": "A list of tickets that contain the vulnerability", "type": "array", "items": { "$ref": "#/definitions/SimpleTicketViewModel" }, "readOnly": true }, "VulnerabilityLastFound": { "format": "date-time", "description": "Date when the vulnerability was last found", "type": "string" }, "Synopsis": { "description": "Vulnerability synopsis", "type": "string" }, "Description": { "description": "Vulnerability description", "type": "string" }, "Solution": { "description": "Vulnerability solution", "type": "string" }, "Tags": { "description": "Vulnerability tags", "type": "array", "items": { "$ref": "#/definitions/TagViewModel" } }, "CVSSVector": { "description": "Severity vector", "type": "string" }, "CVSSV3Vector": { "description": "Severity vector CVSS v3", "type": "string" }, "Id": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "Name": { "description": "Vulnerability name", "type": "string" }, "Type": { "$ref": "#/definitions/ScanType" }, "PluginId": { "format": "int32", "description": "ID of a plug-in that discovers this vulnerability", "type": "integer" }, "ManualId": { "format": "uuid", "description": "Id when vulnerability was manually added", "type": "string" }, "CVSSBaseScore": { "format": "double", "description": "Severity score", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "Severity score. CVSS v3", "type": "number" }, "RiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "AffectedAssets": { "format": "int32", "description": "How many assets are affected", "type": "integer" }, "AffectedTargets": { "format": "int32", "description": "How many targets are affected", "type": "integer" }, "ReferenceId": { "description": "Vulnerability category reference unique identifier. Used in Web Scans", "type": "string" }, "Variant": { "description": "A class variant of Web Scan vulnerability scan details", "type": "string" }, "IsExploitable": { "description": "Is there a public exploit for the vulnerability", "type": "boolean" }, "TicketAssigned": { "description": "A flag indicate that the vulnerability is handled in one or more tickets", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilitiesOnHostFilter": { "type": "object", "properties": { "VulnerabilityIds": { "description": "A list of unique identifiers for vulnerabilities. If specified, only hosts on which this vulnerabiliy occurs are returned", "type": "array", "items": { "format": "uuid", "type": "string" } }, "OnlyOpenVulnerabilityInstances": { "description": "A flag indicating that results have to contain only vulnerabilities of open status group", "type": "boolean" }, "ReportId": { "format": "uuid", "description": "A report unique identifier", "type": "string" }, "TicketId": { "format": "uuid", "description": "A ticket unique identifier", "type": "string" }, "VulnerabilityStatusIds": { "description": "A list of unique identifiers for vulnerability statuses", "type": "array", "items": { "format": "uuid", "type": "string" } }, "VulnerabilityInstanceIds": { "description": "A list of unique identifiers of vulnerability instances", "type": "array", "items": { "format": "uuid", "type": "string" } }, "VulnerabilityListFilter": { "$ref": "#/definitions/VulnerabilityFilterViewModel" }, "ScanIds": { "description": "A list of unique identifiers for scans", "type": "array", "items": { "format": "uuid", "type": "string" } }, "IncludeTotalNumberOfVulnerabilityInstancesPerVulnerability": { "description": "Should the total number of vulnerability instances per vulnerability be calculated", "type": "boolean" }, "ScanGroups": { "description": "Filters results by a list of scan groups", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "Hosts": { "description": "Filters results by a list of hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "Ports": { "description": "Filters results by a list of ports", "type": "string" }, "HideVulnerabilitesAllreadyInAnyTicket": { "description": "A flag indicating if returned vulnerability instances are already connected to any ticket", "type": "boolean" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "VulnerabilitiesOnSiteFilter": { "type": "object", "properties": { "WebScanVulnerabilitiesSearchKeyViewModel": { "type": "array", "items": { "$ref": "#/definitions/WebScanVulnerabilitiesSearchKeyViewModel" } }, "TicketId": { "format": "uuid", "description": "A ticket unique identifier", "type": "string" }, "OnlyOpenVulnerabilityInstances": { "description": "A flag that indicates that result have to contain only vulnerabilities of open status group", "type": "boolean" }, "ReportId": { "format": "uuid", "description": "A report unique identifier", "type": "string" }, "VulnerabilityInstanceIds": { "description": "A list of vulnerability instances unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "VulnerabilityListFilter": { "$ref": "#/definitions/VulnerabilityFilterViewModel" }, "VulnerabilityStatusIds": { "description": "A list of vulnerability status unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ScanIds": { "description": "A list of scan unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ScanGroups": { "description": "Filters results by a list of Scan Groups", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "Categories": { "description": "Filters results by a list of vulnerability categories", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "HideVulnsAlleradyInAnyTicket": { "description": "A flag that indicates if return vulnerabiltiy instances that are allready connected to any ticket", "type": "boolean" }, "Hosts": { "description": "Filters results by a list of hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "VulnerabilitiesStatusChangeViewModel": { "type": "object", "properties": { "AuditorNote": { "description": "An auditor note", "type": "string" }, "NewStatusId": { "format": "uuid", "description": "A unique identifier of the new vulnerability status", "type": "string" }, "VulnerabilityInstanceIds": { "description": "A list of vulnerability instances unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "VulnerabilityIds": { "description": "A list of vulnerability unique identifiers", "type": "array", "items": { "format": "uuid", "type": "string" } }, "WebScanVulnerabilitiesSearchKeyViewModel": { "description": "A list of search keys for vulnerability instances", "type": "array", "items": { "$ref": "#/definitions/WebScanVulnerabilitiesSearchKeyViewModel" } }, "WSVulnerabilityInstanceIds": { "description": "A list of unique identifiers for Web Scan vulnerability instances", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TicketVulnerabilitiesOnSiteFilter": { "$ref": "#/definitions/VulnerabilitiesOnSiteFilter" }, "TicketVulnerabilitiesOnHostFilter": { "$ref": "#/definitions/VulnerabilitiesOnHostFilter" } }, "additionalProperties": false }, "VulnerabilityAffectedAssetsViewModel": { "description": "Base model for showing ungrouped affected assets.", "type": "object", "properties": { "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "Target": { "description": "Scan definition name", "type": "string" }, "Host": { "description": "Scan definition IP or host name", "type": "string", "readOnly": true }, "OperatingSystem": { "description": "Operating system discovered during the last scan", "type": "string", "readOnly": true }, "Findings": { "description": "Vulnerability instance findings", "type": "string" }, "AdGroup": { "description": "Active Directory group name", "type": "string" }, "LastSeen": { "format": "date-time", "description": "Date and time when an asset was last seen", "type": "string" }, "RiskScore": { "format": "double", "description": "Asset risk score", "type": "number" }, "Importance": { "format": "int32", "description": "Asset importance for risk score", "type": "integer" }, "NumberOfPublicExploits": { "format": "int32", "description": "Number of publicly available exploits", "type": "integer" }, "Archived": { "description": "Determines whether an asset has been marked as archived", "type": "boolean" }, "InternetExposure": { "description": "Determines whether an asset is exposed to the Internet", "type": "boolean" }, "ManualInternetExposure": { "description": "Manual internet exposure", "type": "boolean" }, "OnPublicInternet": { "description": "Public on internet", "type": "boolean" }, "AssetId": { "format": "uuid", "description": "Asset unique identifier", "type": "string" }, "IpAddress": { "description": "IP Address", "type": "string" }, "VulnerabilityScanDetailId": { "format": "uuid", "description": "Vulnerability instance unique identifier", "type": "string" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" }, "Port": { "format": "int32", "description": "On which port the vulnerability has been found", "type": "integer", "readOnly": true }, "Status": { "$ref": "#/definitions/VulnerabilityStatusViewModelShort" }, "Potential": { "description": "Is vulnerability instance marked as potential", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilityAffectedHostsGroupedViewModel": { "description": "Model for showing grouped affected hosts.", "type": "object", "properties": { "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "Target": { "description": "Scan definition name", "type": "string" }, "Host": { "description": "Scan definition IP or host name", "type": "string", "readOnly": true }, "OperatingSystem": { "description": "Operating system discovered during the last scan", "type": "string", "readOnly": true }, "ScanGroup": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Instances": { "description": "Vulnerability instance data", "type": "array", "items": { "$ref": "#/definitions/VulnerabilityAffectedHostsViewModelBase" } } }, "additionalProperties": false }, "VulnerabilityAffectedHostsViewModel": { "description": "Base model for showing ungrouped affected hosts.", "type": "object", "properties": { "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "ScanGroup": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Target": { "description": "Scan definition name", "type": "string" }, "Host": { "description": "Scan definition IP or host name", "type": "string", "readOnly": true }, "OperatingSystem": { "description": "Operating system discovered during the last scan", "type": "string", "readOnly": true }, "Findings": { "description": "Vulnerability instance findings", "type": "string" }, "VulnerabilityScanDetailId": { "format": "uuid", "description": "Vulnerability instance unique identifier", "type": "string" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" }, "Port": { "format": "int32", "description": "On which port the vulnerability has been found", "type": "integer", "readOnly": true }, "Status": { "$ref": "#/definitions/VulnerabilityStatusViewModelShort" }, "Potential": { "description": "Is vulnerability instance marked as potential", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilityAffectedHostsViewModelBase": { "description": "Base model for showing affected hosts (list and group).", "type": "object", "properties": { "VulnerabilityScanDetailId": { "format": "uuid", "description": "Vulnerability instance unique identifier", "type": "string" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" }, "Port": { "format": "int32", "description": "On which port the vulnerability has been found", "type": "integer", "readOnly": true }, "Status": { "$ref": "#/definitions/VulnerabilityStatusViewModelShort" }, "Potential": { "description": "Is vulnerability instance marked as potential", "type": "boolean" }, "Findings": { "description": "Vulnerability instance findings", "type": "string" } }, "additionalProperties": false }, "VulnerabilityAffectedSitesGroupedViewModel": { "description": "Model for showing grouped affected hosts.", "type": "object", "properties": { "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "Target": { "description": "Scan definition name", "type": "string" }, "TargetSite": { "description": "Target site of an attack", "type": "string", "readOnly": true }, "ScanGroup": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Findings": { "description": "Vulnerability instance findings", "type": "string" }, "Instances": { "description": "Vulnerability instance data", "type": "array", "items": { "$ref": "#/definitions/VulnerabilityAffectedSitesViewModelBase" } } }, "additionalProperties": false }, "VulnerabilityAffectedSitesViewModel": { "description": "Represents base model for showing ungrouped affected sites.", "type": "object", "properties": { "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "ScanGroup": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Target": { "description": "A scan definition name", "type": "string" }, "TargetSite": { "description": "A scan target site", "type": "string" }, "AttackParameter": { "description": "A parameter of the attack", "type": "string" }, "AttackMethod": { "description": "A method of attack", "type": "string" }, "VulnerabilityScanDetailId": { "format": "uuid", "description": "A vulnerability instance unique identifier", "type": "string" }, "Status": { "$ref": "#/definitions/VulnerabilityStatusViewModelShort" }, "VulnerabilityInstanceBaseUrl": { "description": "A base URL of attacked site", "type": "string", "readOnly": true }, "VulnerabilityCategoryId": { "format": "uuid", "description": "A vulnerabilitiy category unique identifier", "type": "string" }, "ReferenceId": { "description": "A Web Scan category reference identifier", "type": "string" } }, "additionalProperties": false }, "VulnerabilityAffectedSitesViewModelBase": { "description": "Represents Base model for showing affected sites (list and group).", "type": "object", "properties": { "AttackParameter": { "description": "A parameter of the attack", "type": "string" }, "AttackMethod": { "description": "A method of attack", "type": "string" }, "VulnerabilityScanDetailId": { "format": "uuid", "description": "A vulnerability instance unique identifier", "type": "string" }, "Status": { "$ref": "#/definitions/VulnerabilityStatusViewModelShort" }, "VulnerabilityInstanceBaseUrl": { "description": "A base URL of attacked site", "type": "string", "readOnly": true }, "VulnerabilityCategoryId": { "format": "uuid", "description": "A vulnerabilitiy category unique identifier", "type": "string" }, "ReferenceId": { "description": "A Web Scan category reference identifier", "type": "string" } }, "additionalProperties": false }, "VulnerabilityBasicFieldEnum": { "description": "Type of vulnerability fields on which filter can be set.", "enum": [ "Name", "PluginId", "Reference" ], "type": "string" }, "VulnerabilityCategoryViewModel": { "description": "A vulnerability category.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "Unique identifier for a vulnerability category", "type": "string" }, "CategoryReferences": { "description": "Reference category", "type": "string" }, "CreatedBy": { "format": "uuid", "description": "A unique identifier referring to the user that created the item", "type": "string" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "CWEList": { "description": "A CWE list", "type": "string" }, "Description": { "description": "A description", "type": "string" }, "ModifiedBy": { "format": "uuid", "description": "A unique identifier referring to the user who modified the user entry last time", "type": "string" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Name": { "description": "Vulnerability category name (max 2000 characters)", "maxLength": 2000, "type": "string" }, "ReferenceID": { "description": "Reference identifier", "maxLength": 20, "type": "string" }, "ReferenceType": { "description": "Reference type (max 20 characters)", "maxLength": 20, "type": "string" }, "ReferenceUrl": { "description": "Reference URL (max 500 characters)", "maxLength": 500, "type": "string" }, "ScanType": { "format": "int32", "description": "A scan type", "type": "integer" }, "ShortDescription": { "description": "Short description of a vulnerability category ", "type": "string" }, "ShortName": { "description": "Short name (max 256 characters)", "maxLength": 256, "type": "string" }, "ThreatType": { "format": "int32", "description": "Threat type", "type": "integer" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilityCoverageFilterViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "Vulnerability ID", "type": "string" }, "Ids": { "description": "Vulnerability ID", "type": "array", "items": { "format": "uuid", "type": "string" } }, "SeverityFrom": { "format": "double", "description": "Severity score from", "type": "number" }, "SeverityTo": { "format": "double", "description": "Severity score to", "type": "number" }, "VulnerabilityTagsOneOf": { "description": "Tags included in vulnerability. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "VulnerabilityTagsAllOf": { "description": "Tags included in vulnerability. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "IncludeInformationRiskLevel": { "description": "Include informational vulnerabilities. False ignores the setting", "type": "boolean" }, "IncludeLowRiskLevel": { "description": "Include low-severity vulnerabilities. False ignores the setting", "type": "boolean" }, "IncludeMediumRiskLevel": { "description": "Include medium-severity vulnerabilities. False ignores the setting", "type": "boolean" }, "IncludeHighRiskLevel": { "description": "Include high-severity vulnerabilities. False ignores the setting", "type": "boolean" }, "IncludeCriticalRiskLevel": { "description": "Include high-severity vulnerabilities. False ignores the setting", "type": "boolean" }, "ExcludePotential": { "description": "Exclude potential vulnerabilities", "type": "boolean" }, "VulnerabilityBasicFields": { "description": "Basic vulnerability fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[VulnerabilityBasicFieldEnum]" } }, "IsExploitable": { "description": "Is there a public exploit for the vulnerability", "type": "boolean" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "VulnerabilityCoverageSimpleViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "Name": { "description": "A vulnerability name", "type": "string" }, "PluginId": { "format": "int32", "description": "A plugin identifier", "type": "integer" }, "CVSSBaseScore": { "format": "double", "description": "A vulnerability CVSS base score", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "A vulnerability CVSS v3 base score", "type": "number" } }, "additionalProperties": false }, "VulnerabilityDetailsGroupedViewModel": { "type": "object", "properties": { "PotentialCount": { "format": "int32", "description": "A counter of potential vulnerabilities", "type": "integer" }, "InformationalCount": { "format": "int32", "description": "A counter of informational vulnerabilities", "type": "integer" }, "VulnerabilitiesCount": { "format": "int32", "description": "A counter of vulnerabilities", "type": "integer" }, "VulnerabilitiesAndFindingsCount": { "format": "int32", "description": "A counter of vulnerabilities and findings", "type": "integer" }, "VulnerabilitiesAndFindingsUnconsideredCount": { "format": "int32", "description": "A counter of vulnerabilities and findings unconsidered in counters", "type": "integer" }, "MostSevereCount": { "format": "int32", "description": "A counter of the most severe vulnerabilities", "type": "integer" }, "NewCount": { "format": "int32", "description": "A counter of new vulnerabilities", "type": "integer" }, "FixedCount": { "format": "int32", "description": "A counter of fixed vulnerabilities", "type": "integer" }, "MostSevere": { "description": "A list of the most severe vulnerabilities", "type": "array", "items": { "$ref": "#/definitions/SystemScanReportTopViewModel" } }, "New": { "description": "A list of new vulnerabilities", "type": "array", "items": { "$ref": "#/definitions/SystemScanReportTopViewModel" } }, "Fixed": { "description": "A list of most fixed vulnerabilities", "type": "array", "items": { "$ref": "#/definitions/SystemScanReportTopViewModel" } }, "ScanReportCvssVersion": { "$ref": "#/definitions/CVSSVersion" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilityFilterViewModel": { "type": "object", "properties": { "WebScanVulnerabilityCategoryIds": { "description": "Web Scan vulnerability categories", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "ScanGroupIds": { "description": "IDs of scan groups to search for affected hosts", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "VulnerabilityStatusIds": { "description": "Vulnerability status IDs", "type": "array", "items": { "format": "uuid", "type": "string" } }, "TargetRelatedBasicFields": { "description": "Basic target fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[TargetRelatedBasicFieldEnum]" } }, "Scanned": { "$ref": "#/definitions/ScannedWhenModeEnum" }, "ScannedNumber": { "format": "int32", "description": "Number of units when checking the time of scan", "type": "integer" }, "ScannedWhenUnit": { "$ref": "#/definitions/ScannedWhenUnitEnum" }, "ScanTagsOneOf": { "description": "Tags included in scan. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "ScanTagsAllOf": { "description": "Tags included in scan. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "IncludeOnlyWithTickets": { "description": "Include vulnerabilities with assigned tickets", "type": "boolean" }, "IncludeOnlyWithoutTickets": { "description": "Include vulnerabilities without assigned tickets", "type": "boolean" }, "IncludeSystemScan": { "description": "Include System Scan vulnerabilities. False ignores the setting", "type": "boolean" }, "IncludeWebScan": { "description": "Include Web Scan vulnerabilities. False ignores the setting", "type": "boolean" }, "IncludeEndpointAgentScan": { "description": "Include Endpoint Agent Scan vulnerabilities. False ignores the setting", "type": "boolean" }, "IsExploitable": { "description": "Include only exploitable vulnerabilities. False ignores the setting", "type": "boolean" }, "VulnerabilityInstanceIds": { "description": "Vulnerability instance ids", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ShowAllOpenStatuses": { "type": "boolean" }, "ShowAllStatuses": { "type": "boolean" }, "IncludeArchivedAssets": { "description": "Include also vulnerabilities from archived assets. False ignores the setting", "type": "boolean" }, "Id": { "format": "uuid", "description": "Vulnerability ID", "type": "string" }, "Ids": { "description": "Vulnerability ID", "type": "array", "items": { "format": "uuid", "type": "string" } }, "SeverityFrom": { "format": "double", "description": "Severity score from", "type": "number" }, "SeverityTo": { "format": "double", "description": "Severity score to", "type": "number" }, "VulnerabilityTagsOneOf": { "description": "Tags included in vulnerability. True if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "VulnerabilityTagsAllOf": { "description": "Tags included in vulnerability. True if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "IncludeInformationRiskLevel": { "description": "Include informational vulnerabilities. False ignores the setting", "type": "boolean" }, "IncludeLowRiskLevel": { "description": "Include low-severity vulnerabilities. False ignores the setting", "type": "boolean" }, "IncludeMediumRiskLevel": { "description": "Include medium-severity vulnerabilities. False ignores the setting", "type": "boolean" }, "IncludeHighRiskLevel": { "description": "Include high-severity vulnerabilities. False ignores the setting", "type": "boolean" }, "IncludeCriticalRiskLevel": { "description": "Include high-severity vulnerabilities. False ignores the setting", "type": "boolean" }, "ExcludePotential": { "description": "Exclude potential vulnerabilities", "type": "boolean" }, "VulnerabilityBasicFields": { "description": "Basic vulnerability fields to search", "type": "array", "items": { "$ref": "#/definitions/FilterBasicField[VulnerabilityBasicFieldEnum]" } }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "VulnerabilityListSummaryViewModel": { "description": "Represents summary information for list of vulnerabilities. It includes total list of vulnerabilities and number of informational findings.", "type": "object", "properties": { "TotalVulnerabilities": { "format": "int32", "description": "Number of vulnerabilities", "type": "integer" }, "TotalInformationalFindings": { "format": "int32", "description": "Number of findings", "type": "integer" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilityPluginDetailsViewModel": { "description": "Represents detailed information about a vulnerability plugin.", "type": "object", "properties": { "PluginId": { "format": "int32", "description": "Gets or sets the unique identifier for the plugin", "type": "integer" }, "Version": { "format": "date-time", "description": "Gets or sets the version date of the plugin", "type": "string" }, "ReleaseDate": { "format": "date-time", "description": "Gets or sets the release date of the plugin", "type": "string" }, "Synopsis": { "description": "Gets or sets a brief summary of the vulnerability (maximum 512 characters)", "maxLength": 512, "type": "string" }, "Description": { "description": "Gets or sets the detailed description of the vulnerability", "type": "string" } }, "additionalProperties": false }, "VulnerabilityReferenceViewModel": { "type": "object", "properties": { "DisplayName": { "description": "A display name", "type": "string" }, "Type": { "$ref": "#/definitions/VulnReferenceTypeEnum" }, "CustomReferenceType": { "description": "Custom reference type. Taken into account only when Type set to CUSTOM", "type": "string" }, "URL": { "description": "A URL to vulnerability reference description", "type": "string" } }, "additionalProperties": false }, "VulnerabilityScanTemplatesFilterModel": { "type": "object", "properties": { "ConfigTypes": { "description": "A list of config types", "type": "array", "items": { "$ref": "#/definitions/ConfigType" } }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "VulnerabilityScansFilterModel": { "description": "Vulnerability scans filter model.", "type": "object", "properties": { "NextRunDays": { "format": "int32", "description": "A next run days", "type": "integer" }, "Protocol": { "$ref": "#/definitions/ProtocolTypes" }, "ScheduleId": { "format": "uuid", "description": "A unique identifier for a schedule", "type": "string" }, "ScanTemplateId": { "format": "uuid", "description": "A unique identifier for a scan template", "type": "string" }, "AllScanRunStates": { "description": "A flag that indicates whether results can contain vulnerability scans with all run states. The default value is 'true'", "type": "boolean" }, "ScanRunStates": { "description": "An array with scan run states that are taken into account during filtering", "type": "array", "items": { "$ref": "#/definitions/ScanRunStateType" } }, "NewFindingsOnly": { "description": "A flag that indicates whether only new findings are returned", "type": "boolean" }, "AutomationAssetsOnly": { "description": "A flag that indicates whether only automation assets are returned", "type": "boolean" }, "SystemScan": { "description": "A flag that indicates whether only System Scans are returned. The default value is 'true'", "type": "boolean" }, "WebScan": { "description": "A flag that indicates whether only Web Scans are returned. The default value is 'true'", "type": "boolean" }, "NameOperator": { "description": "A logic operator that is used to filter results by scan name", "type": "string" }, "Name": { "description": "Filters results by vulnerability scan name", "type": "string" }, "HostName": { "description": "Filters results by host name", "type": "string" }, "HostNameOperator": { "description": "A logical operator that is used to filter results by a host name. The default value is 'Is'", "type": "string" }, "Responsible": { "format": "uuid", "description": "A unique identifier for a responsible user", "type": "string" }, "IPaddressOperator": { "description": "A logical operator that is used to filter results by a host name. The default value is 'Is'", "type": "string" }, "IPaddress": { "description": "Filters results by an IP address", "type": "string" }, "OperatingSystem": { "description": "Filters results by operating system", "type": "string" }, "Scanned": { "$ref": "#/definitions/ScannedWhenModeEnum" }, "ScannedNumber": { "format": "int32", "description": "A number of units used when checking the time of scan. The default value is 1", "type": "integer" }, "ScannedWhenUnit": { "$ref": "#/definitions/ScannedWhenUnitEnum" }, "ScanGroup": { "description": "Filters results by a list of scan groups", "type": "array", "items": { "$ref": "#/definitions/NameIdItem[Guid]" } }, "TagsOneOf": { "description": "Tags included in the scan. The value is 'True' if at least one tag is present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "TagsAllOf": { "description": "Tags included in the scan. The value is 'True' if all tags are present", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "Severity": { "description": "A severity level. The default value is 'All'", "type": "array", "items": { "type": "string" } }, "ExcludeHigherSeverity": { "description": "A flag that indicates whether the result should exclude vulnerabilities with high severity", "type": "boolean" }, "SkipNotScannedTargets": { "description": "A flag that indicates whether targets that are not scanned should be skipped in results", "type": "boolean" }, "HideEmptyScanGroups": { "description": "A flag that indicates whether empty scan groups should be hidden", "type": "boolean" }, "IsUpcomingScan": { "description": "A flag that indicates an upcoming scan", "type": "boolean" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "VulnerabilityScansListViewModel": { "description": "Represents vulnerability scans list.", "type": "object", "properties": { "LastReportId": { "format": "uuid", "description": "A last report unique identifier", "type": "string" }, "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "OS": { "description": "An operating system", "type": "string" }, "ScanningMode": { "$ref": "#/definitions/ScanningMode" }, "CompliantType": { "$ref": "#/definitions/CompliantType" }, "ScanType": { "description": "A scan type", "type": "string" }, "Target": { "description": "A Target", "type": "string" }, "VulnerabilitiesCritical": { "format": "int32", "description": "A number of vulnerabilitites with critical serverity", "type": "integer" }, "VulnerabilitiesHigh": { "format": "int32", "description": "A number of vulnerabilitites with high serverity", "type": "integer" }, "VulnerabilitiesMedium": { "format": "int32", "description": "A number of vulnerabilitites with medium serverity", "type": "integer" }, "VulnerabilitiesLow": { "format": "int32", "description": "A number of vulnerabilitites with low serverity", "type": "integer" }, "VulnerabilitiesInformational": { "format": "int32", "description": "A number of vulnerabilitites with informational serverity", "type": "integer" }, "Change": { "$ref": "#/definitions/ScanChange" }, "LastScan": { "description": "The last scan", "type": "string" }, "Compliant": { "$ref": "#/definitions/CompliantLevel" }, "Host": { "description": "A host", "type": "string", "readOnly": true }, "ScanRunState": { "$ref": "#/definitions/ScanRunStateType" }, "ScanStart": { "format": "date-time", "description": "Date and time when the scan started", "type": "string" }, "ScanStatistics": { "description": "A scan statistics" }, "ScanLastCompleted": { "format": "date-time", "description": "A date and time when scan last completed", "type": "string" }, "ScanLastSeen": { "format": "date-time", "description": "Date and time when the scan was last seen (scan is alive)", "type": "string" }, "ScanHostState": { "format": "int32", "description": "A scan host state", "type": "integer" }, "CanStartScan": { "description": "A flag that indicates if the scan can start", "type": "boolean" }, "CreatedBy": { "format": "uuid", "description": "A unique identifier referring to the user that created the item", "type": "string" }, "AssignedTo": { "format": "uuid", "description": "Id of assigned user", "type": "string" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "ScheduleId": { "format": "uuid", "description": "A unique identifier referring to Schedule", "type": "string", "readOnly": true }, "ScanTemplate": { "$ref": "#/definitions/NameIdItem[Guid]" }, "Schedule": { "$ref": "#/definitions/NameIdItem[Guid]" }, "NextRun": { "format": "date-time", "description": "Date and time of the next run", "type": "string" }, "ScanGroup": { "$ref": "#/definitions/NameIdItem[Guid]" }, "AssetSourceId": { "format": "uuid", "description": "Id of related asset source if exists", "type": "string" }, "AssetSourceType": { "format": "int32", "description": "Type of related asset source if exists", "type": "integer" }, "IsCustomScanTemplate": { "description": "A flag that indicates if scan uses custom template", "type": "boolean" }, "NodeId": { "description": "A scan node identificator (the ID that is present in the scan node license file and Radar Update Service)", "type": "string" }, "ScanNodeName": { "description": "Name of related scan node", "type": "string" } }, "additionalProperties": false }, "VulnerabilityScansSummaryViewModel": { "description": "Summary information and count about vulnerability scans.", "type": "object", "properties": { "TotalScans": { "format": "int32", "description": "Total number of scans", "type": "integer" }, "TotalScansRunning": { "format": "int32", "description": "Total number of running scans", "type": "integer" }, "TotalScansQueued": { "format": "int32", "description": "Total number of queued scans", "type": "integer" } }, "additionalProperties": false }, "VulnerabilityStatusViewModel": { "description": "Represents Vulnerability Status settings.", "required": [ "Name" ], "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability status unique identifier", "type": "string" }, "Name": { "description": "A name of the vulnerability status", "minLength": 1, "type": "string" }, "Description": { "description": "A description of the vulnerability status", "type": "string" }, "IsDefault": { "description": "A flag that indicates if this vulnerability status is the default", "type": "boolean" }, "IsGrayedOutVulnView": { "description": "A flag that indicates if IncludeIn vulnerability counts", "type": "boolean" }, "IncludeInCounters": { "description": "A flag that indicates if all vulnerabilities with this status will be ignored when determining PCI compliance status", "type": "boolean" }, "IncludeInStatistics": { "description": "A flag that indicates if included in statistics and dashboard", "type": "boolean" }, "IsPciCompliant": { "description": "A flag that indicates PCI compliance", "type": "boolean" }, "RequiresAuditorNote": { "description": "A flag that indicates if this status requires a note", "type": "boolean" }, "NewStatusIfRediscoveredInScan": { "format": "uuid", "description": "A unique identifier for new status if rediscovered in scan", "type": "string" }, "NewStatusIfNotRediscoveredInScan": { "format": "uuid", "description": "A unique identifier for new status if not rediscovered in scan", "type": "string" }, "StatusGroup": { "$ref": "#/definitions/StatusGroups" }, "StatusType": { "$ref": "#/definitions/StatusTypes" }, "IsDuplicateStatus": { "description": "Internal Radar use", "type": "boolean" }, "ConsiderInRiskScoreCalculation": { "description": "A flag that indicates if all vulnerabilities with this status will be ignored during risk score calculation", "type": "boolean" }, "ConsiderInRiskScoreAndCounters": { "description": "Flag that indicates whether vulnerability with this status should be taken into account while calculating risk score and vulnerability counters", "type": "boolean" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilityStatusViewModelShort": { "description": "Represents vulnerability status.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability status unique identifier", "type": "string" }, "Name": { "description": "A vulnerability status name", "type": "string" }, "IsDefault": { "description": "A flag that indicates if this vulnerability status is default", "type": "boolean" }, "StatusGroup": { "$ref": "#/definitions/StatusGroups" }, "IsAuditorNoteRequired": { "description": "A flag that indicates if auditor note is required", "type": "boolean" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "VulnerabilityStatuses": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability status object unique identifier", "type": "string" }, "Name": { "description": "A vulnerability status name", "type": "string" }, "Description": { "description": "A vulnerability status description", "type": "string" }, "OrderId": { "format": "int32", "description": "A vulnerability status display order", "type": "integer" }, "StatusGroupId": { "format": "int32", "description": "An identifier of a status group that the vulnerability status belongs to", "type": "integer" }, "IsAuditorNoteRequired": { "description": "Indicates whether changing the vulnerability status requires an auditor note to explain the reason for the status change", "type": "boolean" }, "GraysOutVulnView": { "description": "Indicates whether the vulnerability instance with this status should be grayed out on the view", "type": "boolean" }, "IsPciCompliant": { "description": "Indicates whether the status is PCI compliant", "type": "boolean" }, "ConsideredInCounters": { "description": "Indicates whether the status is considered in counters", "type": "boolean" }, "IsIncludedInStatistics": { "description": "Indicates whether the status is considered in statistics", "type": "boolean" }, "IsDefault": { "description": "Indicates whether the vulnerability status is the default for the status group", "type": "boolean" }, "IsDuplicateStatus": { "description": "Flag that mark vulnerability status as 'duplicated'. That status is used to mark vulnerability that has beed \nfound two or more times for asset. Used internal by Radar", "type": "boolean" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "CreatedBy": { "format": "uuid", "description": "A unique identifier referring to the user that created the item", "type": "string" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "ModifiedBy": { "format": "uuid", "description": "A unique identifier referring to the user who modified the user entry last time", "type": "string" }, "Icon": { "description": "A vulnerability status icon path", "type": "string" }, "ReopenStatusId": { "format": "uuid", "description": "A unique identifier for a vulnerability status. When a vulnerability instance exists and has this closed status, reopen it by marking the instance with another, opened status", "type": "string" }, "MissingStatusId": { "format": "uuid", "description": "An unique identifier of vulnerability status. When a vulnerability instance does not exist anymore, mark it with another, closed status", "type": "string" }, "ConsiderInRiskScoreCalculation": { "description": "Flag that indicates whether vulnerability with this status should be taken into account while calculating risk score", "type": "boolean" }, "ConsiderInRiskScoreAndCounters": { "description": "Flag that indicates whether vulnerability with this status should be taken into account while calculating risk score and vulnerability counters", "type": "boolean" }, "StatusGroup": { "$ref": "#/definitions/StatusGroups" }, "ToolTip": { "description": "Get status title for image flag", "type": "string", "readOnly": true }, "StatusColorBasedOnIcon": { "description": "Get status color based on icon flag", "type": "string", "readOnly": true } }, "additionalProperties": false }, "WSVulnState": { "enum": [ "New", "Current" ], "type": "string" }, "WebScanAttackHttpMethods": { "enum": [ "Delete", "Post", "Put" ], "type": "string" }, "WebScanAuthenticationViewModel": { "description": "An authentication modes.", "type": "object", "properties": { "ServerAuthenticationType": { "$ref": "#/definitions/WebScanServerAuthenticationTypes" }, "Username": { "description": "A discovery scan server username for http basic authentication type", "type": "string" }, "Password": { "description": "A discovery scan server password for http basic authentication type", "type": "string" }, "ReadOnly": { "description": "A value indicating whether the authentication is read only", "type": "boolean" } }, "additionalProperties": false }, "WebScanCustomConfigurationViewModel": { "type": "object", "properties": { "AuthenticationModes": { "description": "An authentication modes", "type": "array", "items": { "$ref": "#/definitions/WebScanAuthenticationViewModel" } }, "RunAttacksEnabled": { "description": "A value indicating whether the run attacks is enabled", "type": "boolean" }, "AttackCategories": { "description": "Web Scan list of category attacks", "type": "array", "items": { "$ref": "#/definitions/WebScanServerAttackCategories" } }, "DisabledPluginIds": { "description": "List of inactive (disabled) Web Scan plugins ids", "type": "array", "items": { "format": "int32", "type": "integer" } }, "CrawlerEnabled": { "description": "A value indicating whether the crawler is enabled", "type": "boolean" }, "AttackUsingHttpMethods": { "description": "Web Scan list of http methods for attack scanning", "type": "array", "items": { "$ref": "#/definitions/WebScanAttackHttpMethods" } }, "ExtendedScanLogEnabled": { "description": "A value indicating whether the expanded scan log is enabled", "type": "boolean" }, "RelativeUrlsForScanning": { "description": "Web Scan list of relative URLs for scanning", "type": "array", "items": { "type": "string" } }, "CustomHeaders": { "description": "Discovery scan custom headers", "type": "array", "items": { "$ref": "#/definitions/NameValueItem[String]" } }, "EnrichUserAgentHeader": { "description": "Enables enriching User-Agent header with a Web Scan product identifier and version", "type": "boolean" }, "ScanningRestrictions": { "description": "discovery scan server scanning restrictions", "type": "array", "items": { "$ref": "#/definitions/WebScanScanningRestrictionViewModel" } }, "MaxParallelRequests": { "format": "int32", "description": "Discovery scan server scanning max parallel requests", "type": "integer" }, "MaxRequestPerSecond": { "format": "int32", "description": "Discovery scan server scanning max request per second", "type": "integer" }, "LoginFingerprint": { "description": "A discovery scan server login fingerprint for a form-based authentication type", "type": "string" }, "LogoutFingerprint": { "description": "A discovery scan server logout fingerprint for a form-based authentication type", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "WebScanRecordingItemViewModel": { "type": "object", "properties": { "Url": { "type": "string" }, "Method": { "type": "string" }, "IsLoginRequest": { "type": "boolean" }, "RequestHeaderMd5": { "type": "string" }, "DoNotAttack": { "type": "boolean" }, "Target": { "type": "string" }, "Port": { "type": "string" }, "Protocol": { "type": "string" }, "RequestHeader": { "type": "string" } }, "additionalProperties": false }, "WebScanRecordingTypes": { "description": "Represents Web Scan recording types possible values.", "enum": [ "BurpXml", "FiddlerArchiveSaz", "RadarNProxyTxt", "RadarRecordingsXml" ], "type": "string" }, "WebScanRecordingUploadViewModel": { "description": "Represents Web Scan recordings.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "A Web Scan recording unique identifier", "type": "string" }, "FileName": { "description": "A Web Scan recording file name", "type": "string" }, "RecordingType": { "$ref": "#/definitions/WebScanRecordingTypes" }, "ContentType": { "description": "Web Scan recording file content", "type": "string" }, "Content": { "description": "Web Scan recording file content", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "WebScanRecordingViewModel": { "type": "object", "properties": { "FileName": { "description": "Name of the recording file", "type": "string" }, "CreatedOn": { "format": "date-time", "description": "Date and time when this item was created", "type": "string" }, "ModifiedOn": { "format": "date-time", "description": "Date and time when this item was last modified", "type": "string" }, "Requests": { "description": "Requests from a recording file", "type": "array", "items": { "$ref": "#/definitions/WebScanRecordingItemViewModel" } }, "ScanGroupId": { "format": "uuid", "description": "ID of the group to which the recording's scan belongs", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "WebScanReportCategoryListViewModel": { "type": "object", "properties": { "WebScanReportCategories": { "description": "A list of Web Scan report categories", "type": "array", "items": { "$ref": "#/definitions/WebScanReportCategoryViewModel" } } }, "additionalProperties": false }, "WebScanReportCategoryViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A unique identifier for Web Scan category", "type": "string" }, "Name": { "description": "A Web Scan category name", "type": "string" }, "Wasc": { "description": "A WASC vulnerability classification", "type": "string" }, "ThreatType": { "description": "Threat type", "type": "string" }, "Description": { "description": "A description", "type": "string" }, "ShortDescription": { "description": "A short description", "type": "string" }, "ReferenceUrl": { "description": "A reference URL", "type": "string" }, "VulnerabilitiesAndFindingsCount": { "format": "int32", "description": "A counter for vulnerabilities and findings", "type": "integer" }, "VulnerabilitiesCount": { "format": "int32", "description": "A counter for vulnerabilities", "type": "integer" }, "VulnerabilitiesDetailsHighCount": { "format": "int32", "description": "A high severity vulnerabilities counter", "type": "integer" }, "VulnerabilitiesDetailsMediumCount": { "format": "int32", "description": "A medium severity vulnerabilities counter", "type": "integer" }, "VulnerabilitiesDetailsLowCount": { "format": "int32", "description": "A low severity vulnerabilities counter", "type": "integer" }, "VulnerabilitiesDetailsInfoCount": { "format": "int32", "description": "A info severity vulnerabilities counter", "type": "integer" }, "FindingsCount": { "format": "int32", "description": "A findings counter", "type": "integer" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "WebScanReportFilterModel": { "type": "object", "properties": { "Categories": { "type": "array", "items": { "format": "uuid", "type": "string" } }, "Findings": { "$ref": "#/definitions/StateVulnerabilitiesAndFindingsFilterModelEnum" }, "VulnerabilityStatusIds": { "description": "A list of unique identifiers for vulnerability statuses", "type": "array", "items": { "format": "uuid", "type": "string" } }, "ShowAllStatuses": { "description": "A flag that indicates whether to show vulnerabilites with all statuses", "type": "boolean" }, "ShowAllOpenStatuses": { "description": "A flag that indicates whether to show vulnerabilities with open statuses", "type": "boolean" }, "Severities": { "description": "A list of severities", "type": "array", "items": { "$ref": "#/definitions/VulnRiskLevels" } }, "ShowAllSeverities": { "description": "A flag that indicates whether to show vulnerabilities with all severities", "type": "boolean" }, "TextFilter": { "description": "A text filter", "type": "string" }, "ShowSeenDates": { "description": "A flag indicates that last seen (occurs in incomming report) vulnerability instance date is present in result set", "type": "boolean" }, "DefaultFilter": { "description": "... a default filter", "type": "boolean" }, "SortPrimary": { "description": "A string that is the primary field for the sorting order (ascending)", "type": "string" }, "SortPrimaryByDesc": { "description": "A string that is the primary field for the sorting order (descending)", "type": "boolean" }, "SortSecondary": { "description": "A string that is the secondary field for the sorting order (ascending)", "type": "string" }, "SortSecondaryByDesc": { "description": "A string that is the secondary field for the sorting order (descending)", "type": "boolean" }, "Flags": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "WebScanReportGroupedViewModel": { "type": "object", "properties": { "MostSevereCount": { "format": "int32", "description": "A counter for the most severe vulnerabilities", "type": "integer" }, "NewCount": { "format": "int32", "description": "A counter for new vulnerabilities", "type": "integer" }, "FixedCount": { "format": "int32", "description": "A counter for fixed vulnerabilities", "type": "integer" }, "VulnerabilitiesAndFindingsCount": { "format": "int32", "description": "A counter for vulnerabilities and findings", "type": "integer" }, "VulnerabilitiesCount": { "format": "int32", "description": "A counter for vulnerabilities", "type": "integer" }, "InformationalCount": { "format": "int32", "description": "An informationals vulnerabilites counter", "type": "integer" }, "MostSevere": { "description": "A list of the most severe Web Scan vulnerabilities", "type": "array", "items": { "$ref": "#/definitions/WebScanReportTopViewModel" } }, "New": { "description": "A list of new Web Scan vulnerabilities", "type": "array", "items": { "$ref": "#/definitions/WebScanReportTopViewModel" } }, "Fixed": { "description": "A list of fixed Web Scan vulnerabilities", "type": "array", "items": { "$ref": "#/definitions/WebScanReportTopViewModel" } }, "ScanReportCvssVersion": { "$ref": "#/definitions/CVSSVersion" } }, "additionalProperties": false }, "WebScanReportTopViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A vulnerability unique identifier", "type": "string" }, "CvssBaseScore": { "format": "double", "description": "A CVSS base score", "type": "number" }, "RiskLevel": { "$ref": "#/definitions/VulnRiskLevels" }, "Name": { "description": "A vulnerability name", "type": "string" } }, "additionalProperties": false }, "WebScanReportUpdateStatusesViewModel": { "description": "A view model with status, note and filter for vulnerability instance to change.", "type": "object", "properties": { "Filter": { "$ref": "#/definitions/WebScanReportFilterModel" }, "UpdateStatuses": { "$ref": "#/definitions/VulnerabilitiesAndFindingsUpdateStatusViewModel" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "WebScanReportViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A unique identifier for a report", "type": "string" }, "ScanEndDate": { "format": "date-time", "description": "A scan end date", "type": "string" }, "ScanStartDate": { "format": "date-time", "description": "A scan start date", "type": "string" }, "RelatedSystemScanName": { "description": "A related System Scan name. It occurs when Web Scan is linked to an existing System Scan", "type": "string" }, "RelatedSystemScanHost": { "description": "A related System Scan host. It occurs when Web Scan is linked to an existing System Scan", "type": "string" }, "RelatedSystemScansId": { "format": "uuid", "description": "A related System Scan id. It occurs when Web Scan is linked to an existing System Scan", "type": "string" }, "ResourceCount": { "format": "int32", "description": "A number of scanned resources", "type": "integer" } }, "additionalProperties": false }, "WebScanReportVulnerabilityCategoryViewModel": { "description": "View model with categories appear in Web Scan report.", "type": "object", "properties": { "Id": { "format": "uuid", "description": "Unique identifier for a vulnerability category", "type": "string" }, "Name": { "description": "A vulnerability category Name", "type": "string" }, "Wasc": { "description": "Category reference ID for a vulnerability", "type": "string" }, "TreatType": { "description": "Type of thread category of vulnerability in Web Scan report", "type": "string" } }, "additionalProperties": false }, "WebScanReportVulnerabilityViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A unique identifier for Web Scan vulnerability details", "type": "string" }, "PluginId": { "format": "int32", "description": "A plugin identifier", "type": "integer" }, "PluginGuidId": { "format": "uuid", "description": "A plug-in unique identifier", "type": "string" }, "Title": { "description": "A title", "type": "string" }, "SeverityName": { "$ref": "#/definitions/VulnRiskLevels" }, "Severity": { "format": "double", "description": "A severity decimal value", "type": "number" }, "State": { "$ref": "#/definitions/WSVulnState" }, "Status": { "description": "A vulnerability status name", "type": "string" }, "StatusId": { "format": "uuid", "description": "A vulnerability status unique identifier", "type": "string" }, "StatusGroup": { "$ref": "#/definitions/StatusGroups" }, "ManualId": { "format": "uuid", "description": "A manual identifier", "type": "string" }, "CVSSBaseScore": { "format": "double", "description": "A CVSS base score", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "A CVSS V3 base score", "type": "number" }, "CVSSBaseScoreOriginal": { "format": "double", "description": "A CVSS base score original", "type": "number" }, "CVSSVector": { "description": "A CVSS vector", "type": "string" }, "CVSSV3Vector": { "description": "A CVSS V3 vector", "type": "string" }, "ClassVariant": { "description": "A class variant", "type": "string" }, "IdentifierId": { "description": "Unique identifier of vulnerability instance occurrence within target", "type": "string" }, "FirstSeenOn": { "format": "date-time", "description": "Date when vulnerability instance was seen for first time", "type": "string" }, "LastSeenOn": { "format": "date-time", "description": "Date of vulnerability last occurance in scan report", "type": "string" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "WebScanScanningRestrictionViewModel": { "type": "object", "properties": { "Action": { "$ref": "#/definitions/WebScanScanningRestrictionsActions" }, "Types": { "$ref": "#/definitions/WebScanScanningRestrictionsTypes" }, "Url": { "description": "A value", "type": "string" }, "Regex": { "description": "A value", "type": "string" } }, "additionalProperties": false }, "WebScanScanningRestrictionsActions": { "enum": [ "Allow", "Block" ], "type": "string" }, "WebScanScanningRestrictionsTypes": { "enum": [ "String", "RegularExpression", "ExternalRegularExpression" ], "type": "string" }, "WebScanServerAttackCategories": { "enum": [ "PassiveChecks", "ForcefulBrowsing", "MaliciousAttacks" ], "type": "string" }, "WebScanServerAuthenticationTypes": { "enum": [ "None", "Basic", "Forms" ], "type": "string" }, "WebScanViewModel": { "description": "Represents Web Scan view model.", "type": "object", "properties": { "ScanId": { "format": "uuid", "description": "A unique identifier for a scan", "type": "string" }, "ScanRunState": { "$ref": "#/definitions/ScanRunStateType" }, "ScanGroupSchedule": { "$ref": "#/definitions/NameIdItem[Guid]" }, "ScanGroupTemplate": { "$ref": "#/definitions/NameIdItem[Guid]" }, "ScanTargetUrl": { "description": "Target URL for a Web Scan", "type": "string" }, "Name": { "description": "A Web Scan name", "type": "string" }, "LastReportId": { "format": "uuid", "description": "Unique identifier of the last scan report", "type": "string" }, "AssignedTo": { "$ref": "#/definitions/NameIdItem[Guid]" }, "ScanGroup": { "$ref": "#/definitions/NameIdItem[Guid]" }, "CustomConfiguration": { "$ref": "#/definitions/WebScanCustomConfigurationViewModel" }, "ScheduleId": { "format": "uuid", "description": "Web Scan schedule unique identifier", "type": "string" }, "Recording": { "$ref": "#/definitions/WebScanRecordingUploadViewModel" }, "RecordingChromeAddonUrl": { "description": "URL of Chrome add-on for recording Web Scans", "type": "string" }, "ScanType": { "$ref": "#/definitions/ScanType" }, "LastScanStart": { "format": "date-time", "description": "A Web Scan last scan start", "type": "string" }, "LastScanEnd": { "format": "date-time", "description": "A Web Scan last scan end", "type": "string" }, "ScanLastCompleted": { "format": "date-time", "description": "A date and time when scan last completed", "type": "string" }, "ScanStatistics": { "description": "A Web Scan statistics" }, "ScanProgress": { "format": "int32", "description": "A Web Scan running progress", "type": "integer" }, "CanStartScan": { "description": "A flag that indicates if the scan can start", "type": "boolean" }, "Tags": { "description": "Web Scan tags", "type": "array", "items": { "$ref": "#/definitions/TagViewModel" } } }, "additionalProperties": false }, "WebScanVulnerabilitiesAndFindingsDetailedViewModel": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "A unique identifier for vulnerability scan details", "type": "string" }, "VulnerabilityCategoryId": { "format": "uuid", "description": "A unique identifier for vulnerability category", "type": "string" }, "StatusId": { "format": "uuid", "description": "A unique identifier for vulnerability status", "type": "string" }, "LastAuditorNote": { "description": "A last auditor note", "type": "string" }, "Synopsis": { "description": "A synopsis", "type": "string" }, "Description": { "description": "A description", "type": "string" }, "Background": { "description": "A background", "type": "string" }, "Solution": { "description": "A solution", "type": "string" }, "Findings": { "description": "Findings", "type": "string" }, "Payloads": { "description": "A list of payloads", "type": "array", "items": { "$ref": "#/definitions/WebScanVulnerabilityPayloadViewModel" } }, "Method": { "description": "A request HTTP method", "type": "string" }, "Request": { "description": "A request body", "type": "string" }, "Response": { "description": "A response body", "type": "string" }, "RequestUnsafe": { "description": "Attack request, not encoded", "type": "string" }, "ResponseUnsafe": { "description": "A server response from the attack, not encoded", "type": "string" }, "HeaderResponse": { "description": "A header response", "type": "string" }, "HeaderResponseUnsafe": { "description": "A server header response from the attack, not encoded", "type": "string" }, "BaseUrl": { "description": "A requested based URL", "type": "string" }, "Url": { "description": "A requested URL", "type": "string" }, "Variant": { "description": "A class variant", "type": "string" }, "CVSSBaseScore": { "format": "double", "description": "A CVSS base score", "type": "number" }, "CVSSV3BaseScore": { "format": "double", "description": "A CVSS base score", "type": "number" }, "SeverityName": { "$ref": "#/definitions/VulnRiskLevels" }, "CVSSBaseScoreOriginal": { "format": "double", "description": "A CVSS base score original", "type": "number" }, "CVSSVector": { "description": "A CVSS vector", "type": "string" }, "CVSSV3Vector": { "description": "A CVSSV3 vector", "type": "string" }, "Fingerprint": { "description": "A list of fingerprints", "type": "array", "items": { "$ref": "#/definitions/WebScanVulnerabilityPayloadViewModel" } }, "VulnerabilityReferences": { "description": "References related to vulnerability provided by OWASP", "type": "array", "items": { "$ref": "#/definitions/VulnerabilitiesAndFindingsDetailedReferenceViewModel" } }, "IdentifierId": { "description": "Unique identifier of vulnerability instance occurrence within target", "type": "string" }, "FirstSeenOn": { "format": "date-time", "description": "Date when vulnerability instance was seen for first time", "type": "string" }, "LastSeenOn": { "format": "date-time", "description": "Date of vulnerability last occurance in scan report", "type": "string" } }, "additionalProperties": false }, "WebScanVulnerabilitiesAndFindingsManualViewModel": { "type": "object", "properties": { "VulnerabilityCategoryId": { "format": "uuid", "description": "Unique identifier for a vulnerability category", "type": "string" }, "VulnerabilityStatusId": { "format": "uuid", "description": "A vulnerability status unique identifier", "type": "string" }, "Request": { "description": "A request", "type": "string" }, "Method": { "description": "A method", "type": "string" }, "ResponseBody": { "description": "A response body", "type": "string" }, "ResponseHeader": { "description": "A response header", "type": "string" }, "Payloads": { "description": "A payload", "type": "string" }, "Findings": { "description": "Findings", "type": "string" }, "BaseUrl": { "description": "An URL", "type": "string" }, "Solution": { "description": "A solution", "type": "string" }, "Synopsis": { "description": "A synopsis", "type": "string" }, "Background": { "description": "Background", "type": "string" }, "Severity": { "$ref": "#/definitions/VulnRiskLevels" }, "ResultMessages": { "description": "A list of messages that are connected to view models produced by API methods", "type": "array", "items": { "$ref": "#/definitions/ISimpleMessage" } }, "Language": { "description": "A language in which the text is returned", "type": "string" }, "MessageLevel": { "$ref": "#/definitions/MsgLevel" }, "Public": { "description": "A flag that indicates whether a message is public. For now, set the value to 'true'", "type": "boolean" } }, "additionalProperties": false }, "WebScanVulnerabilitiesSearchKeyViewModel": { "type": "object", "properties": { "CategoryId": { "format": "uuid", "description": "A unique identifier for Web Scan category", "type": "string" }, "ClassVariant": { "description": "A class variant", "type": "string" }, "ManualId": { "format": "uuid", "description": "A unique identifier for manual vulnerability", "type": "string" }, "PluginId": { "format": "int32", "description": "A plugin identifier", "type": "integer" }, "UseOnlyCategory": { "description": "A flag that indicates to use only category unique identifier", "type": "boolean" }, "VulnerabilityInstanceIds": { "description": "Optional additionOptional additional filter criteria to limit specific instances", "type": "array", "items": { "format": "uuid", "type": "string" } } }, "additionalProperties": false }, "WebScanVulnerabilityCategory": { "type": "object", "properties": { "Id": { "format": "uuid", "description": "Unique identifier for a vulnerability category", "type": "string" }, "Name": { "description": "Vulnerability category name", "type": "string" }, "ReferenceID": { "description": "Category reference ID for a vulnerability ", "type": "string" }, "ThreatType": { "$ref": "#/definitions/ThreatTypes" } }, "additionalProperties": false }, "WebScanVulnerabilityPayloadViewModel": { "description": "View model for payload to instance of vulnerability.", "type": "object", "properties": { "Name": { "description": "A name", "type": "string" }, "Type": { "description": "A type", "type": "string" }, "Value": { "description": "A value", "type": "string" }, "ValueUnsafe": { "description": "A value not encoded", "type": "string" } }, "additionalProperties": false }, "WindowsModes": { "enum": [ "SMB", "WUA" ], "type": "string" }, "WorkflowSettingsViewModel": { "description": "Workflow settings view model.", "type": "object", "properties": { "AutocloseTickets": { "description": "Automatically closes tickets when all vulnerability instances in the ticket are closed", "type": "boolean" }, "ReopenAutomaticallyTickets": { "description": "Reopen tickets automatically when at least one vulnerability instances in the ticket becomes open", "type": "boolean" }, "DaysBeforeDeadlineToNotifyTicketFollowers": { "format": "int32", "description": "Number of days before ticket deadline when participants must be informed about it", "type": "integer" }, "DaysBeforeDeadlineToNotifyTicketFollowersEnabled": { "description": "A flag that indicates if notification to all ticket participants has to be send when number of days specifed in DaysBeforeDeadlineToNotifyTicketFollowers property had happend", "type": "boolean" }, "DeadlineReachedNotification": { "description": "A flag that indicates if notification to all ticket participants has to be send when deadline has been occured", "type": "boolean" }, "AutoMarkInternetExposure": { "description": "A flag which marks if new assets with public IP should be marked as exposed to the internet. (default true)", "type": "boolean" }, "AutoMarkDuplicatedFindings": { "description": "A flag which marks if new findings should be automatically marked as duplicated. (default false)", "type": "boolean" } }, "additionalProperties": false } }, "tags": [ { "name": "Assets monitoring", "description": "manage network assets." }, { "name": "Network scans", "description": "manage system scan and web scan targets." }, { "name": "Discovery scans", "description": "manage discovery scans targets and perform actions such as start and stop." }, { "name": "Assets", "description": "manage collected information about assets." }, { "name": "Vulnerability scan reports", "description": "monitor and filter latest vulnerability reports." }, { "name": "Discovery scan reports", "description": "provides access to discovery scan reports." }, { "name": "Scheduled summary reports", "description": "provides access to scheduled summary reports." }, { "name": "Vulnerabilities", "description": "provides access to a list of all vulnerabilities which have been discovered in your environment." }, { "name": "Scheduling templates", "description": "provides access to scan schedules." }, { "name": "Scan templates", "description": "provides access to scan configuration templates for system, web and discovery scans." }, { "name": "Scan groups", "description": "provides access to a list of available vulnerability scan groups." }, { "name": "Users", "description": "manage available users, user groups and roles." }, { "name": "Tickets", "description": "provides access to ticketing system." }, { "name": "Audit trail", "description": "provides access to diagnostic data." }, { "name": "My profile", "description": "provides access to profile information." }, { "name": "News", "description": "provides access to information feeds." }, { "name": "Scan nodes", "description": "provides access to available scan nodes." }, { "name": "Uncategorized actions", "description": "miscellaneous methods." } ] }