Launch Map

map_title={title}

Optional

Specifies a title for the map. The map title can have a maximum of 2,000 characters. When specified, the map title appears in the header section of the map results. When unspecified, the API returns a standard, descriptive title in the header section.

domain={target}

Optional

Specifies one or more domain names for the map target. Multiple entries are comma separated. (Target may include domain names and/or asset groups)

For each domain, include the domain name only; do not enter “www.” at the start of the domain name. Netblocks may be specified with each domain name to extend the scope of the map. Multiple domains must be comma separated.

This parameter and/or asset_groups must be specified.

asset_groups={title1,title2...}

Optional

Specifies the titles of asset groups for the map target. Multiple asset groups must be comma separated. (Target may include domain names and/or asset groups)

This parameter and/or the domain parameter must be specified.

iscanner_name={name}

Optional

Specifies the name of the Scanner Appliance for the map, when the map target has private use internal IPs. Using Express Lite, Internal Scanning must be enabled in your account.

One of these parameters may be specified in the map request: iscanner_name or default scanner.

default_scanner={0|1}

Optional

Enables the default scanner feature, which is only valid when the map target consists of asset groups. A valid value is 1 to enable the default scanner, or 0 (the default) to disable it. Using Express Lite, Internal Scanning must be enabled in your account.

One of these parameters may be specified in the same map request: iscanner_name or default scanner.

option={title}

Optional

Specifies the title of an option profile to be applied to the map. The profile title must be defined in the user account, and it can have a maximum of 64 characters. If unspecified, the default option profile in the user account is applied.

network_id={value}

Optional, and valid only when the Network Support feature is enabled for the user’s account

Restrict the request to a certain custom network by specifying the network ID. When unspecified, we default to “0” for Global Default Network.

save_report=yes

Optional

Saves a map report for each target domain on the Qualys server for later use. A valid value is “yes” to save a map report for each target domain, or “no” (the default) to not save the report.

If set to “yes”, you can close the HTTP connection when the map is in progress, without cancelling the map. When the map completes the resulting map report is saved on the Qualys platform, and a map summary email notification is sent (if this option is enabled in your user account).