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 = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 26, ‘limit’: 756, ‘responseCode’: 200, ‘count’: 123, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Some child religious bring.’, ‘messageTemplate’: ‘Help office relate work.’, ‘field’: ‘Top long ready.’, ‘parameter’: {}, ‘timestamp’: 797908805}], ‘currentPage’: 635, ‘size’: 625}
-
api.assets.v1.application.
delete_host_application
(id: str, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 560, ‘limit’: 879, ‘responseCode’: 200, ‘count’: 939, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Day should positive down.’, ‘messageTemplate’: ‘Even world allow.’, ‘field’: ‘Approach smile growth cup including.’, ‘parameter’: {}, ‘timestamp’: 1045571173}], ‘currentPage’: 466, ‘size’: 751}
-
api.assets.v1.application.
get_host_application
(id: str, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Returns a HostApplication identified by its ID. (PUBLIC)
Return type: dict
Parameters: id (str) – HostApplication ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 213, ‘limit’: 259, ‘responseCode’: 200, ‘count’: 768, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Raise within late success direction above ground.’, ‘messageTemplate’: ‘Rule develop experience hundred month language process.’, ‘field’: ‘Out upon machine best avoid seek.’, ‘parameter’: {}, ‘timestamp’: 1227891280}], ‘currentPage’: 121, ‘size’: 8}
-
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 = None, exclude: bool = None, required: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 185, ‘limit’: 567, ‘responseCode’: 200, ‘count’: 44, ‘data’: [{‘id’: ‘Son none until describe executive.’, ‘name’: ‘Victor Maddox’, ‘description’: ‘Compare eye director news sport speak.’, ‘createdTimestamp’: 1213233160, ‘createdByUser’: {‘id’: 977, ‘customerID’: 57, ‘userName’: ‘stacy67’, ‘name’: ‘Andrea Gilmore’}, ‘lastUpdatedTimestamp’: 1251655643, ‘lastUpdatedByUser’: {‘id’: 86, ‘customerID’: 306, ‘userName’: ‘murraynicholas’, ‘name’: ‘Joseph Mcfarland’}, ‘deletedTimestamp’: 1456665283, ‘deletedByUser’: {‘id’: 358, ‘customerID’: 482, ‘userName’: ‘aprilmurphy’, ‘name’: ‘John Evans’}, ‘firstSeenTimestamp’: 1322274051, ‘lastSeenTimestamp’: 399868866, ‘flags’: [‘DELETED’], ‘properties’: {‘additionalProperties’: ‘Majority practice recently green nation kid billion surface.’}, ‘cpe’: ‘Modern here research blue I particularly.’, ‘sockets’: [‘Compare bill believe once institution keep picture paper.’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Practice clear rate throughout up woman future.’, ‘messageTemplate’: ‘Better alone customer bed.’, ‘field’: ‘Clearly finish best front.’, ‘parameter’: {}, ‘timestamp’: 646337360}], ‘currentPage’: 240, ‘size’: 483}
-
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 = None, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 708, ‘limit’: 990, ‘responseCode’: 200, ‘count’: 475, ‘data’: [{‘id’: ‘Term born which reduce protect summer light.’, ‘name’: ‘Margaret Stewart’, ‘description’: ‘Just house technology fine Mrs model that.’, ‘createdTimestamp’: 13521781, ‘createdByUser’: {‘id’: 402, ‘customerID’: 827, ‘userName’: ‘drivera’, ‘name’: ‘Mr. David Hayes’}, ‘lastUpdatedTimestamp’: 961591499, ‘lastUpdatedByUser’: {‘id’: 798, ‘customerID’: 36, ‘userName’: ‘xevans’, ‘name’: ‘Andrew Moore’}, ‘deletedTimestamp’: 1152336353, ‘deletedByUser’: {‘id’: 684, ‘customerID’: 234, ‘userName’: ‘freemanalexandra’, ‘name’: ‘Timothy Brewer’}, ‘firstSeenTimestamp’: 399057352, ‘lastSeenTimestamp’: 1051454878, ‘flags’: [‘MISSING_FROM_CVM’], ‘properties’: {‘additionalProperties’: ‘Develop movie each police reduce.’}, ‘cpe’: ‘Physical bag figure rest back.’, ‘sockets’: [‘She beautiful particular.’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘However show end design bill.’, ‘messageTemplate’: ‘Tough move piece perform.’, ‘field’: ‘None or cultural special they.’, ‘parameter’: {}, ‘timestamp’: 717860410}], ‘currentPage’: 250, ‘size’: 975}
-
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 = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 557, ‘limit’: 328, ‘responseCode’: 200, ‘count’: 820, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘You during contain edge.’, ‘messageTemplate’: ‘Somebody six power difference.’, ‘field’: ‘Newspaper oil help policy certain thank.’, ‘parameter’: {}, ‘timestamp’: 242948508}], ‘currentPage’: 164, ‘size’: 192}
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 = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 82, ‘limit’: 796, ‘responseCode’: 200, ‘count’: 169, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Perhaps one blue recently large painting share.’, ‘messageTemplate’: ‘Good include clearly across his necessary.’, ‘field’: ‘Economy wait house customer house agency step hit.’, ‘parameter’: {}, ‘timestamp’: 795263761}], ‘currentPage’: 105, ‘size’: 1}
-
api.assets.v1.businessprocess.
attach_services_to_business_process
(id: str, serviceAssetIDs: list = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 948, ‘limit’: 138, ‘responseCode’: 200, ‘count’: 707, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Address future forget mean statement wide.’, ‘messageTemplate’: ‘Friend current girl now good write.’, ‘field’: ‘Huge common reality adult each similar dream.’, ‘parameter’: {}, ‘timestamp’: 26894963}], ‘currentPage’: 897, ‘size’: 798}
-
api.assets.v1.businessprocess.
delete_business_process
(id: str, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Marks a BusinessProcess as deleted. (PUBLIC)
Return type: dict
Parameters: id (str) – BusinessProcess ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 484, ‘limit’: 226, ‘responseCode’: 200, ‘count’: 689, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Skin possible address perform along catch.’, ‘messageTemplate’: ‘Laugh cause goal write probably concern everybody call.’, ‘field’: ‘Wait finally rule drive something.’, ‘parameter’: {}, ‘timestamp’: 107422083}], ‘currentPage’: 245, ‘size’: 769}
-
api.assets.v1.businessprocess.
detach_services_from_business_process
(id: str, serviceAssetIDs: list = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 493, ‘limit’: 218, ‘responseCode’: 200, ‘count’: 654, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Cost another enjoy everything.’, ‘messageTemplate’: ‘Receive wait adult business develop.’, ‘field’: ‘Particularly time television whom fish hour black.’, ‘parameter’: {}, ‘timestamp’: 278456612}], ‘currentPage’: 756, ‘size’: 7}
-
api.assets.v1.businessprocess.
get_business_process
(id: str, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Returns a BusinessProcess identified by its ID. (PUBLIC)
Return type: dict
Parameters: id (str) – BusinessProcess ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 173, ‘limit’: 349, ‘responseCode’: 200, ‘count’: 22, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Prepare drug Democrat indicate radio already yeah.’, ‘messageTemplate’: ‘Left sort ever.’, ‘field’: ‘Become reach bring popular spring song.’, ‘parameter’: {}, ‘timestamp’: 967943549}], ‘currentPage’: 809, ‘size’: 593}
-
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 = None, exclude: bool = None, required: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 66, ‘limit’: 9, ‘responseCode’: 200, ‘count’: 784, ‘data’: [{‘id’: ‘Million adult letter.’, ‘ownedByUser’: {‘id’: 116, ‘customerID’: 899, ‘userName’: ‘jcastillo’, ‘name’: ‘Erin Cortez’}, ‘name’: ‘Michael White’, ‘description’: ‘Safe media positive teach carry trade mission.’, ‘totalCvss’: 197, ‘vulnerabilitiesCount’: 342, ‘createdTimestamp’: 19493434, ‘createdByUser’: {‘id’: 13, ‘customerID’: 576, ‘userName’: ‘arielgray’, ‘name’: ‘Brian Moore’}, ‘lastUpdatedTimestamp’: 370430488, ‘lastUpdatedByUser’: {‘id’: 80, ‘customerID’: 984, ‘userName’: ‘michaelrogers’, ‘name’: ‘Allison Barnett’}, ‘deletedTimestamp’: 1171037128, ‘deletedByUser’: {‘id’: 297, ‘customerID’: 969, ‘userName’: ‘amywhite’, ‘name’: ‘Melanie Scott’}, ‘flags’: [‘UPDATED_BY_CVM’], ‘properties’: {‘additionalProperties’: ‘Situation citizen raise win.’}, ‘services’: [{‘id’: ‘Staff front culture all thank.’, ‘name’: ‘Tiffany Smith’}]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Message interview source choice management way film indeed.’, ‘messageTemplate’: ‘College another serve.’, ‘field’: ‘Work admit food compare work look admit.’, ‘parameter’: {}, ‘timestamp’: 666433496}], ‘currentPage’: 506, ‘size’: 906}
-
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 = None, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 956, ‘limit’: 676, ‘responseCode’: 200, ‘count’: 67, ‘data’: [{‘id’: ‘Indicate analysis write throw you.’, ‘ownedByUser’: {‘id’: 319, ‘customerID’: 819, ‘userName’: ‘robertsonjoseph’, ‘name’: ‘Joann Roman’}, ‘name’: ‘Austin Perez’, ‘description’: ‘Region type put either.’, ‘totalCvss’: 872, ‘vulnerabilitiesCount’: 311, ‘createdTimestamp’: 289754888, ‘createdByUser’: {‘id’: 772, ‘customerID’: 20, ‘userName’: ‘christopherray’, ‘name’: ‘Jennifer Rivers’}, ‘lastUpdatedTimestamp’: 1115029464, ‘lastUpdatedByUser’: {‘id’: 236, ‘customerID’: 994, ‘userName’: ‘adavis’, ‘name’: ‘Russell Brown’}, ‘deletedTimestamp’: 1127524477, ‘deletedByUser’: {‘id’: 290, ‘customerID’: 328, ‘userName’: ‘nevans’, ‘name’: ‘Alyssa Lamb’}, ‘flags’: [‘UPDATED_BY_CVM’], ‘properties’: {‘additionalProperties’: ‘As television public child.’}, ‘services’: [{‘id’: ‘Three tell receive certain end cover involve.’, ‘name’: ‘Molly Gomez’}]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘View know how director part really.’, ‘messageTemplate’: ‘Where wish official tax chance discover later month.’, ‘field’: ‘Sometimes us reduce inside.’, ‘parameter’: {}, ‘timestamp’: 1257810207}], ‘currentPage’: 589, ‘size’: 787}
-
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 = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 488, ‘limit’: 865, ‘responseCode’: 200, ‘count’: 632, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Remain end event interest figure pressure.’, ‘messageTemplate’: ‘Represent why available green discussion.’, ‘field’: ‘Kitchen arrive test Mrs page our.’, ‘parameter’: {}, ‘timestamp’: 127033484}], ‘currentPage’: 474, ‘size’: 243}
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 = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 52, ‘limit’: 251, ‘responseCode’: 200, ‘count’: 652, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Agreement able head.’, ‘messageTemplate’: ‘Size voice read actually just interview picture financial.’, ‘field’: ‘Explain right together.’, ‘parameter’: {}, ‘timestamp’: 231690513}], ‘currentPage’: 209, ‘size’: 826}
-
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 = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 997, ‘limit’: 365, ‘responseCode’: 200, ‘count’: 723, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Style cut court their.’, ‘messageTemplate’: ‘Law around woman ok.’, ‘field’: ‘Over field lead test board road.’, ‘parameter’: {}, ‘timestamp’: 374872856}], ‘currentPage’: 372, ‘size’: 363}
-
api.assets.v1.host.
delete_host_asset
(id: str, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 323, ‘limit’: 205, ‘responseCode’: 200, ‘count’: 853, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Black tonight nearly professional physical spring opportunity.’, ‘messageTemplate’: ‘Those understand career prove story.’, ‘field’: ‘Pay skin yes past course process without.’, ‘parameter’: {}, ‘timestamp’: 919979182}], ‘currentPage’: 87, ‘size’: 84}
-
api.assets.v1.host.
get_host_asset
(id: str, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Returns a HostAsset identified by its ID. (PUBLIC)
Return type: dict
Parameters: id (str) – HostAsset ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 62, ‘limit’: 696, ‘responseCode’: 200, ‘count’: 71, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Worker within budget week usually meeting cause.’, ‘messageTemplate’: ‘Woman suddenly between.’, ‘field’: ‘Man radio natural kind.’, ‘parameter’: {}, ‘timestamp’: 1140189263}], ‘currentPage’: 66, ‘size’: 946}
-
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 = None, exclude: bool = None, required: bool = None, includeVulnerabilityRawOutput: bool = None, includeVulnerabilityConclusion: bool = None, includeVulnerabilitySolution: bool = None, includeVulnerabilities: bool = None, includeApplications: bool = None, includeServices: bool = None, connectedToService: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 538, ‘limit’: 281, ‘responseCode’: 200, ‘count’: 821, ‘data’: [{‘id’: ‘Page shoulder cultural relationship great responsibility himself.’, ‘ownedByUser’: {‘id’: 298, ‘customerID’: 455, ‘userName’: ‘aaron86’, ‘name’: ‘Gloria Woods’}, ‘name’: ‘Aaron Hughes’, ‘description’: ‘Economy choice unit.’, ‘totalCvss’: 654, ‘vulnerabilitiesCount’: 897, ‘createdTimestamp’: 672179060, ‘createdByUser’: {‘id’: 425, ‘customerID’: 583, ‘userName’: ‘zponce’, ‘name’: ‘Aaron Johnson’}, ‘lastUpdatedTimestamp’: 314636528, ‘lastUpdatedByUser’: {‘id’: 407, ‘customerID’: 678, ‘userName’: ‘wwolfe’, ‘name’: ‘Maria Phillips’}, ‘deletedTimestamp’: 618587141, ‘deletedByUser’: {‘id’: 248, ‘customerID’: 761, ‘userName’: ‘justin71’, ‘name’: ‘Ms. Shannon Wilson’}, ‘flags’: [‘CREATED_BY_CVM’], ‘properties’: {‘additionalProperties’: ‘Expect perform miss.’}, ‘firstSeenTimestamp’: 1265030626, ‘lastSeenTimestamp’: 1154042419, ‘lastScanTimestamp’: 1461106155, ‘ipAddresses’: [{‘host’: False, ‘maskBits’: 375, ‘ipv6’: True, ‘multicast’: False, ‘public’: False, ‘address’: ‘Operation major technology seat stay lose.’}], ‘aliases’: [{‘fqdn’: ‘Nothing hand pressure friend need.’}], ‘services’: [{‘id’: ‘Likely school produce indicate.’, ‘name’: ‘Marcia Martinez’}], ‘applications’: [{‘id’: ‘Try little region career moment blue reality price.’, ‘name’: ‘Raymond Rush’, ‘description’: ‘Improve seem me individual.’, ‘createdTimestamp’: 198237260, ‘lastUpdatedTimestamp’: 1294782591, ‘deletedTimestamp’: 576509307, ‘firstSeenTimestamp’: 137337230, ‘lastSeenTimestamp’: 1500240908, ‘flags’: [‘UPDATED_BY_CVM’], ‘properties’: {‘additionalProperties’: ‘Radio building order identify everyone over policy.’}, ‘cpe’: ‘Attorney foot like company.’, ‘sockets’: [‘Various happy none about window.’]}], ‘vulnerabilities’: [{‘id’: ‘Fill human happen particularly body throw.’, ‘vulnerabilityID’: ‘Feeling occur scientist pressure garden for.’, ‘references’: [‘Read card bad imagine.’], ‘name’: ‘Catherine Andrews’, ‘description’: ‘Discuss break chance huge tell.’, ‘conclusion’: ‘Down leader fight simple fund.’, ‘solution’: ‘Arrive light issue write.’, ‘rawOutput’: ‘Conference anything sign beyond build manager.’, ‘cvss’: 582, ‘createdTimestamp’: 729559987, ‘lastUpdatedTimestamp’: 1292555180, ‘deletedTimestamp’: 1323324791, ‘firstSeenTimestamp’: 1288476556, ‘lastSeenTimestamp’: 60099858, ‘resolutionTimestamp’: 904356071, ‘resolutionComment’: ‘Structure opportunity road law against identify.’, ‘resolution’: ‘ACCEPTED’, ‘flags’: [‘MISSING_FROM_CVM’], ‘properties’: {‘additionalProperties’: ‘Night born evidence mother because.’}, ‘severity’: ‘medium’, ‘socket’: ‘Pretty back foreign suffer deal no mouth.’}], ‘operatingSystemCPE’: ‘Since character within professor.’}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Tree reason program approach see think age.’, ‘messageTemplate’: ‘Director practice campaign require discussion.’, ‘field’: ‘Next detail event claim open fight.’, ‘parameter’: {}, ‘timestamp’: 393846466}], ‘currentPage’: 999, ‘size’: 835}
-
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 = None, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 395, ‘limit’: 426, ‘responseCode’: 200, ‘count’: 878, ‘data’: [{‘id’: ‘Those thought former turn least per near.’, ‘ownedByUser’: {‘id’: 166, ‘customerID’: 607, ‘userName’: ‘matthew06’, ‘name’: ‘Nicholas Martinez’}, ‘name’: ‘Taylor Henderson’, ‘description’: ‘Congress record return guess play.’, ‘totalCvss’: 364, ‘vulnerabilitiesCount’: 647, ‘createdTimestamp’: 670655087, ‘createdByUser’: {‘id’: 392, ‘customerID’: 573, ‘userName’: ‘hlee’, ‘name’: ‘Wendy Leonard’}, ‘lastUpdatedTimestamp’: 1276691337, ‘lastUpdatedByUser’: {‘id’: 500, ‘customerID’: 411, ‘userName’: ‘fullerjohn’, ‘name’: ‘Jillian Jensen’}, ‘deletedTimestamp’: 1179079842, ‘deletedByUser’: {‘id’: 361, ‘customerID’: 419, ‘userName’: ‘jonathanbutler’, ‘name’: ‘Jacqueline Ruiz’}, ‘flags’: [‘MISSING_FROM_CVM’], ‘properties’: {‘additionalProperties’: ‘Professional mission account anything we follow.’}, ‘firstSeenTimestamp’: 12933564, ‘lastSeenTimestamp’: 44080731, ‘lastScanTimestamp’: 1508773092, ‘ipAddresses’: [{‘host’: False, ‘maskBits’: 514, ‘ipv6’: True, ‘multicast’: False, ‘public’: True, ‘address’: ‘Son find south tell.’}], ‘aliases’: [{‘fqdn’: ‘Run already oil member floor data.’}], ‘services’: [{‘id’: ‘Respond get party professional region.’, ‘name’: ‘Kathy Harris’}], ‘applications’: [{‘id’: ‘Of reality environment particular.’, ‘name’: ‘Debra Moore’, ‘description’: ‘Thousand religious city care.’, ‘createdTimestamp’: 1473774753, ‘lastUpdatedTimestamp’: 319793551, ‘deletedTimestamp’: 1434276536, ‘firstSeenTimestamp’: 586121112, ‘lastSeenTimestamp’: 221816753, ‘flags’: [‘CONTROLLED_VERSION’], ‘properties’: {‘additionalProperties’: ‘Owner perhaps drop mouth.’}, ‘cpe’: ‘Difficult continue participant financial.’, ‘sockets’: [‘Former enjoy often.’]}], ‘vulnerabilities’: [{‘id’: ‘Allow part occur rise another account.’, ‘vulnerabilityID’: ‘Message shoulder leave campaign.’, ‘references’: [‘Push miss attorney.’], ‘name’: ‘Kevin Leon’, ‘description’: ‘Whatever rest newspaper travel parent source manager.’, ‘conclusion’: ‘Usually now national child cultural indeed.’, ‘solution’: ‘Home reality voice mouth try green war the.’, ‘rawOutput’: ‘Let everyone learn stay.’, ‘cvss’: 969, ‘createdTimestamp’: 1267329465, ‘lastUpdatedTimestamp’: 1151314183, ‘deletedTimestamp’: 1106196342, ‘firstSeenTimestamp’: 65585162, ‘lastSeenTimestamp’: 679906854, ‘resolutionTimestamp’: 847398257, ‘resolutionComment’: ‘End purpose offer run true.’, ‘resolution’: ‘UNRESOLVED’, ‘flags’: [‘DETECTED_BY_CVM’], ‘properties’: {‘additionalProperties’: ‘Morning market list yard base image fact.’}, ‘severity’: ‘info’, ‘socket’: ‘Up head effect of.’}], ‘operatingSystemCPE’: ‘Happen safe question operation feeling.’}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Him world same.’, ‘messageTemplate’: ‘Get realize wait leg spring fish first.’, ‘field’: ‘Collection team difficult after.’, ‘parameter’: {}, ‘timestamp’: 821353051}], ‘currentPage’: 826, ‘size’: 676}
-
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 = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 116, ‘limit’: 485, ‘responseCode’: 200, ‘count’: 544, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Through mention whatever a.’, ‘messageTemplate’: ‘Citizen will describe safe season camera smile.’, ‘field’: ‘Employee audience issue land major compare.’, ‘parameter’: {}, ‘timestamp’: 230211509}], ‘currentPage’: 466, ‘size’: 124}
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 = None, authentication: dict = {}) → dict[source]¶ Marks multiple HostAsset as scanned. (PUBLIC)
Return type: dict
Parameters: Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 680, ‘limit’: 344, ‘responseCode’: 200, ‘count’: 413, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Bit age against.’, ‘messageTemplate’: ‘Sign low wrong college early behavior knowledge.’, ‘field’: ‘Agency think provide detail.’, ‘parameter’: {}, ‘timestamp’: 194216989}], ‘currentPage’: 294, ‘size’: 419}
-
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 = None, authentication: dict = {}) → dict[source]¶ Marks a single HostAsset as scanned. (PUBLIC)
Return type: dict
Parameters: Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 842, ‘limit’: 323, ‘responseCode’: 200, ‘count’: 950, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Short claim why recent her now.’, ‘messageTemplate’: ‘College tough early bed over indeed focus.’, ‘field’: ‘Great simply design sister one.’, ‘parameter’: {}, ‘timestamp’: 281303479}], ‘currentPage’: 505, ‘size’: 646}
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 = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 794, ‘limit’: 86, ‘responseCode’: 200, ‘count’: 386, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Tell hope book ability.’, ‘messageTemplate’: ‘Consider far couple school.’, ‘field’: ‘Reach leader ahead which policy new course.’, ‘parameter’: {}, ‘timestamp’: 92343526}], ‘currentPage’: 26, ‘size’: 465}
-
api.assets.v1.service.
attach_hosts_to_service
(id: str, hostAssetIDs: list = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 205, ‘limit’: 233, ‘responseCode’: 200, ‘count’: 570, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Detail serve one during woman.’, ‘messageTemplate’: ‘Material I wait four Congress stock information sure.’, ‘field’: ‘Option political wide cell field.’, ‘parameter’: {}, ‘timestamp’: 311090907}], ‘currentPage’: 958, ‘size’: 531}
-
api.assets.v1.service.
delete_service_asset
(id: str, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Marks a ServiceAsset as deleted. (PUBLIC)
Return type: dict
Parameters: id (str) – ServiceAsset ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 805, ‘limit’: 198, ‘responseCode’: 200, ‘count’: 985, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Lay everyone forward stand understand most people.’, ‘messageTemplate’: ‘Serve sign Mrs themselves say yet hotel without.’, ‘field’: ‘Million later age theory increase old billion teach.’, ‘parameter’: {}, ‘timestamp’: 509003978}], ‘currentPage’: 411, ‘size’: 677}
-
api.assets.v1.service.
detach_hosts_from_service
(id: str, hostAssetIDs: list = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 887, ‘limit’: 575, ‘responseCode’: 200, ‘count’: 32, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Reveal even since our like line agency.’, ‘messageTemplate’: ‘Speech instead source real size factor education.’, ‘field’: ‘Raise wall their series many difference affect his.’, ‘parameter’: {}, ‘timestamp’: 871427298}], ‘currentPage’: 413, ‘size’: 810}
-
api.assets.v1.service.
get_service_asset
(id: str, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Returns a ServiceAsset identified by its ID. (PUBLIC)
Return type: dict
Parameters: id (str) – ServiceAsset ID
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 29, ‘limit’: 478, ‘responseCode’: 200, ‘count’: 921, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Fear alone answer science such.’, ‘messageTemplate’: ‘Name contain take car.’, ‘field’: ‘Behind behind deal store station.’, ‘parameter’: {}, ‘timestamp’: 1081663281}], ‘currentPage’: 898, ‘size’: 535}
-
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 = None, exclude: bool = None, required: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 95, ‘limit’: 491, ‘responseCode’: 200, ‘count’: 686, ‘data’: [{‘id’: ‘Newspaper continue suggest style church personal society.’, ‘ownedByUser’: {‘id’: 85, ‘customerID’: 504, ‘userName’: ‘cody46’, ‘name’: ‘Kevin Fisher’}, ‘name’: ‘Natalie Williams’, ‘description’: ‘In ready wife gas.’, ‘totalCvss’: 918, ‘vulnerabilitiesCount’: 636, ‘createdTimestamp’: 656530535, ‘createdByUser’: {‘id’: 504, ‘customerID’: 603, ‘userName’: ‘dcooper’, ‘name’: ‘Paul Johnson’}, ‘lastUpdatedTimestamp’: 805470699, ‘lastUpdatedByUser’: {‘id’: 955, ‘customerID’: 118, ‘userName’: ‘christina94’, ‘name’: ‘Kenneth Meyer’}, ‘deletedTimestamp’: 545772314, ‘deletedByUser’: {‘id’: 97, ‘customerID’: 459, ‘userName’: ‘jacksonjames’, ‘name’: ‘Victoria Stone’}, ‘flags’: [‘HAS_HIGH_VULN’], ‘properties’: {‘additionalProperties’: ‘Stay bank her fly certain.’}, ‘businessProcesses’: [{‘id’: ‘Find all character line.’, ‘name’: ‘Christopher Jones’}], ‘hosts’: [{‘id’: ‘Assume plant particular might race term finally.’, ‘name’: ‘Jessica Mccoy’}]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Two provide policy enough.’, ‘messageTemplate’: ‘Audience physical though case left specific audience five.’, ‘field’: ‘However whom collection usually if describe.’, ‘parameter’: {}, ‘timestamp’: 1358404583}], ‘currentPage’: 188, ‘size’: 795}
-
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 = None, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 82, ‘limit’: 934, ‘responseCode’: 200, ‘count’: 170, ‘data’: [{‘id’: ‘Hear debate human never door.’, ‘ownedByUser’: {‘id’: 646, ‘customerID’: 742, ‘userName’: ‘dana25’, ‘name’: ‘Tara Hughes’}, ‘name’: ‘Erin Young’, ‘description’: ‘Computer maybe budget commercial.’, ‘totalCvss’: 759, ‘vulnerabilitiesCount’: 252, ‘createdTimestamp’: 1189980692, ‘createdByUser’: {‘id’: 209, ‘customerID’: 542, ‘userName’: ‘robertsmith’, ‘name’: ‘Shannon Armstrong’}, ‘lastUpdatedTimestamp’: 160376882, ‘lastUpdatedByUser’: {‘id’: 883, ‘customerID’: 60, ‘userName’: ‘zgreen’, ‘name’: ‘Janet Martinez’}, ‘deletedTimestamp’: 263499927, ‘deletedByUser’: {‘id’: 825, ‘customerID’: 798, ‘userName’: ‘ochoaangela’, ‘name’: ‘Angela Gill’}, ‘flags’: [‘MERGED’], ‘properties’: {‘additionalProperties’: ‘Assume little author character city.’}, ‘businessProcesses’: [{‘id’: ‘Set possible administration painting whole be edge.’, ‘name’: ‘Samantha Hinton’}], ‘hosts’: [{‘id’: ‘Machine environment program sense.’, ‘name’: ‘Pamela Mendoza’}]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Region see mind something relate agreement.’, ‘messageTemplate’: ‘Test hold treat wish teacher future.’, ‘field’: ‘Wrong nothing wide.’, ‘parameter’: {}, ‘timestamp’: 849617715}], ‘currentPage’: 30, ‘size’: 2}
-
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 = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 74, ‘limit’: 749, ‘responseCode’: 200, ‘count’: 756, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Product some million food fire enter source wrong.’, ‘messageTemplate’: ‘Pm free you arm less.’, ‘field’: ‘Statement expect move life hospital.’, ‘parameter’: {}, ‘timestamp’: 155860228}], ‘currentPage’: 417, ‘size’: 56}
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 = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 465, ‘limit’: 35, ‘responseCode’: 200, ‘count’: 136, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Course cup while best institution school.’, ‘messageTemplate’: ‘Seven that need movement already.’, ‘field’: ‘Study church staff weight rate.’, ‘parameter’: {}, ‘timestamp’: 582459234}], ‘currentPage’: 348, ‘size’: 845}
-
api.assets.v1.vulnerability.
delete_asset_vulnerability
(id: str, source: str = 'USER', json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 129, ‘limit’: 950, ‘responseCode’: 200, ‘count’: 505, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Spring ability than argue.’, ‘messageTemplate’: ‘Involve modern manage international eye where figure.’, ‘field’: ‘Economic rest society black American especially.’, ‘parameter’: {}, ‘timestamp’: 483796134}], ‘currentPage’: 986, ‘size’: 348}
-
api.assets.v1.vulnerability.
get_asset_vulnerability
(id: str, includeRawOutput: bool = True, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 738, ‘limit’: 938, ‘responseCode’: 200, ‘count’: 723, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘List rule spring their nation power imagine.’, ‘messageTemplate’: ‘Medical develop arrive also.’, ‘field’: ‘Rest tree development find because game million friend.’, ‘parameter’: {}, ‘timestamp’: 1356048050}], ‘currentPage’: 350, ‘size’: 338}
-
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 = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 965, ‘limit’: 372, ‘responseCode’: 200, ‘count’: 687, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Leg it mission sometimes house industry.’, ‘messageTemplate’: ‘Individual commercial movie father couple.’, ‘field’: ‘Film young answer would really nice.’, ‘parameter’: {}, ‘timestamp’: 94311198}], ‘currentPage’: 213, ‘size’: 254}
-
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 = None, exclude: bool = None, required: bool = None, includeRawOutput: bool = None, includeConclusion: bool = None, includeSolution: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 584, ‘limit’: 457, ‘responseCode’: 200, ‘count’: 502, ‘data’: [{‘id’: ‘Hand to few increase.’, ‘vulnerabilityID’: ‘Send region resource.’, ‘references’: [‘Responsibility last painting development.’], ‘name’: ‘Tracey Ramsey’, ‘description’: ‘Power best beyond give.’, ‘conclusion’: ‘Check peace himself smile.’, ‘solution’: ‘Especially product center red.’, ‘rawOutput’: ‘Effect relate picture agree try.’, ‘cvss’: 150, ‘createdTimestamp’: 722909578, ‘createdByUser’: {‘id’: 170, ‘customerID’: 212, ‘userName’: ‘gonzalezbrooke’, ‘name’: ‘Melissa Rios’}, ‘lastUpdatedTimestamp’: 498972145, ‘lastUpdatedByUser’: {‘id’: 182, ‘customerID’: 589, ‘userName’: ‘valerie48’, ‘name’: ‘Michael Melendez’}, ‘deletedTimestamp’: 429684306, ‘deletedByUser’: {‘id’: 327, ‘customerID’: 401, ‘userName’: ‘ematthews’, ‘name’: ‘Stefanie Alexander’}, ‘firstSeenTimestamp’: 1265045693, ‘lastSeenTimestamp’: 1283218948, ‘resolutionTimestamp’: 1316485192, ‘resolvedByUser’: {‘id’: 554, ‘customerID’: 680, ‘userName’: ‘kennethfuentes’, ‘name’: ‘Tammy Clark’}, ‘resolutionComment’: ‘Explain site city art before.’, ‘resolution’: ‘ACCEPTED’, ‘flags’: [‘CREATED_BY_CVM’], ‘properties’: {‘additionalProperties’: ‘Field fall almost cost name.’}, ‘severity’: ‘low’, ‘socket’: ‘Would painting mean better part hard increase.’}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Dream here style of.’, ‘messageTemplate’: ‘Everybody appear many member.’, ‘field’: ‘Ahead face room then couple.’, ‘parameter’: {}, ‘timestamp’: 19078236}], ‘currentPage’: 415, ‘size’: 488}
-
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 = None, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 506, ‘limit’: 51, ‘responseCode’: 200, ‘count’: 370, ‘data’: [{‘id’: ‘Himself respond friend include none.’, ‘vulnerabilityID’: ‘South tell must history coach star stay note.’, ‘references’: [‘Exist anything hold until image might institution.’], ‘name’: ‘Lance Meyer’, ‘description’: ‘Administration wish charge especially next line probably.’, ‘conclusion’: ‘Family phone be tonight art item reality.’, ‘solution’: ‘Feeling these writer interview foot.’, ‘rawOutput’: ‘Truth any serious particularly.’, ‘cvss’: 599, ‘createdTimestamp’: 1190035543, ‘createdByUser’: {‘id’: 189, ‘customerID’: 544, ‘userName’: ‘hlamb’, ‘name’: ‘Shelia Stevens’}, ‘lastUpdatedTimestamp’: 1084189992, ‘lastUpdatedByUser’: {‘id’: 439, ‘customerID’: 159, ‘userName’: ‘nicholas40’, ‘name’: ‘Jessica Hansen’}, ‘deletedTimestamp’: 1323085917, ‘deletedByUser’: {‘id’: 744, ‘customerID’: 156, ‘userName’: ‘amber90’, ‘name’: ‘Stephanie Castro’}, ‘firstSeenTimestamp’: 949607992, ‘lastSeenTimestamp’: 470490943, ‘resolutionTimestamp’: 324881559, ‘resolvedByUser’: {‘id’: 245, ‘customerID’: 465, ‘userName’: ‘mary92’, ‘name’: ‘Robert Hudson’}, ‘resolutionComment’: ‘Day shoulder herself born people ready item only.’, ‘resolution’: ‘SERVICE_NOT_AVAILABLE’, ‘flags’: [‘UPDATED_BY_CVM’], ‘properties’: {‘additionalProperties’: ‘Difficult employee doctor site statement by as option.’}, ‘severity’: ‘critical’, ‘socket’: ‘Surface herself bring seven go provide poor.’}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Improve away window dream control around.’, ‘messageTemplate’: ‘Business culture realize single.’, ‘field’: ‘Wait my official interview hot.’, ‘parameter’: {}, ‘timestamp’: 424757596}], ‘currentPage’: 770, ‘size’: 614}
-
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 = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 284, ‘limit’: 15, ‘responseCode’: 200, ‘count’: 453, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Leave rule may generation exactly accept.’, ‘messageTemplate’: ‘Management record side hospital.’, ‘field’: ‘Certainly similar scene.’, ‘parameter’: {}, ‘timestamp’: 368761509}], ‘currentPage’: 34, ‘size’: 65}