Retrieve sites

This operation returns an object containing information about sites to which the current user has access.

Query Params
int32

Retrieve sites based on Site ID.

int32

Retrieve all accessible sites that are associated with the Client ID given. Equivalent to 'query_client_id'.

int32

Retrieve sites assigned to the Group ID given. NOTE: Group IDs are client-specific. If no client_id is given along with this parameter, the user's native client is assumed.

string

DEPRECATED. Retrieve sites that match the given date, which represents the date the scanning of the site was activated. Requires a date format string. EXAMPLE: 'YYYY-MM-DD hh:mm:ss' -> '2012-10-19 10:23:54'

string
enum
Defaults to 0

Administrative approval refers to things such as service contracts being signed or payment approval. Use a value of 0 to retrieve sites that lack administrative approval, 1 for sites that have approval.

Allowed:
string
enum
Defaults to 0

The term 'active_consult' refers to decisions made by TRC in the operation of scanning or evaluating a site. This is used to disable scans when there are technical issues. Use a value of 0 to retrieve disabled sites, 1 to retrieve enabled sites.

Allowed:
string
enum
Defaults to 0

The term 'active_user' refers to the customer's approval of the site being scanned. This is used by Customer Support to disable scans at the customer's request. Use a value of 0 to retrieve disabled sites, 1 to retrieve enabled sites.

Allowed:
int32

Retrieve all accessible sites that are associated with the Client ID given. Equivalent to the 'client_id' parameter.

string

The date the site was created / added to the list of sites scanned. Must be in epoch-seconds.

int32

Retrieve sites based on the Instance ID of the current scan.

string

Retrieve sites that have descriptions exactly matching the given text (case-sensitive).

string
enum
Defaults to 0

A value of 0 (or 'false') will retrieve sites which do not use credentials for scanning; a value of 1 (or 'true') retrieves sites which do require credentials.

Allowed:
string
enum
Defaults to 0

A value of 0 (or ''false'') will retrieve sites which have Business Logic Assessment (BLA) credentials disabled; a value of 1 (or ''true'') retrieves sites which have BLA creds enabled.

Allowed:
int32

Retrieve sites matching the global rank rating. Global rank rates the security of a site compared to other sites under WhiteHat service. Range is between 1 and 100.

string

Retrieve sites matching the industry rank rating. Market rank rates the security of a site compared to other sites under WhiteHat service that are in the same industry. Range is between 1 and 100.

string
enum
Defaults to Accommodation and Food Services

Retrieve sites based on the vertical market they belong to.

string

Retrieve sites with labels matching all or part of the string given (case-insensitive).

string

Retrieve sites with labels that do NOT match any part of the string given (case-insensitive).

string
enum
Defaults to 0

Indicates whether this site is scanned through a satellite device (for internal intranet and development sites). A value of 0 retrieves sites not being scanned via a satellite device, a value of 1 retrieves sites that are using a satellite device.

Allowed:
int32

Retrieve sites based on the satellite device ID given.

string

Retrieve sites based on the date that the scanning credentials were last updated. Must be in epoch-seconds.

string

Retrieve sites that have a scan schedule name that exactly matches what is given (case-sensitive).

string

Retrieve sites that have scan schedule names matching all or part of the name given (case-insensitive).

string

Retrieve sites based on their scan schedule timezone. EXAMPLE: 'America/New_York'

string
enum
Defaults to 0

Indicates whether the site is not currently monitored (None = 0), or is monitored by the Premium (PE = 1), Standard (SE = 2), Baseline (BE = 3), or Pre-Launch (PL = 5) Service.

Allowed:
string
enum
Defaults to 0

Retrieves sites based on their Service Type. Only meaningful for sites with the Sentinel Pre-launch (PL) service level. Value mappings: 0 = 'None', 1 = 'Enterprise', 2 = 'Flex'.

Allowed:
string

Retrieve sites that have a base URL matching all or part of the string given (case-insensitive).

string

Accepts any positive decimal (real) number (representing seconds). The scanning speed, measured by the request delay, in seconds. EXAMPLES: 1, 0.5, 0.25, 0

string

Retrieve sites that have the Vulnerability Policy with the ID given.

int32

Retrieve sites with the given weight (priority level). Range: 1 to 10. Weight represents a site's priority level.

string

Retrieve sites based on Custom Asset ID that contains or matches what is given.

string

Retrieve sites based on Asset Owner that contains or matches the given username.

string
enum
Defaults to active

Retrieve sites based on whether they are fully approved for scanning or not.

Allowed:
string
enum
Defaults to 1

A meta-parameter which exposes all of the properties which may be exposed by display parameters. This parameter has the highest precedence, so if it is given, other display parameters are redundant, with two exceptions (display_connection_status, display_connection_history).

Allowed:
string
enum
Defaults to 0

A meta-parameter which exposes only the label and id properties of each site retrieved if set. This parameter has the lowest precedence, so other display parameters may be used to expose specific properties. NOTE: If this parameter is set to '0', more basic site properties are exposed, but not as many as would be if 'display_all' is set.

Allowed:
string
enum
Defaults to 0

Display a list of scan related indicators for each site retrieved. These flags indicate whether scans are running properly and whether user action is required to make scans run.

Allowed:
string
enum
Defaults to 0

Display the list of groups to which each retrieved site belongs.

Allowed:
string
enum
Defaults to 0

Display basic information on the first completed, last completed, and current scans for each site retrieved.

Allowed:
string
enum
Defaults to 0
Allowed:
string
enum
Defaults to 0
Allowed:
string
enum
Defaults to 0

Display aggregate statistics about the vulns for each site retrieved.

Allowed:
string
enum
Defaults to 0

Display 'vuln_policy' as an object property of the Site resource. Refers to the Vulnerability Policy currently applied to the site.

Allowed:
string
enum
Defaults to 0

Display 'assessment_complete' as a boolean property of the Site resource. Indicates whether the first full assessment has been completed on the site. A false value indicates that either scanning or evaluation of outstanding vulnerabilities is incomplete.

Allowed:
string
enum
Defaults to 0

Display the date that the first full assessment completed on the site. This value will be NULL if the assessment is not complete.

Allowed:
string
enum
Defaults to 0

Display contract information for each site retrieved, useful for renewal processes.

Allowed:
string
enum
Defaults to 0

Display the customer organization (client name) affiliated with each site retrieved.

Allowed:
string
enum
Defaults to 0

Entry points are starting point URLs for scan crawling. Setting this option will include a list of entry points as a property of the Site resource.

Allowed:
string
enum
Defaults to 0

Display request content for POST entry points for each site retrieved.

Allowed:
string
enum
Defaults to 0

Display a list of site credentials which may be used to log into the site under test. These are represented in plain text in order to allow for automated processes. Passwords are not displayed, but it is recommended that sensitive credentials not be used for this purpose.

Allowed:
string
enum
Defaults to 0

Display a list of allowed hosts as a property of the Site resource. Allowed hosts are hosts other than the site_url which are allowed be scanned as a part of a Site.

Allowed:
string
enum
Defaults to 0

Display the scan schedule which indicates when automated scanning will take place.

Allowed:
string
enum
Defaults to 0

Display Service Type information. Only meaningful for sites with the Sentinel Pre-launch (PL) service level.

Allowed:
string
enum
Defaults to 0

Display the site description for each site retrieved.

Allowed:
string
enum
Defaults to 0

Display the tags for each site retrieved.

Allowed:
string
enum
Defaults to 0

Display the custom asset ID for sites retrieved.

Allowed:
string
enum
Defaults to 0

Display the asset owner name for sites retrieved.

Allowed:
string
enum
Defaults to 0

Display the site's phase of development (Production, QA, etc.).

Allowed:
string
enum
Defaults to 0

Display WhiteHat Security Index (WSI) information for sites retrieved.

Allowed:
string
enum
Defaults to 0

Display details about the site's connection status. NOTE: This data will not appear unless: a) This flag is set, at least one scan has been attempted on the site, and the site was offline during the scan, or b) the site's login handler was invalid during the scan (scanner was unable to successfully log into the site).

Allowed:
string
enum
Defaults to 0

Display a list of all connection status objects (see above) for the site. NOTE: This data will not appear unless: a) This flag is set, at least one scan has been attempted on the site, and the site was offline during a scan, or b) the site's login handler was invalid during a scan (scanner was unable to successfully log into the site).

Allowed:
string
enum
Defaults to 0

Display the details of Access Issues reported by the TRC. If a site has one or more access issues reported, the following details will be displayed. 1)Hostname, 2)Access Issue, 3)Issue Prevents, 4)Issue Reported - datetime the issue was created, 5)Last Checked - datetime the issue was last checked, 6)Test Request, 7)TRC Note.

Allowed:
int32

Limit results to n number of sites.

int32

Begin showing results from site number n.

string
enum
Defaults to id

Order the results.

string
enum
Defaults to xml

The response representation format for results.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

BadRequestResponse indicates a request with invalid parameters.

401

UnauthorizedResponse signals an unauthorized API access.

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized.

500

GenericError generic error.

Language
Response
Choose an example:
application/json
application/xml
text/csv, text/comma-separated-values