---
updatedAt: 2026-07-02T14:39:48.000Z
---

# Retrieve site links found during a scan

This operation returns a list of links found during the specified scan instance on the specified site.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "x-explorer-enabled": false,
  "info": {
    "title": "Site API (Legacy)",
    "license": {
      "name": "(c) Copyright 2021 WhiteHat Security"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com"
    }
  ],
  "paths": {
    "/api/site/{site_id}/links_found/{instance_id}": {
      "get": {
        "tags": [
          "Site API v1.0"
        ],
        "summary": "Retrieve site links found during a scan",
        "description": "This operation returns a list of links found during the specified scan instance on the specified site.",
        "operationId": "getSiteScanLinks",
        "parameters": [
          {
            "name": "site_id",
            "in": "path",
            "description": "Site ID.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "instance_id",
            "in": "path",
            "description": "Scan Instance ID.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "query_url_like",
            "in": "query",
            "description": "Retrieves links with URLs matching all or part of the string given. Case-insensitive.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_reply_code",
            "in": "query",
            "description": "Retrieves links matching the HTTP response code given. EXAMPLE: Giving '404' gets all links that returned a 404 (Not found) during the scan instance.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_status",
            "in": "query",
            "description": "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').",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_error",
            "in": "query",
            "description": "Retrieves links that have a status of 'error'. The only value allowed for this parameter is 1.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "1",
              "example": "1",
              "enum": [
                "1"
              ]
            }
          },
          {
            "name": "query_state",
            "in": "query",
            "description": "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.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "offsite",
              "example": "offsite",
              "enum": [
                "offsite"
              ]
            }
          },
          {
            "name": "query_tested",
            "in": "query",
            "description": "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.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page:limit",
            "in": "query",
            "description": "Limit results to n number of links per page.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page:offset",
            "in": "query",
            "description": "Begin showing results from link number n.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page:order_by",
            "in": "query",
            "description": "Sort results.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "query_url_asc",
              "example": "query_url_asc",
              "enum": [
                "query_url_asc",
                "query_url_desc",
                "status_asc",
                "status_desc",
                "state_asc",
                "state_desc",
                "reply_code_asc",
                "reply_code_desc"
              ]
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "The response representation format for results.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "json",
              "example": "json",
              "enum": [
                "json"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Provides the list of links found during the given scan instance on the given site.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Links"
                }
              }
            }
          },
          "400": {
            "description": "BadRequestResponse indicates a request with invalid parameters.",
            "content": {}
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access.",
            "content": {}
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized.",
            "content": {}
          },
          "500": {
            "description": "GenericError generic error.",
            "content": {}
          },
          "501": {
            "description": "Not implemented.",
            "content": {}
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "Link": {
        "properties": {
          "url": {
            "type": "string"
          },
          "reply_content": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "reply_code": {
            "type": "number"
          },
          "state": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "Links": {
        "properties": {
          "type": {
            "type": "string"
          },
          "collection": {
            "items": {
              "$ref": "#/components/schemas/Link"
            }
          },
          "href": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "instance_id": {
            "type": "string",
            "nullable": true
          },
          "total": {
            "type": "string"
          },
          "page": {
            "properties": {
              "total": {
                "type": "string"
              },
              "order_by": {
                "type": "string"
              },
              "offset": {
                "type": "string"
              },
              "limit": {
                "type": "string"
              }
            },
            "type": "object"
          }
        }
      }
    }
  }
}
```