Retrieve a site

This operation returns an object containing information about the specified site.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Site ID.

Query Params
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 the site 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 as a property on the Site resource. 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 the site belongs.

Allowed:
string
enum
Defaults to 0

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

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

Display aggregate statistics about the vulns on the site.

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 the site. Useful for renewal processes.

Allowed:
string
enum
Defaults to 0

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

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.

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.

Allowed:
string
enum
Defaults to 0

Display tags associated with the site.

Allowed:
string
enum
Defaults to 0

Display the site's custom asset ID.

Allowed:
string
enum
Defaults to 0

Display the site's asset owner name.

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.

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:
string
enum
Defaults to xml

Selects the requested response representation format.

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
LoadingLoading…
Response
Choose an example:
application/json
application/xml
text/csv, text/comma-separated-values