api.assets.v1 package

Submodules

api.assets.v1.application module

Autogenerated API

api.assets.v1.application.add_host_application(hostID: str = None, roleID: int = None, name: str = None, description: str = None, properties: dict = None, cpe: str = None, sockets: list = None, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Creates a new HostApplication. (PUBLIC)

Return type:

dict

Parameters:
  • hostID (str) – Specify parent host.
  • roleID (int) – Specify application role.
  • name (str) – Name of application. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • description (str) – Description of application. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • properties (dict) – Custom user-defined properties. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • cpe (str) – CPE of application.
  • sockets (list) – Specify socket strings of the application.
  • source (str) – Source of the request. (default USER)
Raises:
Returns:

{“offset”: 835, “limit”: 533, “responseCode”: 200, “count”: 43, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Five visit blue nation.”, “messageTemplate”: “Sense performance live kitchen sit notice.”, “field”: “Believe true as modern why.”, “parameter”: {}, “timestamp”: 51875053}], “currentPage”: 970, “size”: 497}

api.assets.v1.application.delete_host_application(id: str, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Marks a HostApplication as deleted. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – HostApplication ID
  • source (str) – Request source (default USER)
Raises:
Returns:

{“offset”: 560, “limit”: 975, “responseCode”: 200, “count”: 917, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Hour including page course raise able spring.”, “messageTemplate”: “Three lead fear there.”, “field”: “Fact him truth whatever bill vote world.”, “parameter”: {}, “timestamp”: 1352951414}], “currentPage”: 31, “size”: 150}

api.assets.v1.application.get_host_application(id: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a HostApplication identified by its ID. (PUBLIC)

Return type:

dict

Parameters:

id (str) – HostApplication ID

Raises:
Returns:

{“offset”: 121, “limit”: 506, “responseCode”: 200, “count”: 714, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Save them place describe cause.”, “messageTemplate”: “Word economic state return possible.”, “field”: “Before back discover should mother where month.”, “parameter”: {}, “timestamp”: 55724617}], “currentPage”: 153, “size”: 804}

api.assets.v1.application.search_host_applications(limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, name: list = None, startTimestamp: int = None, endTimestamp: int = None, keywords: list = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, hostID: list = None, serviceID: list = None, businessProcessID: list = None, ipRange: list = None, applicationPort: list = None, applicationProtocol: list = None, cpe: list = None, hostCPE: list = None, applicationCPE: list = None, applicationRole: list = None, timeFieldStrategy: list = None, keywordFieldStrategy: list = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a set of HostApplications defined by a HostApplicationSearchCriteria. (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • name (list) – Restrict search to specific asset name
  • startTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).
  • endTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).
  • keywords (list) – Search for keywords.
  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).
  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)
  • hostID (list) – Restrict search to specific host UUIDs.
  • serviceID (list) – Restrict search to specific service UUIDs.
  • businessProcessID (list) – Restrict search to specific business process UUIDs.
  • ipRange (list) – Restrict search to entities related to these IP-addresses (may specify single IPs, IP networks or IP ranges.
  • applicationPort (list) – Restrict to applications listening on specific ports.
  • applicationProtocol (list) – Restrict to applications by transport protocol name.
  • cpe (list) – Restrict to applications or hosts by CPE.
  • hostCPE (list) – Restrict to hosts by CPE.
  • applicationCPE (list) – Restrict to applications by CPE.
  • applicationRole (list) – Search for applications by role (list of role IDs).
  • timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp).
  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • includeFlags (list) – Only include objects which have includeFlags set.
  • excludeFlags (list) – Exclude objects which have excludeFlags set.
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
Raises:
Returns:

{“offset”: 846, “limit”: 129, “responseCode”: 200, “count”: 252, “data”: [{“id”: “New sport moment pattern threat.”, “name”: “Maria Griffith”, “description”: “State cut outside three.”, “createdTimestamp”: 1360652022, “createdByUser”: {“id”: 547, “customerID”: 187, “userName”: “alyssa67”, “name”: “Heidi Reynolds”}, “lastUpdatedTimestamp”: 1073475167, “lastUpdatedByUser”: {“id”: 960, “customerID”: 90, “userName”: “jenniferbrown”, “name”: “Susan Gutierrez”}, “deletedTimestamp”: 1476740942, “deletedByUser”: {“id”: 406, “customerID”: 947, “userName”: “christina63”, “name”: “Keith Butler”}, “firstSeenTimestamp”: 1396664066, “lastSeenTimestamp”: 796065402, “flags”: [“CONTROLLED_VERSION”], “properties”: {“additionalProperties”: “Per national miss consumer build hope laugh.”}, “cpe”: “Decide food believe do lose cold stuff.”, “sockets”: [“Paper that service miss clear.”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Become four realize wide main.”, “messageTemplate”: “During wrong true.”, “field”: “Help should reflect writer rest.”, “parameter”: {}, “timestamp”: 367761625}], “currentPage”: 90, “size”: 390}

api.assets.v1.application.search_host_applications_simplified(keywords: list = None, keywordField: list = None, name: list = None, hostID: list = None, serviceID: list = None, businessProcessID: list = None, customerID: list = None, ip: list = None, port: list = None, protocol: list = None, cpe: list = None, includeFlag: list = None, excludeFlag: list = None, sortBy: list = None, offset: int = 0, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a set of HostApplications defined by query parameters. (PUBLIC)

Return type:

dict

Parameters:
  • keywords (list) – Search by keywords
  • keywordField (list) – Set field strategy for keyword search
  • name (list) – Search by name
  • hostID (list) – Search by HostAsset ID
  • serviceID (list) – Search by ServiceAsset ID
  • businessProcessID (list) – Search by BusinessProcess ID
  • customerID (list) – Search by customer ID
  • ip (list) – Search by IP range
  • port (list) – Search by application port
  • protocol (list) – Search by application protocol
  • cpe (list) – Search by CPE
  • includeFlag (list) – Include certain HostApplications in the search result based on set flags
  • excludeFlag (list) – Exclude certain HostApplications from the search result based on set flags
  • sortBy (list) – Sort search result
  • offset (int) – Skip a number of results
  • limit (int) – Maximum number of returned results
  • keywordMatch (str) – Set match strategy for keyword search
Raises:
Returns:

{“offset”: 129, “limit”: 272, “responseCode”: 200, “count”: 127, “data”: [{“id”: “Environmental sound other forward final.”, “name”: “Patricia White”, “description”: “New however several into account pretty too.”, “createdTimestamp”: 1300144697, “createdByUser”: {“id”: 603, “customerID”: 343, “userName”: “steve60”, “name”: “Michael Martinez”}, “lastUpdatedTimestamp”: 1112610104, “lastUpdatedByUser”: {“id”: 664, “customerID”: 13, “userName”: “turnerjermaine”, “name”: “Derrick Chandler”}, “deletedTimestamp”: 935264379, “deletedByUser”: {“id”: 50, “customerID”: 629, “userName”: “anthonyroach”, “name”: “Mary Hendricks”}, “firstSeenTimestamp”: 925729087, “lastSeenTimestamp”: 1065815367, “flags”: [“DETECTED_BY_CVM”], “properties”: {“additionalProperties”: “Himself security paper only.”}, “cpe”: “Into million general analysis.”, “sockets”: [“None despite under middle hear information.”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Father hold edge must full trouble wife project.”, “messageTemplate”: “Response place PM TV east.”, “field”: “Reveal collection but benefit.”, “parameter”: {}, “timestamp”: 524062086}], “currentPage”: 55, “size”: 658}

api.assets.v1.application.update_host_application(id: str, roleID: int = None, name: str = None, description: str = None, addProperties: dict = None, deleteProperties: list = None, cpe: str = None, addSockets: list = None, deleteSockets: list = None, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Updates an existing HostApplication. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – HostApplication ID
  • roleID (int) – Change application role.
  • name (str) – Change application name. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • description (str) – Change application description. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • addProperties (dict) – Add properties to application (updates a property if key already exists). => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • deleteProperties (list) – Remove properties from application by key.
  • cpe (str) – Change application CPE.
  • addSockets (list) – Add sockets to application (list of protocol/port, e.g. tcp/80).
  • deleteSockets (list) – Remove sockets from application (list of protocol/port, e.g. tcp/80).
  • source (str) – Source of the request. (default USER)
Raises:
Returns:

{“offset”: 836, “limit”: 165, “responseCode”: 200, “count”: 140, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Soon performance force suffer but her purpose event.”, “messageTemplate”: “Allow little common us measure away.”, “field”: “Perhaps easy hard everybody.”, “parameter”: {}, “timestamp”: 1055894252}], “currentPage”: 826, “size”: 79}

api.assets.v1.businessprocess module

Autogenerated API

api.assets.v1.businessprocess.add_business_process(ownerID: int = None, customerID: int = None, name: str = None, description: str = None, properties: dict = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Creates a new BusinessProcess. (PUBLIC)

Return type:

dict

Parameters:
  • ownerID (int) – User who owns the asset.
  • customerID (int) – Customer the asset belongs to.
  • name (str) – Name of the asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • description (str) – Description of the asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • properties (dict) – Custom user-defined properties. => [sw{}$-().[]“‘_/,*+#:@!?;]*
Raises:
Returns:

{“offset”: 295, “limit”: 192, “responseCode”: 200, “count”: 750, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Population expect do.”, “messageTemplate”: “Miss real through simple strong part road very.”, “field”: “Respond beyond particularly pattern material majority two.”, “parameter”: {}, “timestamp”: 282220891}], “currentPage”: 123, “size”: 369}

api.assets.v1.businessprocess.attach_services_to_business_process(id: str, serviceAssetIDs: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Adds multiple ServiceAssets to a BusinessProcess. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – BusinessProcess ID
  • serviceAssetIDs (list) – Specify services to add to business process.
Raises:
Returns:

{“offset”: 623, “limit”: 782, “responseCode”: 200, “count”: 374, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Man early man policy the spend range.”, “messageTemplate”: “Much south election social pretty ok.”, “field”: “Bad cover process a more particular yes result.”, “parameter”: {}, “timestamp”: 1404899095}], “currentPage”: 76, “size”: 882}

api.assets.v1.businessprocess.delete_business_process(id: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Marks a BusinessProcess as deleted. (PUBLIC)

Return type:

dict

Parameters:

id (str) – BusinessProcess ID

Raises:
Returns:

{“offset”: 159, “limit”: 687, “responseCode”: 200, “count”: 582, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Expect lead father building front person his.”, “messageTemplate”: “Present blood huge trip this generation.”, “field”: “Others policy sea baby ball.”, “parameter”: {}, “timestamp”: 863463896}], “currentPage”: 205, “size”: 88}

api.assets.v1.businessprocess.detach_services_from_business_process(id: str, serviceAssetIDs: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Removes multiple ServiceAssets from a BusinessProcess. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – BusinessProcess ID
  • serviceAssetIDs (list) – Specify services to detach from business process.
Raises:
Returns:

{“offset”: 4, “limit”: 546, “responseCode”: 200, “count”: 148, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Recent song beat get.”, “messageTemplate”: “Huge also receive gun fire future.”, “field”: “Network edge write perhaps open point ten.”, “parameter”: {}, “timestamp”: 331756130}], “currentPage”: 284, “size”: 20}

api.assets.v1.businessprocess.get_business_process(id: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a BusinessProcess identified by its ID. (PUBLIC)

Return type:

dict

Parameters:

id (str) – BusinessProcess ID

Raises:
Returns:

{“offset”: 327, “limit”: 452, “responseCode”: 200, “count”: 409, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Because form will drive.”, “messageTemplate”: “North want however level.”, “field”: “Police organization want sign paper pretty prepare.”, “parameter”: {}, “timestamp”: 1498666919}], “currentPage”: 413, “size”: 470}

api.assets.v1.businessprocess.search_business_processes(limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, name: list = None, startTimestamp: int = None, endTimestamp: int = None, keywords: list = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, hostID: list = None, serviceID: list = None, businessProcessID: list = None, ipRange: list = None, applicationPort: list = None, applicationProtocol: list = None, cpe: list = None, hostCPE: list = None, applicationCPE: list = None, ownerID: list = None, criticality: list = None, minimumTotalCvss: int = None, maximumTotalCvss: int = None, vulnerabilityReference: list = None, vulnerabilityID: list = None, applicationRole: list = None, timeFieldStrategy: list = None, keywordFieldStrategy: list = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a set of BusinessProcesses defined by a BusinessProcessSearchCriteria. (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • name (list) – Restrict search to specific asset name
  • startTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).
  • endTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).
  • keywords (list) – Search for keywords.
  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).
  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)
  • hostID (list) – Restrict search to specific host UUIDs.
  • serviceID (list) – Restrict search to specific service UUIDs.
  • businessProcessID (list) – Restrict search to specific business process UUIDs.
  • ipRange (list) – Restrict search to entities related to these IP-addresses (may specify single IPs, IP networks or IP ranges.
  • applicationPort (list) – Restrict to applications listening on specific ports.
  • applicationProtocol (list) – Restrict to applications by transport protocol name.
  • cpe (list) – Restrict to applications or hosts by CPE.
  • hostCPE (list) – Restrict to hosts by CPE.
  • applicationCPE (list) – Restrict to applications by CPE.
  • ownerID (list) – Restrict search to specific ownerIDs
  • criticality (list) – Restrict search to a range of criticality levels (add multiple CriticalitySearch objects to specify OR criteria).
  • minimumTotalCvss (int) – Restrict search to a minimum total CVSS score.
  • maximumTotalCvss (int) – Restrict search to a maximum total CVSS score.
  • vulnerabilityReference (list) – Restrict to vulnerabilities identified by vulnerability reference.
  • vulnerabilityID (list) – Restrict to vulnerabilities identified by vulnerability ID.
  • applicationRole (list) – Restrict to applications with specific roles (list of role IDs).
  • timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp on business process).
  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • includeFlags (list) – Only include objects which have includeFlags set.
  • excludeFlags (list) – Exclude objects which have excludeFlags set.
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
Raises:
Returns:

{“offset”: 4, “limit”: 616, “responseCode”: 200, “count”: 621, “data”: [{“id”: “Foot trial always that region population production word.”, “ownedByUser”: {“id”: 566, “customerID”: 597, “userName”: “ppotts”, “name”: “Rachel Booth”}, “name”: “Christopher Thomas”, “description”: “Seem network up defense brother.”, “totalCvss”: 487, “vulnerabilitiesCount”: 367, “createdTimestamp”: 1511474712, “createdByUser”: {“id”: 905, “customerID”: 79, “userName”: “summerbrown”, “name”: “Eric Serrano”}, “lastUpdatedTimestamp”: 496807857, “lastUpdatedByUser”: {“id”: 28, “customerID”: 404, “userName”: “mataashley”, “name”: “Heather Contreras”}, “deletedTimestamp”: 217954820, “deletedByUser”: {“id”: 818, “customerID”: 665, “userName”: “dwayne50”, “name”: “Charles Roy”}, “flags”: [“CREATED_BY_CVM”], “properties”: {“additionalProperties”: “News service bring whole.”}, “services”: [{“id”: “Administration rich official.”, “name”: “Calvin Mathews”}]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Major involve that six all.”, “messageTemplate”: “Seek he card wrong.”, “field”: “Article concern firm change fish until also.”, “parameter”: {}, “timestamp”: 199044277}], “currentPage”: 250, “size”: 514}

api.assets.v1.businessprocess.search_business_processes_simplified(keywords: list = None, keywordField: list = None, name: list = None, hostID: list = None, serviceID: list = None, businessProcessID: list = None, customerID: list = None, ip: list = None, port: list = None, protocol: list = None, cpe: list = None, vulnID: list = None, vulnRef: list = None, includeFlag: list = None, excludeFlag: list = None, sortBy: list = None, offset: int = 0, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns as set of BusinessProcesses defined by query parameters. (PUBLIC)

Return type:

dict

Parameters:
  • keywords (list) – Search by keywords
  • keywordField (list) – Set field strategy for keyword search
  • name (list) – Search by name
  • hostID (list) – Search by HostAsset ID
  • serviceID (list) – Search by ServiceAsset ID
  • businessProcessID (list) – Search by BusinessProcess ID
  • customerID (list) – Search by customer ID
  • ip (list) – Search by IP range
  • port (list) – Search by application port
  • protocol (list) – Search by application protocol
  • cpe (list) – Search by CPE
  • vulnID (list) – Search by vulnerability ID
  • vulnRef (list) – Search by vulnerability reference
  • includeFlag (list) – Include certain BusinessProcesses in the search result based on set flags
  • excludeFlag (list) – Exclude certain BusinessProcesses from the search result based on set flags
  • sortBy (list) – Sort search result
  • offset (int) – Skip a number of results
  • limit (int) – Maximum number of returned results
  • keywordMatch (str) – Set match strategy for keyword search
Raises:
Returns:

{“offset”: 293, “limit”: 401, “responseCode”: 200, “count”: 37, “data”: [{“id”: “Price collection audience she west.”, “ownedByUser”: {“id”: 873, “customerID”: 148, “userName”: “jamesmartinez”, “name”: “Daniel Smith”}, “name”: “Andrew Stanley”, “description”: “Because from social issue reason ever matter.”, “totalCvss”: 22, “vulnerabilitiesCount”: 614, “createdTimestamp”: 586898005, “createdByUser”: {“id”: 351, “customerID”: 520, “userName”: “lucasmejia”, “name”: “Jose Roach”}, “lastUpdatedTimestamp”: 679596836, “lastUpdatedByUser”: {“id”: 398, “customerID”: 58, “userName”: “carrolltroy”, “name”: “Lisa Lopez”}, “deletedTimestamp”: 206440936, “deletedByUser”: {“id”: 117, “customerID”: 533, “userName”: “fernandezlindsey”, “name”: “Christina Anderson”}, “flags”: [“UPDATED_BY_CVM”], “properties”: {“additionalProperties”: “Including almost pay other year difficult event middle.”}, “services”: [{“id”: “Whose town candidate citizen feel.”, “name”: “Sandra Burns”}]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Material agent term month.”, “messageTemplate”: “Add international product hope.”, “field”: “Last serve then detail information investment life thing.”, “parameter”: {}, “timestamp”: 435676746}], “currentPage”: 399, “size”: 888}

api.assets.v1.businessprocess.update_business_process(id: str, ownerID: int = None, name: str = None, description: str = None, addProperties: dict = None, deleteProperties: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Updates an existing BusinessProcess. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – BusinessProcess ID
  • ownerID (int) – Change user who owns the asset.
  • name (str) – Change name of asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • description (str) – Change description of asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • addProperties (dict) – Add custom properties (updates a property if key already exists). => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • deleteProperties (list) – Delete custom properties by key.
Raises:
Returns:

{“offset”: 175, “limit”: 158, “responseCode”: 200, “count”: 236, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Quickly participant my control color treat employee.”, “messageTemplate”: “Claim spend participant trial current group.”, “field”: “They agree produce best cover.”, “parameter”: {}, “timestamp”: 641701879}], “currentPage”: 96, “size”: 747}

api.assets.v1.host module

Autogenerated API

api.assets.v1.host.add_host_asset(ownerID: int = None, customerID: int = None, name: str = None, description: str = None, properties: dict = None, operatingSystemCPE: str = None, ipAddresses: list = None, aliases: list = None, type: str = 'SERVER', source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Creates a new HostAsset. (PUBLIC)

Return type:

dict

Parameters:
  • ownerID (int) – User who owns the asset.
  • customerID (int) – Customer the asset belongs to.
  • name (str) – Name of the asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • description (str) – Description of the asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • properties (dict) – Custom user-defined properties. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • operatingSystemCPE (str) – CPE of the host operating system.
  • ipAddresses (list) – IP address(es) of the host.
  • aliases (list) – Aliases (domain names) of the host.
  • type (str) – Defines if host is a client or a server. (default SERVER)
  • source (str) – Source of the request. (default USER)
Raises:
Returns:

{“offset”: 1, “limit”: 537, “responseCode”: 200, “count”: 519, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Say different again happy main north.”, “messageTemplate”: “Culture husband design.”, “field”: “Natural number million moment others think religious indicate.”, “parameter”: {}, “timestamp”: 801805390}], “currentPage”: 847, “size”: 892}

api.assets.v1.host.bulk_update_host_asset(assetVulnerabilityAddRequests: list = None, assetVulnerabilityUpdateRequests: list = None, assetVulnerabilityResolveRequests: list = None, assetVulnerabilityDeleteRequests: list = None, hostApplicationAddRequests: list = None, hostApplicationUpdateRequests: list = None, hostApplicationDeleteRequests: list = None, hostAssetAddRequests: list = None, hostAssetUpdateRequests: list = None, hostAssetDeleteRequests: list = None, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Performs multiple updates to HostAssets in a single transaction. (PUBLIC)

Return type:

dict

Parameters:
  • assetVulnerabilityAddRequests (list) – List of AssetVulnerabilityAddRequests.
  • assetVulnerabilityUpdateRequests (list) – List of AssetVulnerabilityUpdateRequests.
  • assetVulnerabilityResolveRequests (list) – List of AssetVulnerabilityResolveRequests.
  • assetVulnerabilityDeleteRequests (list) – List of AssetVulnerabilityDeleteRequests.
  • hostApplicationAddRequests (list) – List of HostApplicationAddRequests.
  • hostApplicationUpdateRequests (list) – List of HostApplicationUpdateRequests.
  • hostApplicationDeleteRequests (list) – List of HostApplicationDeleteRequests.
  • hostAssetAddRequests (list) – List of HostAssetAddRequests. Adding vulnerabilities/applications to added hosts must be done in separate transaction.
  • hostAssetUpdateRequests (list) – List of HostAssetUpdateRequests.
  • hostAssetDeleteRequests (list) – List of HostAssetDeleteRequests.
  • source (str) – Source of the request. (default USER)
Raises:
Returns:

{“offset”: 63, “limit”: 650, “responseCode”: 200, “count”: 443, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Yes line high beyond time water require.”, “messageTemplate”: “Sort effect market bill.”, “field”: “Ago choice wait lay service training small.”, “parameter”: {}, “timestamp”: 500036626}], “currentPage”: 7, “size”: 583}

api.assets.v1.host.delete_host_asset(id: str, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Marks a HostAsset as deleted. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – HostAsset ID
  • source (str) – Request source (default USER)
Raises:
Returns:

{“offset”: 682, “limit”: 963, “responseCode”: 200, “count”: 412, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Determine rest standard.”, “messageTemplate”: “Culture red out vote challenge total.”, “field”: “Still main defense without kind water area.”, “parameter”: {}, “timestamp”: 31594892}], “currentPage”: 380, “size”: 46}

api.assets.v1.host.get_host_asset(id: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a HostAsset identified by its ID. (PUBLIC)

Return type:

dict

Parameters:

id (str) – HostAsset ID

Raises:
Returns:

{“offset”: 15, “limit”: 998, “responseCode”: 200, “count”: 991, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Your those pattern perhaps.”, “messageTemplate”: “Seem social maybe network suggest affect.”, “field”: “Little idea themselves while figure trip.”, “parameter”: {}, “timestamp”: 752167821}], “currentPage”: 129, “size”: 637}

api.assets.v1.host.search_host_assets(limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, name: list = None, startTimestamp: int = None, endTimestamp: int = None, keywords: list = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, hostID: list = None, serviceID: list = None, businessProcessID: list = None, ipRange: list = None, applicationPort: list = None, applicationProtocol: list = None, cpe: list = None, hostCPE: list = None, applicationCPE: list = None, ownerID: list = None, criticality: list = None, minimumTotalCvss: int = None, maximumTotalCvss: int = None, vulnerabilityReference: list = None, vulnerabilityID: list = None, applicationRole: list = None, type: str = None, timeFieldStrategy: list = None, keywordFieldStrategy: list = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', includeVulnerabilityRawOutput: bool = 'False', includeVulnerabilityConclusion: bool = 'False', includeVulnerabilitySolution: bool = 'False', includeVulnerabilities: bool = 'False', includeApplications: bool = 'False', includeServices: bool = 'False', connectedToService: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a set of HostAssets defined by a HostAssetSearchCriteria. (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • name (list) – Restrict search to specific asset name
  • startTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).
  • endTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).
  • keywords (list) – Search for keywords.
  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).
  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)
  • hostID (list) – Restrict search to specific host UUIDs.
  • serviceID (list) – Restrict search to specific service UUIDs.
  • businessProcessID (list) – Restrict search to specific business process UUIDs.
  • ipRange (list) – Restrict search to entities related to these IP-addresses (may specify single IPs, IP networks or IP ranges.
  • applicationPort (list) – Restrict to applications listening on specific ports.
  • applicationProtocol (list) – Restrict to applications by transport protocol name.
  • cpe (list) – Restrict to applications or hosts by CPE.
  • hostCPE (list) – Restrict to hosts by CPE.
  • applicationCPE (list) – Restrict to applications by CPE.
  • ownerID (list) – Restrict search to specific ownerIDs
  • criticality (list) – Restrict search to a range of criticality levels (add multiple CriticalitySearch objects to specify OR criteria).
  • minimumTotalCvss (int) – Restrict search to a minimum total CVSS score.
  • maximumTotalCvss (int) – Restrict search to a maximum total CVSS score.
  • vulnerabilityReference (list) – Restrict to vulnerabilities identified by vulnerability reference.
  • vulnerabilityID (list) – Restrict to vulnerabilities identified by vulnerability ID.
  • applicationRole (list) – Restrict to applications with specific roles (list of role IDs).
  • type (str) – Restrict search to a specific type of host (client or server).
  • timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp on host).
  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • includeFlags (list) – Only include objects which have includeFlags set.
  • excludeFlags (list) – Exclude objects which have excludeFlags set.
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
  • includeVulnerabilityRawOutput (bool) – Include vulnerability rawOutput in result (default false).
  • includeVulnerabilityConclusion (bool) – Include vulnerability conclusion in result (default false).
  • includeVulnerabilitySolution (bool) – Include vulnerability solution in result (default false).
  • includeVulnerabilities (bool) – Include host vulnerabilities in result (default false).
  • includeApplications (bool) – Include host applications in result (default false).
  • includeServices (bool) – Include related services in result (default false).
  • connectedToService (bool) – If true, only return hosts connected to service(s). If false, return hosts not connected to any service. If not set, do not filter.
Raises:
Returns:

{“offset”: 264, “limit”: 131, “responseCode”: 200, “count”: 260, “data”: [{“id”: “Investment probably decision country yard worker term together.”, “ownedByUser”: {“id”: 153, “customerID”: 996, “userName”: “brian88”, “name”: “William Lee”}, “name”: “Maureen Ortiz”, “description”: “We speak special good.”, “totalCvss”: 277, “vulnerabilitiesCount”: 558, “createdTimestamp”: 1132686718, “createdByUser”: {“id”: 621, “customerID”: 164, “userName”: “austin44”, “name”: “Andrea Alexander”}, “lastUpdatedTimestamp”: 423351883, “lastUpdatedByUser”: {“id”: 618, “customerID”: 249, “userName”: “fuentesmegan”, “name”: “Michael Mckee”}, “deletedTimestamp”: 59328897, “deletedByUser”: {“id”: 573, “customerID”: 80, “userName”: “donnavasquez”, “name”: “Jose Vazquez”}, “flags”: [“DETECTED_BY_CVM”], “properties”: {“additionalProperties”: “Bar finally girl hotel movie happen actually.”}, “firstSeenTimestamp”: 358990782, “lastSeenTimestamp”: 135112269, “lastScanTimestamp”: 1300540895, “ipAddresses”: [{“host”: true, “maskBits”: 52, “ipv6”: true, “multicast”: true, “public”: true, “address”: “Low nor later close time why.”}], “aliases”: [{“fqdn”: “Put truth great might.”}], “services”: [{“id”: “Whole even short choose step stand.”, “name”: “Richard Young”}], “applications”: [{“id”: “Man author middle own six past trouble.”, “name”: “Rebecca Duncan”, “description”: “Ground yard nearly single majority where.”, “createdTimestamp”: 669391324, “lastUpdatedTimestamp”: 1422566856, “deletedTimestamp”: 1420996974, “firstSeenTimestamp”: 424585522, “lastSeenTimestamp”: 1290594798, “flags”: [“UPDATED_BY_CVM”], “properties”: {“additionalProperties”: “Economic eight far away run shoulder.”}, “cpe”: “Today half task want.”, “sockets”: [“Try international structure knowledge nearly growth accept.”]}], “vulnerabilities”: [{“id”: “Probably bar place.”, “vulnerabilityID”: “Husband black course newspaper forward way name.”, “references”: [“Money end huge body cup identify.”], “name”: “Donna Oneal”, “description”: “Into she why.”, “conclusion”: “Yet be air again from.”, “solution”: “Office himself think current possible wife your.”, “rawOutput”: “Sort reality public able real.”, “cvss”: 386, “createdTimestamp”: 751571948, “lastUpdatedTimestamp”: 1181158461, “deletedTimestamp”: 226309301, “firstSeenTimestamp”: 952168912, “lastSeenTimestamp”: 235697233, “resolutionTimestamp”: 1257904148, “resolutionComment”: “Almost at hair.”, “resolution”: “NO_LONGER_VULNERABLE”, “flags”: [“DELETED_FROM_CVM”], “properties”: {“additionalProperties”: “Reveal already similar market.”}, “severity”: “medium”, “socket”: “Mouth each job father strong.”}], “operatingSystemCPE”: “Personal teach side behavior first.”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Material paper great mean sometimes whose.”, “messageTemplate”: “Per research end personal eight order.”, “field”: “Team whose customer around expert wide movement win.”, “parameter”: {}, “timestamp”: 897649906}], “currentPage”: 374, “size”: 249}

api.assets.v1.host.search_host_assets_simplified(keywords: list = None, keywordField: list = None, name: list = None, hostID: list = None, serviceID: list = None, businessProcessID: list = None, customerID: list = None, ip: list = None, port: list = None, protocol: list = None, cpe: list = None, vulnID: list = None, vulnRef: list = None, includeFlag: list = None, excludeFlag: list = None, sortBy: list = None, offset: int = 0, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns as set of HostAssets defined by query parameters. (PUBLIC)

Return type:

dict

Parameters:
  • keywords (list) – Search by keywords
  • keywordField (list) – Set field strategy for keyword search
  • name (list) – Search by name
  • hostID (list) – Search by HostAsset ID
  • serviceID (list) – Search by ServiceAsset ID
  • businessProcessID (list) – Search by BusinessProcess ID
  • customerID (list) – Search by customer ID
  • ip (list) – Search by IP range
  • port (list) – Search by application port
  • protocol (list) – Search by application protocol
  • cpe (list) – Search by CPE
  • vulnID (list) – Search by vulnerability ID
  • vulnRef (list) – Search by vulnerability reference
  • includeFlag (list) – Include certain HostAssets in the search result based on set flags
  • excludeFlag (list) – Exclude certain HostAssets from the search result based on set flags
  • sortBy (list) – Sort search result
  • offset (int) – Skip a number of results
  • limit (int) – Maximum number of returned results
  • keywordMatch (str) – Set match strategy for keyword search
Raises:
Returns:

{“offset”: 507, “limit”: 118, “responseCode”: 200, “count”: 96, “data”: [{“id”: “Either need practice weight me people some.”, “ownedByUser”: {“id”: 663, “customerID”: 343, “userName”: “john95”, “name”: “Ryan Richards”}, “name”: “Steven Wood”, “description”: “Garden central friend employee onto moment.”, “totalCvss”: 386, “vulnerabilitiesCount”: 721, “createdTimestamp”: 504845559, “createdByUser”: {“id”: 236, “customerID”: 572, “userName”: “gatestamara”, “name”: “Miss Jessica Myers”}, “lastUpdatedTimestamp”: 1198345314, “lastUpdatedByUser”: {“id”: 785, “customerID”: 351, “userName”: “ipadilla”, “name”: “David Knight”}, “deletedTimestamp”: 1385236381, “deletedByUser”: {“id”: 589, “customerID”: 317, “userName”: “dalebowen”, “name”: “Steven Sullivan”}, “flags”: [“DELETED”], “properties”: {“additionalProperties”: “Four yourself right owner.”}, “firstSeenTimestamp”: 895616699, “lastSeenTimestamp”: 303175482, “lastScanTimestamp”: 1306160240, “ipAddresses”: [{“host”: false, “maskBits”: 149, “ipv6”: true, “multicast”: true, “public”: false, “address”: “Heavy live eight miss great well push.”}], “aliases”: [{“fqdn”: “Mouth bill safe Mr.”}], “services”: [{“id”: “Design difference expert second wish field.”, “name”: “Michael Sullivan”}], “applications”: [{“id”: “Run knowledge also despite power quite.”, “name”: “Samuel Bass”, “description”: “Case approach there why sing marriage strategy suffer.”, “createdTimestamp”: 635722591, “lastUpdatedTimestamp”: 2617576, “deletedTimestamp”: 2814425, “firstSeenTimestamp”: 711605920, “lastSeenTimestamp”: 322666376, “flags”: [“MISSING_FROM_CVM”], “properties”: {“additionalProperties”: “Participant free development my policy soon any.”}, “cpe”: “Item would note begin term.”, “sockets”: [“Know least whom what good hundred.”]}], “vulnerabilities”: [{“id”: “Blue politics tough state.”, “vulnerabilityID”: “Could chance performance edge tell probably.”, “references”: [“Eight record road current.”], “name”: “Terrance Lee”, “description”: “Week sign cup where sister just participant.”, “conclusion”: “Car level parent society thank scientist.”, “solution”: “Us along kind increase fly market manager.”, “rawOutput”: “Capital pretty behind quality world.”, “cvss”: 950, “createdTimestamp”: 750195419, “lastUpdatedTimestamp”: 829967952, “deletedTimestamp”: 465276206, “firstSeenTimestamp”: 485124631, “lastSeenTimestamp”: 1041173878, “resolutionTimestamp”: 939993144, “resolutionComment”: “Forget system exist sound defense beautiful result particular.”, “resolution”: “UNRESOLVED”, “flags”: [“CREATED_BY_CVM”], “properties”: {“additionalProperties”: “Attorney sound event describe rock blood break country.”}, “severity”: “info”, “socket”: “Seek wear consumer degree economy as.”}], “operatingSystemCPE”: “Some part writer our raise theory born smile.”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Recognize skill wonder professor film take able economic.”, “messageTemplate”: “Say range message eat behind not.”, “field”: “Dinner region treatment mention.”, “parameter”: {}, “timestamp”: 51701074}], “currentPage”: 173, “size”: 507}

api.assets.v1.host.update_host_asset(id: str, ownerID: int = None, name: str = None, description: str = None, addProperties: dict = None, deleteProperties: list = None, type: str = None, operatingSystemCPE: str = None, addIpAddresses: list = None, deleteIpAddresses: list = None, addAliases: list = None, deleteAliases: list = None, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Updates an existing HostAsset. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – HostAsset ID
  • ownerID (int) – Change user who owns the asset.
  • name (str) – Change name of asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • description (str) – Change description of asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • addProperties (dict) – Add custom properties (updates a property if key already exists). => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • deleteProperties (list) – Delete custom properties by key.
  • type (str) – Change type of host (client or server).
  • operatingSystemCPE (str) – Change CPE of host.
  • addIpAddresses (list) – Add IP address(es) to host.
  • deleteIpAddresses (list) – Delete IP address(es) from host.
  • addAliases (list) – Add alias(es) (domain names) to host.
  • deleteAliases (list) – Delete alias(es) from host.
  • source (str) – Source of the request. (default USER)
Raises:
Returns:

{“offset”: 38, “limit”: 343, “responseCode”: 200, “count”: 410, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Along ok require spring occur happen.”, “messageTemplate”: “Security discussion mind art whose similar throughout.”, “field”: “They movie huge be.”, “parameter”: {}, “timestamp”: 484096583}], “currentPage”: 433, “size”: 769}

api.assets.v1.scan module

Autogenerated API

api.assets.v1.scan.host_asset_bulk_scanned(customerID: int = None, scannedRequests: list = None, scannedIpRanges: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Marks multiple HostAsset as scanned. (PUBLIC)

Return type:

dict

Parameters:
  • customerID (int) – Define customer which was scanned.
  • scannedRequests (list) – Set of host scan requests.
  • scannedIpRanges (list) – Set of scanned IP address ranges as list of single IPs (1.1.1.1), CIDR networks (1.1.1.0/24) or ranges (1.1.1.1-1.1.1.2)
Raises:
Returns:

{“offset”: 210, “limit”: 532, “responseCode”: 200, “count”: 501, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Everything through guess scene picture majority beautiful face.”, “messageTemplate”: “Write contain floor pattern protect.”, “field”: “Personal social enjoy piece.”, “parameter”: {}, “timestamp”: 1499060129}], “currentPage”: 993, “size”: 464}

api.assets.v1.scan.host_asset_scanned(customerID: int, ip: str, detectedVulnerabilities: list = None, detectedApplications: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Marks a single HostAsset as scanned. (PUBLIC)

Return type:

dict

Parameters:
  • customerID (int) – Customer ID
  • ip (str) – IP address of scanned HostAsset
  • detectedVulnerabilities (list) – Specify (vulnerabilityID, socket string) objects of detected vulnerabilities.
  • detectedApplications (list) – Specify sockets of detected applications (e.g. tcp/80).
Raises:
Returns:

{“offset”: 749, “limit”: 277, “responseCode”: 200, “count”: 422, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Wish peace reason child paper have lead.”, “messageTemplate”: “Thing body forget issue thank.”, “field”: “Already policy push several us project.”, “parameter”: {}, “timestamp”: 414243620}], “currentPage”: 385, “size”: 976}

api.assets.v1.service module

Autogenerated API

api.assets.v1.service.add_service_asset(ownerID: int = None, customerID: int = None, name: str = None, description: str = None, properties: dict = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Creates a new ServiceAsset. (PUBLIC)

Return type:

dict

Parameters:
  • ownerID (int) – User who owns the asset.
  • customerID (int) – Customer the asset belongs to.
  • name (str) – Name of the asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • description (str) – Description of the asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • properties (dict) – Custom user-defined properties. => [sw{}$-().[]“‘_/,*+#:@!?;]*
Raises:
Returns:

{“offset”: 660, “limit”: 6, “responseCode”: 200, “count”: 682, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Should large everyone friend itself.”, “messageTemplate”: “Health say find left detail.”, “field”: “Peace bag hotel usually fund skill free prove.”, “parameter”: {}, “timestamp”: 613548495}], “currentPage”: 726, “size”: 627}

api.assets.v1.service.attach_hosts_to_service(id: str, hostAssetIDs: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Adds multiple HostAssets to a ServiceAsset. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – ServiceAsset ID
  • hostAssetIDs (list) – Specify hosts to add to service.
Raises:
Returns:

{“offset”: 583, “limit”: 676, “responseCode”: 200, “count”: 320, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Public answer tax address much.”, “messageTemplate”: “Drop day win those their.”, “field”: “Speak movement as spend fly.”, “parameter”: {}, “timestamp”: 1348688965}], “currentPage”: 131, “size”: 388}

api.assets.v1.service.delete_service_asset(id: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Marks a ServiceAsset as deleted. (PUBLIC)

Return type:

dict

Parameters:

id (str) – ServiceAsset ID

Raises:
Returns:

{“offset”: 348, “limit”: 287, “responseCode”: 200, “count”: 580, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “It throw example black.”, “messageTemplate”: “Head concern early do room system actually.”, “field”: “Build key own road oil night sure.”, “parameter”: {}, “timestamp”: 647723156}], “currentPage”: 958, “size”: 771}

api.assets.v1.service.detach_hosts_from_service(id: str, hostAssetIDs: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Removes multiple HostAssets from a ServiceAsset. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – ServiceAsset ID
  • hostAssetIDs (list) – Specify hosts to detach from service.
Raises:
Returns:

{“offset”: 797, “limit”: 911, “responseCode”: 200, “count”: 751, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Picture where east we social.”, “messageTemplate”: “Me something he build protect.”, “field”: “Night continue when that.”, “parameter”: {}, “timestamp”: 311274374}], “currentPage”: 908, “size”: 833}

api.assets.v1.service.get_service_asset(id: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a ServiceAsset identified by its ID. (PUBLIC)

Return type:

dict

Parameters:

id (str) – ServiceAsset ID

Raises:
Returns:

{“offset”: 275, “limit”: 704, “responseCode”: 200, “count”: 873, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Where visit decide.”, “messageTemplate”: “Be on prepare nor ask American.”, “field”: “Behind paper book early.”, “parameter”: {}, “timestamp”: 1116600417}], “currentPage”: 730, “size”: 249}

api.assets.v1.service.search_service_assets(limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, name: list = None, startTimestamp: int = None, endTimestamp: int = None, keywords: list = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, hostID: list = None, serviceID: list = None, businessProcessID: list = None, ipRange: list = None, applicationPort: list = None, applicationProtocol: list = None, cpe: list = None, hostCPE: list = None, applicationCPE: list = None, ownerID: list = None, criticality: list = None, minimumTotalCvss: int = None, maximumTotalCvss: int = None, vulnerabilityReference: list = None, vulnerabilityID: list = None, applicationRole: list = None, timeFieldStrategy: list = None, keywordFieldStrategy: list = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a set of ServiceAssets defined by a ServiceAssetSearchCriteria. (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • name (list) – Restrict search to specific asset name
  • startTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).
  • endTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).
  • keywords (list) – Search for keywords.
  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).
  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)
  • hostID (list) – Restrict search to specific host UUIDs.
  • serviceID (list) – Restrict search to specific service UUIDs.
  • businessProcessID (list) – Restrict search to specific business process UUIDs.
  • ipRange (list) – Restrict search to entities related to these IP-addresses (may specify single IPs, IP networks or IP ranges.
  • applicationPort (list) – Restrict to applications listening on specific ports.
  • applicationProtocol (list) – Restrict to applications by transport protocol name.
  • cpe (list) – Restrict to applications or hosts by CPE.
  • hostCPE (list) – Restrict to hosts by CPE.
  • applicationCPE (list) – Restrict to applications by CPE.
  • ownerID (list) – Restrict search to specific ownerIDs
  • criticality (list) – Restrict search to a range of criticality levels (add multiple CriticalitySearch objects to specify OR criteria).
  • minimumTotalCvss (int) – Restrict search to a minimum total CVSS score.
  • maximumTotalCvss (int) – Restrict search to a maximum total CVSS score.
  • vulnerabilityReference (list) – Restrict to vulnerabilities identified by vulnerability reference.
  • vulnerabilityID (list) – Restrict to vulnerabilities identified by vulnerability ID.
  • applicationRole (list) – Restrict to applications with specific roles (list of role IDs).
  • timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp on service).
  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • includeFlags (list) – Only include objects which have includeFlags set.
  • excludeFlags (list) – Exclude objects which have excludeFlags set.
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
Raises:
Returns:

{“offset”: 159, “limit”: 986, “responseCode”: 200, “count”: 640, “data”: [{“id”: “Early local operation executive.”, “ownedByUser”: {“id”: 112, “customerID”: 710, “userName”: “pwilliams”, “name”: “Andre Duke”}, “name”: “Nicole Yates”, “description”: “Someone book kind rock cup identify.”, “totalCvss”: 383, “vulnerabilitiesCount”: 600, “createdTimestamp”: 215130053, “createdByUser”: {“id”: 897, “customerID”: 166, “userName”: “qwilson”, “name”: “Jacqueline Holden”}, “lastUpdatedTimestamp”: 1508074781, “lastUpdatedByUser”: {“id”: 82, “customerID”: 730, “userName”: “gilmorecameron”, “name”: “Jill Luna”}, “deletedTimestamp”: 1006481602, “deletedByUser”: {“id”: 24, “customerID”: 369, “userName”: “katiedavenport”, “name”: “Christina Nguyen”}, “flags”: [“UPDATED_BY_CVM”], “properties”: {“additionalProperties”: “Condition than animal defense Mr meet.”}, “businessProcesses”: [{“id”: “Ever bill specific process.”, “name”: “Leonard Roberts”}], “hosts”: [{“id”: “Garden approach tax each artist.”, “name”: “Andrew Sloan”}]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Poor race year may.”, “messageTemplate”: “Matter with exactly grow artist reason help.”, “field”: “Spend song player low.”, “parameter”: {}, “timestamp”: 252457619}], “currentPage”: 139, “size”: 404}

api.assets.v1.service.search_service_assets_simplified(keywords: list = None, keywordField: list = None, name: list = None, hostID: list = None, serviceID: list = None, businessProcessID: list = None, customerID: list = None, ip: list = None, port: list = None, protocol: list = None, cpe: list = None, vulnID: list = None, vulnRef: list = None, includeFlag: list = None, excludeFlag: list = None, sortBy: list = None, offset: int = 0, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns as set of ServiceAssets defined by query parameters. (PUBLIC)

Return type:

dict

Parameters:
  • keywords (list) – Search by keywords
  • keywordField (list) – Set field strategy for keyword search
  • name (list) – Search by name
  • hostID (list) – Search by HostAsset ID
  • serviceID (list) – Search by ServiceAsset ID
  • businessProcessID (list) – Search by BusinessProcess ID
  • customerID (list) – Search by customer ID
  • ip (list) – Search by IP range
  • port (list) – Search by application port
  • protocol (list) – Search by application protocol
  • cpe (list) – Search by CPE
  • vulnID (list) – Search by vulnerability ID
  • vulnRef (list) – Search by vulnerability reference
  • includeFlag (list) – Include certain ServiceAssets in the search result based on set flags
  • excludeFlag (list) – Exclude certain ServiceAssets from the search result based on set flags
  • sortBy (list) – Sort search result
  • offset (int) – Skip a number of results
  • limit (int) – Maximum number of returned results
  • keywordMatch (str) – Set match strategy for keyword search
Raises:
Returns:

{“offset”: 415, “limit”: 72, “responseCode”: 200, “count”: 35, “data”: [{“id”: “Relationship Mrs something.”, “ownedByUser”: {“id”: 865, “customerID”: 112, “userName”: “reginaldwilliams”, “name”: “Nicholas Yoder”}, “name”: “Jennifer Bell”, “description”: “Her world cultural.”, “totalCvss”: 608, “vulnerabilitiesCount”: 303, “createdTimestamp”: 370470572, “createdByUser”: {“id”: 271, “customerID”: 533, “userName”: “anthony94”, “name”: “Karen Rose”}, “lastUpdatedTimestamp”: 679484395, “lastUpdatedByUser”: {“id”: 205, “customerID”: 140, “userName”: “ccobb”, “name”: “Timothy Jackson”}, “deletedTimestamp”: 1098419185, “deletedByUser”: {“id”: 24, “customerID”: 117, “userName”: “stoutangela”, “name”: “Daniel Lara”}, “flags”: [“MISSING_FROM_CVM”], “properties”: {“additionalProperties”: “Recent keep team particularly sister.”}, “businessProcesses”: [{“id”: “Glass gas life.”, “name”: “Mr. Jeffrey Hudson”}], “hosts”: [{“id”: “Change big consumer whom forget.”, “name”: “Jesse Garner”}]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “News occur surface.”, “messageTemplate”: “Learn sport boy kitchen pretty human.”, “field”: “Marriage try discuss thought away.”, “parameter”: {}, “timestamp”: 67308549}], “currentPage”: 691, “size”: 401}

api.assets.v1.service.update_service_asset(id: str, ownerID: int = None, name: str = None, description: str = None, addProperties: dict = None, deleteProperties: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Updates an existing ServiceAsset. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – ServiceAsset ID
  • ownerID (int) – Change user who owns the asset.
  • name (str) – Change name of asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • description (str) – Change description of asset. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • addProperties (dict) – Add custom properties (updates a property if key already exists). => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • deleteProperties (list) – Delete custom properties by key.
Raises:
Returns:

{“offset”: 706, “limit”: 544, “responseCode”: 200, “count”: 4, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Thus woman cold like production management.”, “messageTemplate”: “Consider follow picture by word sort.”, “field”: “Material start Republican rest yard according policy.”, “parameter”: {}, “timestamp”: 141048487}], “currentPage”: 941, “size”: 782}

api.assets.v1.vulnerability module

Autogenerated API

api.assets.v1.vulnerability.add_asset_vulnerability(hostID: str = None, vulnerabilityID: str = None, references: list = None, name: str = None, description: str = None, conclusion: str = None, solution: str = None, rawOutput: str = None, cvss: int = None, severity: str = None, properties: dict = None, socket: str = None, source: str = 'USER', exploitAvailable: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Creates a new AssetVulnerability. (PUBLIC)

Return type:

dict

Parameters:
  • hostID (str) – Specify parent host.
  • vulnerabilityID (str) – Identifier of vulnerability (e.g. plug-in ID from vulnerability scanner). => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • references (list) – References to vulnerability (e.g. CVE number).
  • name (str) – Name of vulnerability. Will be sanitized and no line break allowed.
  • description (str) – Description of vulnerability. Will be sanitized.
  • conclusion (str) – Short summary of vulnerability. Will be sanitized.
  • solution (str) – How to fix vulnerability. Will be sanitized.
  • rawOutput (str) – Raw output from vulnerability scan. Will be sanitized.
  • cvss (int) – CVSS score of vulnerability (range from 0 to 10).
  • severity (str) – Severity level of vulnerability.
  • properties (dict) – Custom user-defined properties. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • socket (str) – Specify socket string of the vulnerability (e.g. tcp/80), or omit if not bound to a socket.
  • source (str) – Source of the request. (default USER)
  • exploitAvailable (bool) – Set if an exploit is available for the vulnerability.
Raises:
Returns:

{“offset”: 392, “limit”: 353, “responseCode”: 200, “count”: 145, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Take several owner take bank social.”, “messageTemplate”: “Trip whether cut point sound study.”, “field”: “Staff field quickly.”, “parameter”: {}, “timestamp”: 510677213}], “currentPage”: 157, “size”: 22}

api.assets.v1.vulnerability.delete_asset_vulnerability(id: str, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Marks an AssetVulnerability as deleted. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – AssetVulnerability ID
  • source (str) – Request source (default USER)
Raises:
Returns:

{“offset”: 744, “limit”: 64, “responseCode”: 200, “count”: 270, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Recognize series even.”, “messageTemplate”: “Item specific herself base number different cup.”, “field”: “Cut must play with take cup sure law.”, “parameter”: {}, “timestamp”: 954690956}], “currentPage”: 889, “size”: 132}

api.assets.v1.vulnerability.get_asset_vulnerability(id: str, includeRawOutput: bool = 'True', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns an AssetVulnerability identified by its ID. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – AssetVulnerability ID
  • includeRawOutput (bool) – Include raw output
Raises:
Returns:

{“offset”: 55, “limit”: 12, “responseCode”: 200, “count”: 218, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Man technology professional certainly.”, “messageTemplate”: “Lawyer white stand data.”, “field”: “Well soon I college.”, “parameter”: {}, “timestamp”: 1452925468}], “currentPage”: 56, “size”: 47}

api.assets.v1.vulnerability.resolve_asset_vulnerability(id: str, resolution: str = None, comment: str = None, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Resolves an AssetVulnerability. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – AssetVulnerability ID
  • resolution (str) – Specify resolution reason.
  • comment (str) – Comment on why the vulnerability is resolved. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • source (str) – Source of the request. (default USER)
Raises:
Returns:

{“offset”: 12, “limit”: 604, “responseCode”: 200, “count”: 351, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Country for eight add set fill.”, “messageTemplate”: “Manager one others dark.”, “field”: “Operation your poor.”, “parameter”: {}, “timestamp”: 908394046}], “currentPage”: 422, “size”: 756}

api.assets.v1.vulnerability.search_asset_vulnerabilities(limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, name: list = None, startTimestamp: int = None, endTimestamp: int = None, keywords: list = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, hostID: list = None, serviceID: list = None, businessProcessID: list = None, ipRange: list = None, applicationPort: list = None, applicationProtocol: list = None, cpe: list = None, hostCPE: list = None, applicationCPE: list = None, minimumCvss: int = None, maximumCvss: int = None, severity: list = None, resolutionCode: list = None, vulnerabilityReference: list = None, vulnerabilityID: list = None, timeFieldStrategy: list = None, keywordFieldStrategy: list = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', includeRawOutput: bool = 'False', includeConclusion: bool = 'False', includeSolution: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a set of AssetVulnerabilities defined by an AssetVulnerabilitySearchCriteria. (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • name (list) – Restrict search to specific asset name
  • startTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).
  • endTimestamp (int) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).
  • keywords (list) – Search for keywords.
  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).
  • timeMatchStrategy (str) – Defines how strict to match against different timestamps (all/any) using start and end timestamp (default any)
  • hostID (list) – Restrict search to specific host UUIDs.
  • serviceID (list) – Restrict search to specific service UUIDs.
  • businessProcessID (list) – Restrict search to specific business process UUIDs.
  • ipRange (list) – Restrict search to entities related to these IP-addresses (may specify single IPs, IP networks or IP ranges.
  • applicationPort (list) – Restrict to applications listening on specific ports.
  • applicationProtocol (list) – Restrict to applications by transport protocol name.
  • cpe (list) – Restrict to applications or hosts by CPE.
  • hostCPE (list) – Restrict to hosts by CPE.
  • applicationCPE (list) – Restrict to applications by CPE.
  • minimumCvss (int) – Restrict search to vulnerabilities with CVSS score at least this high.
  • maximumCvss (int) – Restrict search to vulnerabilities with CVSS score no more than this.
  • severity (list) – Restrict search to specified severity levels.
  • resolutionCode (list) – Restrict search to specific resolution codes.
  • vulnerabilityReference (list) – Restrict to vulnerabilities identified by vulnerability reference.
  • vulnerabilityID (list) – Restrict to vulnerabilities identified by vulnerability ID.
  • timeFieldStrategy (list) – Defines which timestamps will be included in the search (default lastUpdatedTimestamp).
  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • includeFlags (list) – Only include objects which have includeFlags set.
  • excludeFlags (list) – Exclude objects which have excludeFlags set.
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
  • includeRawOutput (bool) – Include vulnerability rawOutput in result (default false)
  • includeConclusion (bool) – Include vulnerability conclusion in result (default false)
  • includeSolution (bool) – Include vulnerability solution in result (default false)
Raises:
Returns:

{“offset”: 225, “limit”: 171, “responseCode”: 200, “count”: 983, “data”: [{“id”: “Cell dinner student responsibility feel may.”, “vulnerabilityID”: “Son city player listen manage.”, “references”: [“Away effort machine.”], “name”: “Angela Leon”, “description”: “Cup dinner who young cover break tell.”, “conclusion”: “Open issue responsibility.”, “solution”: “Industry science clearly left usually market.”, “rawOutput”: “Expect minute bank always more future.”, “cvss”: 404, “createdTimestamp”: 1199943350, “createdByUser”: {“id”: 48, “customerID”: 904, “userName”: “gonzalezbrian”, “name”: “Robert Perez”}, “lastUpdatedTimestamp”: 634471907, “lastUpdatedByUser”: {“id”: 774, “customerID”: 582, “userName”: “abigail85”, “name”: “Adam Adams”}, “deletedTimestamp”: 495336356, “deletedByUser”: {“id”: 58, “customerID”: 270, “userName”: “ricejacob”, “name”: “Sean Chang”}, “firstSeenTimestamp”: 1002308667, “lastSeenTimestamp”: 262746297, “resolutionTimestamp”: 399046603, “resolvedByUser”: {“id”: 71, “customerID”: 882, “userName”: “harrisonchelsea”, “name”: “Jacob Crawford”}, “resolutionComment”: “Recognize paper standard young.”, “resolution”: “UNRESOLVED”, “flags”: [“DELETED_FROM_CVM”], “properties”: {“additionalProperties”: “Environment southern beautiful science almost control provide.”}, “severity”: “low”, “socket”: “Show practice century receive give heavy agree.”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Bar able note couple bar training small.”, “messageTemplate”: “Whose change huge small also that.”, “field”: “Tonight team beyond particular trade.”, “parameter”: {}, “timestamp”: 588716206}], “currentPage”: 452, “size”: 986}

api.assets.v1.vulnerability.search_asset_vulnerabilities_simplified(keywords: list = None, keywordField: list = None, name: list = None, hostID: list = None, serviceID: list = None, businessProcessID: list = None, customerID: list = None, ip: list = None, port: list = None, protocol: list = None, cpe: list = None, vulnID: list = None, vulnRef: list = None, resolutionCode: list = None, includeFlag: list = None, excludeFlag: list = None, sortBy: list = None, offset: int = 0, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns as set of AssetVulnerabilities defined by query parameters. (PUBLIC)

Return type:

dict

Parameters:
  • keywords (list) – Search by keywords
  • keywordField (list) – Set field strategy for keyword search
  • name (list) – Search by name
  • hostID (list) – Search by HostAsset ID
  • serviceID (list) – Search by ServiceAsset ID
  • businessProcessID (list) – Search by BusinessProcess ID
  • customerID (list) – Search by customer ID
  • ip (list) – Search by IP range
  • port (list) – Search by application port
  • protocol (list) – Search by application protocol
  • cpe (list) – Search by CPE
  • vulnID (list) – Search by vulnerability ID
  • vulnRef (list) – Search by vulnerability reference
  • resolutionCode (list) – Search by resolution code
  • includeFlag (list) – Include certain BusinessProcesses in the search result based on set flags
  • excludeFlag (list) – Exclude certain BusinessProcesses from the search result based on set flags
  • sortBy (list) – Sort search result
  • offset (int) – Skip a number of results
  • limit (int) – Maximum number of returned results
  • keywordMatch (str) – Set match strategy for keyword search
Raises:
Returns:

{“offset”: 902, “limit”: 5, “responseCode”: 200, “count”: 851, “data”: [{“id”: “Why so I already property particularly building.”, “vulnerabilityID”: “Call letter deep.”, “references”: [“Federal whole floor yourself happy wish.”], “name”: “Heather Keller”, “description”: “Industry anyone check this.”, “conclusion”: “Beyond mother wear.”, “solution”: “Thus human chair song side.”, “rawOutput”: “Tend Democrat capital box.”, “cvss”: 776, “createdTimestamp”: 311738026, “createdByUser”: {“id”: 943, “customerID”: 54, “userName”: “awilliams”, “name”: “Briana Cowan”}, “lastUpdatedTimestamp”: 1004649568, “lastUpdatedByUser”: {“id”: 147, “customerID”: 442, “userName”: “paula52”, “name”: “Christopher Nelson”}, “deletedTimestamp”: 459528365, “deletedByUser”: {“id”: 609, “customerID”: 582, “userName”: “ndorsey”, “name”: “Taylor Kaufman”}, “firstSeenTimestamp”: 387528530, “lastSeenTimestamp”: 713223532, “resolutionTimestamp”: 1072410376, “resolvedByUser”: {“id”: 16, “customerID”: 545, “userName”: “saralong”, “name”: “Brian Stokes”}, “resolutionComment”: “Popular safe leg moment range rate.”, “resolution”: “ACCEPTED”, “flags”: [“EXPLOIT_AVAILABLE”], “properties”: {“additionalProperties”: “Through factor side lead.”}, “severity”: “critical”, “socket”: “Bit call bag very.”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Central southern well build which letter forget.”, “messageTemplate”: “Church than follow meet second none conference.”, “field”: “Together environment need cut.”, “parameter”: {}, “timestamp”: 1441467868}], “currentPage”: 686, “size”: 5}

api.assets.v1.vulnerability.update_asset_vulnerability(id: str, addReferences: list = None, deleteReferences: list = None, name: str = None, description: str = None, conclusion: str = None, solution: str = None, rawOutput: str = None, cvss: int = None, severity: str = None, addProperties: dict = None, deleteProperties: list = None, source: str = 'USER', exploitAvailable: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Updates an existing AssetVulnerability. (PUBLIC)

Return type:

dict

Parameters:
  • id (str) – AssetVulnerability ID
  • addReferences (list) – Add references to vulnerability (e.g. CVE number).
  • deleteReferences (list) – Delete references from vulnerability.
  • name (str) – Change vulnerability name. Will be sanitized and no line break allowed.
  • description (str) – Change vulnerability description. Will be sanitized.
  • conclusion (str) – Change vulnerability summary. Will be sanitized.
  • solution (str) – Change vulnerability solution. Will be sanitized.
  • rawOutput (str) – Change raw output from vulnerability scan. Will be sanitized.
  • cvss (int) – Change CVSS score of vulnerability (range from 0 to 10).
  • severity (str) – Change severity level of vulnerability.
  • addProperties (dict) – Add custom properties (updates a property if key already exists). => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • deleteProperties (list) – Delete custom properties by key.
  • source (str) – Source of the request. (default USER)
  • exploitAvailable (bool) – Set if an exploit is available for the vulnerability.
Raises:
Returns:

{“offset”: 545, “limit”: 830, “responseCode”: 200, “count”: 740, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Forward traditional from two.”, “messageTemplate”: “Race page discuss you.”, “field”: “Television information teacher whole push else arm.”, “parameter”: {}, “timestamp”: 104706335}], “currentPage”: 55, “size”: 6}

Module contents