scan#

Autogenerated API

argus_api.lib.assets.v1.scan.client_host_asset_scanned(customerID: int, hostName: str, detectedVulnerabilities: dict = None, detectedApplications: 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#

Marks a single Client HostAsset as scanned. The host is identified by the host name, and it must be of type CLIENT. (INTERNAL)

Parameters

  • customerID (int) – Customer ID

  • hostName (str) – Name of host asset

  • detectedVulnerabilities (list) – Specify (vulnerabilityID, socket string) objects of detected vulnerabilities.

  • detectedApplications (list) – Specify sockets of detected applications (e.g. tcp/80).

  • 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.scan.host_asset_bulk_scanned(customerID: int = None, scannedRequests: dict = None, scannedIpRanges: 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#

Marks multiple HostAsset as scanned. (PUBLIC)

Parameters

  • customerID (int) – Define customer which was scanned.

  • scannedRequests (list) – Set of host scan requests.

  • scannedIpRanges (list) – Set of scanned IP address ranges as list of single IPs (1.1.1.1), CIDR networks (1.1.1.0/24) or ranges (1.1.1.1-1.1.1.2)

  • 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.scan.host_asset_scanned(customerID: int, ip: str, detectedVulnerabilities: dict = None, detectedApplications: 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#

Marks a single HostAsset as scanned. (PUBLIC)

Parameters

  • customerID (int) – Customer ID

  • ip (str) – IP address of scanned HostAsset

  • detectedVulnerabilities (list) – Specify (vulnerabilityID, socket string) objects of detected vulnerabilities.

  • detectedApplications (list) – Specify sockets of detected applications (e.g. tcp/80).

  • 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.scan.host_asset_scanned_by_id(hostID: str, detectedVulnerabilities: dict = None, detectedApplications: 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#

Marks a single HostAsset as scanned. The host is identified by ID. (INTERNAL)

Parameters

  • hostID (str) – ID of the host asset

  • detectedVulnerabilities (list) – Specify (vulnerabilityID, socket string) objects of detected vulnerabilities.

  • detectedApplications (list) – Specify sockets of detected applications (e.g. tcp/80).

  • 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