Retrieve site links found in the most recent scan

get

https://sentinel.whitehatsec.com/api/site/{site_id}/links_found

This operation returns an object containing a list of links found during the current scan (if any) on the given site. If there is no current scan for the site, links for the last completed scan (if any) will be returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

site_id

int32

required

Site ID.

Query Params

query_url_like

string

Retrieves links with URLs matching all or part of the string given. Case-insensitive.

query_reply_code

string

Retrieves links matching the HTTP response code given. EXAMPLE: Giving '404' gets all links that returned a 404 (Not found) during the scan instance.

query_status

string

Retrieves links matching one or more of the following statuses: 'reply', or 'error'. You can combine these in this query by separating with commas. EXAMPLE: query_status=reply,error (fetches links that have statuses of 'reply' or 'error').

query_error

string

enum

Defaults to 1

Retrieves links that have a status of 'error'. The only value allowed for this parameter is 1.

Allowed:

query_state

string

enum

Defaults to offsite

Retrieves links with a state of 'offsite'. Currently this is the only state allowed. PREREQUISITE: Scans must be configured to scan offsite links for this to return anything.

Allowed:

query_tested

string

Combines the 'state' and 'status' queries to retrieve links matching one or more of the following criteria: 'tested' (shown in results as a STATUS of 'reply'), 'error' (shown in results as a STATUS of 'error'), or 'offdomain' (shown in results as a STATE of 'offsite'). You can combine these in this query by separating with commas.

page:limit

int32

Limit results to n number of links per page.

page:offset

int32

Begin showing results from link number n.

page:order_by

string

enum

Defaults to query_url_asc

Sort results.

format

string

enum

Defaults to json

The response representation format for results.

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.

501

Not implemented.

Language

Loading…

Response

Choose an example:

application/json

200Provides the list of links found during the current scan.