---
title: "GET /JSON/spider/action/scan/"
method: GET
path: "/JSON/spider/action/scan/"
tags: ["spider"]
---

# GET /JSON/spider/action/scan/

`GET /JSON/spider/action/scan/`

Runs the spider against the given URL (or context). Optionally, the 'maxChildren' parameter can be set to limit the number of children scanned, the 'recurse' parameter can be used to prevent the spider from seeding recursively, the parameter 'contextName' can be used to constrain the scan to a Context and the parameter 'subtreeOnly' allows to restrict the spider under a site's subtree (using the specified 'url').

## Response `default`

Error of JSON endpoints.

- ErrorJson
  - `code` string, required
  - `message` string, required
  - `detail` string

## Changes

> 4 revisions in range; 1 could not be searched.

- **2023-09-29** `3a1d8df7169d` — 1 breaking, 1 info
  - the `code` response's property type/format changed from `integer`/`` to `string`/`` for status `default`
  - added the optional property `detail` to the response with the `default` status
- **2019-10-10** `c7cc14d831c3` — 1 breaking, 1 warning
  - the `code` response's property type/format changed from `string`/`` to `integer`/`` for status `default`
  - removed the optional property `detail` from the response with the `default` status

[Change history](https://skmtc.dev/zaproxy/apis/zap-api/changes/JSON/spider/action/scan/get.md)

---

[API](https://skmtc.dev/zaproxy/apis/zap-api.md) · [All operations](https://skmtc.dev/zaproxy/apis/zap-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zaproxy/zap-api/revisions/bbb71f68ed4c/schema)