service#

Autogenerated API

argus_api.lib.assets.v1.service.add_service_asset(ownerID: int = None, customerID: int = None, name: str = None, description: str = None, criticality: dict = None, properties: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Creates a new ServiceAsset. (PUBLIC)

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\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • criticality (dict) –

  • properties (dict) – Custom user-defined properties. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.service.attach_hosts_to_service(id: str, hostAssetIDs: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Adds multiple HostAssets to a ServiceAsset. (PUBLIC)

Parameters

  • id (str) – ServiceAsset ID

  • hostAssetIDs (list) – Specify hosts to add to service.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.service.delete_service_asset(id: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Marks a ServiceAsset as deleted. (PUBLIC)

Parameters

  • id (str) – ServiceAsset ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.service.detach_hosts_from_service(id: str, hostAssetIDs: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Removes multiple HostAssets from a ServiceAsset. (PUBLIC)

Parameters

  • id (str) – ServiceAsset ID

  • hostAssetIDs (list) – Specify hosts to detach from service.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.service.get_service_asset(id: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a ServiceAsset identified by its ID. (PUBLIC)

Parameters

  • id (str) – ServiceAsset ID

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.service.search_service_asset_statistics(name: str = None, keywords: str = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, hostID: str = None, serviceID: str = None, businessProcessID: str = None, ipRange: str = None, applicationPort: int = None, applicationProtocol: str = None, cpe: str = None, hostCPE: str = None, applicationCPE: str = None, countTimeout: int = None, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, startTimestamp: str = None, endTimestamp: str = None, ownerID: int = None, criticality: dict = None, minimumTotalCvss: float = None, maximumTotalCvss: float = None, vulnerabilityReference: str = None, vulnerabilityID: str = None, applicationRole: int = None, timeFieldStrategy: str = None, keywordFieldStrategy: str = None, groupBy: str = None, values: str = None, resolution: int = None, cutoff: int = None, cutoffValue: str = None, includeOthers: bool = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch service asset statistics base on criteria (PUBLIC)

Parameters

  • name (list) – Restrict search to specific asset name

  • 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 (str) – 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 (str) – Restrict to applications or hosts by CPE.

  • hostCPE (str) – Restrict to hosts by CPE.

  • applicationCPE (str) – Restrict to applications by CPE.

  • countTimeout (int) – Max wait in seconds for count query, if max wait passed and count query still executing the query; or -1 is set to indicate do not count, then the query will be cancelled and return count -1. Default value 0 means execute as long as service allows, -1 means do not count, max value is 30 (seconds).

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • 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).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • startTimestamp (str) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).

  • endTimestamp (str) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).

  • 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 (float) – Restrict search to a minimum total CVSS score.

  • maximumTotalCvss (float) – 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).

  • groupBy (list) – Specify which fields will be grouped by in stats

  • values (list) – Specify which values will be included in stats (default services)

  • resolution (int) – Stats resolution period in milliseconds, if is 0 means to generate non-timeline statistics

  • cutoff (int) – Reduce stats keys to the cutoff amount of keys that has largest hit count, default 0 means no reduce

  • cutoffValue (str) – Specify which value to be cutoff on (default services)

  • includeOthers (bool) – If reduce (cutoff >0), true means remaining keys (other than cutoff keys) are collected into an “other” key, default false

  • 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.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.assets.v1.service.search_service_assets(name: str = None, keywords: str = None, keywordMatchStrategy: str = None, timeMatchStrategy: str = None, hostID: str = None, serviceID: str = None, businessProcessID: str = None, ipRange: str = None, applicationPort: int = None, applicationProtocol: str = None, cpe: str = None, hostCPE: str = None, applicationCPE: str = None, countTimeout: int = None, limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, startTimestamp: str = None, endTimestamp: str = None, ownerID: int = None, criticality: dict = None, minimumTotalCvss: float = None, maximumTotalCvss: float = None, vulnerabilityReference: str = None, vulnerabilityID: str = None, applicationRole: int = None, timeFieldStrategy: str = None, keywordFieldStrategy: str = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

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

Parameters

  • name (list) – Restrict search to specific asset name

  • 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 (str) – 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 (str) – Restrict to applications or hosts by CPE.

  • hostCPE (str) – Restrict to hosts by CPE.

  • applicationCPE (str) – Restrict to applications by CPE.

  • countTimeout (int) – Max wait in seconds for count query, if max wait passed and count query still executing the query; or -1 is set to indicate do not count, then the query will be cancelled and return count -1. Default value 0 means execute as long as service allows, -1 means do not count, max value is 30 (seconds).

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • 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).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • startTimestamp (str) – Restrict search to a time frame based on the set TimeFieldStrategy (start timestamp).

  • endTimestamp (str) – Restrict search to a time frame based on the set TimeFieldStrategy (end timestamp).

  • 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 (float) – Restrict search to a minimum total CVSS score.

  • maximumTotalCvss (float) – 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.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object or dictionary translated from JSON

argus_api.lib.assets.v1.service.search_service_assets_simplified(keywords: str = None, keywordField: str = None, name: str = None, hostID: str = None, serviceID: str = None, businessProcessID: str = None, customerID: int = None, ip: str = None, port: int = None, protocol: str = None, cpe: str = None, vulnID: str = None, vulnRef: str = None, includeFlag: str = None, excludeFlag: str = None, sortBy: str = None, countTimeout: int = None, limit: int = 25, keywordMatch: str = 'all', offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

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

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

  • countTimeout (int) – Max wait in seconds for count query. Value 0 means execute as long as service allows, -1 means do not count, max value is 30 (seconds).

  • limit (int) – Maximum number of returned results

  • keywordMatch (str) – Set match strategy for keyword search

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object or dictionary translated from JSON

argus_api.lib.assets.v1.service.update_service_asset(id: str, ownerID: int = None, name: str = None, description: str = None, criticality: dict = None, addProperties: dict = None, deleteProperties: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Updates an existing ServiceAsset. (PUBLIC)

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\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • criticality (dict) –

  • addProperties (dict) – Add custom properties (updates a property if key already exists). => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • deleteProperties (list) – Delete custom properties by key.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON