How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OWASP ZAP ascan API

The ascan API from OWASP ZAP — 90 operation(s) for ascan.

OWASP ZAP ascan API is one of 49 APIs that OWASP ZAP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ascan. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 90 operations across 90 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 2.16.1.

Requests are made against 2 base URLs: http://zap, http://{address}:{port}.

90 operations 90 paths 1 schemas 90 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.16.1
Base URL
http://zap
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

OWASP ZAP ascan API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-ZAP-API-Key (apiKeyHeader). An API key is passed in the query as apikey (apiKeyQuery). By default, every request must be authenticated, though some operations may also be called without credentials.

Paths & Operations 90

Across 90 paths, the API surfaces 90 operations — 90 GET. Each is listed below with its method, path, parameters, and response codes.

ascan 90
GET
/JSON/ascan/action/addExcludedParam/
Adds a new parameter excluded from the scan, using the specified name. Optionally sets if the new entry applies to a specific URL (default, all URLs) and sets the ID of the type of the parameter (def…
ascanActionAddExcludedParam 3 params → default
GET
/JSON/ascan/action/addScanPolicy/
ascanActionAddScanPolicy 3 params → default
GET
/JSON/ascan/action/clearExcludedFromScan/
Clears the regexes of URLs excluded from the active scans.
ascanActionClearExcludedFromScan → default
GET
/JSON/ascan/action/disableAllScanners/
Disables all scan rules of the scan policy with the given name, or the default if none given.
ascanActionDisableAllScanners 1 param → default
GET
/JSON/ascan/action/disableScanners/
Disables the scan rules with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
ascanActionDisableScanners 2 params → default
GET
/JSON/ascan/action/enableAllScanners/
Enables all scan rules of the scan policy with the given name, or the default if none given.
ascanActionEnableAllScanners 1 param → default
GET
/JSON/ascan/action/enableScanners/
Enables the scan rules with the given IDs (comma separated list of IDs) of the scan policy with the given name, or the default if none given.
ascanActionEnableScanners 2 params → default
GET
/JSON/ascan/action/excludeFromScan/
Adds a regex of URLs that should be excluded from the active scans.
ascanActionExcludeFromScan 1 param → default
GET
/JSON/ascan/action/importScanPolicy/
Imports a Scan Policy using the given file system path.
ascanActionImportScanPolicy 1 param → default
GET
/JSON/ascan/action/modifyExcludedParam/
Modifies a parameter excluded from the scan. Allows to modify the name, the URL and the type of parameter. The parameter is selected with its index, which can be obtained with the view excludedParams.
ascanActionModifyExcludedParam 4 params → default
GET
/JSON/ascan/action/pause/
ascanActionPause 1 param → default
GET
/JSON/ascan/action/pauseAllScans/
ascanActionPauseAllScans → default
GET
/JSON/ascan/action/removeAllScans/
ascanActionRemoveAllScans → default
GET
/JSON/ascan/action/removeExcludedParam/
Removes a parameter excluded from the scan, with the given index. The index can be obtained with the view excludedParams.
ascanActionRemoveExcludedParam 1 param → default
GET
/JSON/ascan/action/removeScan/
ascanActionRemoveScan 1 param → default
GET
/JSON/ascan/action/removeScanPolicy/
ascanActionRemoveScanPolicy 1 param → default
GET
/JSON/ascan/action/resume/
ascanActionResume 1 param → default
GET
/JSON/ascan/action/resumeAllScans/
ascanActionResumeAllScans → default
GET
/JSON/ascan/action/scan/
Runs the active scanner against the given URL or Context. Optionally, the 'recurse' parameter can be used to scan URLs under the given URL, the parameter 'inScopeOnly' can be used to constrain the sc…
ascanActionScan 7 params → default
GET
/JSON/ascan/action/scanAsUser/
Active Scans from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.
ascanActionScanAsUser 7 params → default
GET
/JSON/ascan/action/setEnabledPolicies/
ascanActionSetEnabledPolicies 2 params → default
GET
/JSON/ascan/action/setOptionAddQueryParam/
Sets whether or not the active scanner should add a query param to GET requests which do not have parameters to start with.
ascanActionSetOptionAddQueryParam 1 param → default
GET
/JSON/ascan/action/setOptionAllowAttackOnStart/
ascanActionSetOptionAllowAttackOnStart 1 param → default
GET
/JSON/ascan/action/setOptionAttackPolicy/
ascanActionSetOptionAttackPolicy 1 param → default
GET
/JSON/ascan/action/setOptionDefaultPolicy/
ascanActionSetOptionDefaultPolicy 1 param → default
GET
/JSON/ascan/action/setOptionDelayInMs/deprecated
This option has been superseded. Use the API rate limit endpoints in the 'network' component instead.
ascanActionSetOptionDelayInMs 1 param → default
GET
/JSON/ascan/action/setOptionEncodeCookieValues/
Sets whether or not the active scanner should encode cookie values.
ascanActionSetOptionEncodeCookieValues 1 param → default
GET
/JSON/ascan/action/setOptionHandleAntiCSRFTokens/
ascanActionSetOptionHandleAntiCSRFTokens 1 param → default
GET
/JSON/ascan/action/setOptionHostPerScan/
ascanActionSetOptionHostPerScan 1 param → default
GET
/JSON/ascan/action/setOptionInjectPluginIdInHeader/
Sets whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scan rule that's sending the requests.
ascanActionSetOptionInjectPluginIdInHeader 1 param → default
GET
/JSON/ascan/action/setOptionMaxAlertsPerRule/
Sets the maximum number of alerts that a rule can raise before being skipped.
ascanActionSetOptionMaxAlertsPerRule 1 param → default
GET
/JSON/ascan/action/setOptionMaxChartTimeInMins/
ascanActionSetOptionMaxChartTimeInMins 1 param → default
GET
/JSON/ascan/action/setOptionMaxResultsToList/
ascanActionSetOptionMaxResultsToList 1 param → default
GET
/JSON/ascan/action/setOptionMaxRuleDurationInMins/
ascanActionSetOptionMaxRuleDurationInMins 1 param → default
GET
/JSON/ascan/action/setOptionMaxScanDurationInMins/
ascanActionSetOptionMaxScanDurationInMins 1 param → default
GET
/JSON/ascan/action/setOptionMaxScansInUI/
ascanActionSetOptionMaxScansInUI 1 param → default
GET
/JSON/ascan/action/setOptionPromptInAttackMode/
ascanActionSetOptionPromptInAttackMode 1 param → default
GET
/JSON/ascan/action/setOptionPromptToClearFinishedScans/
ascanActionSetOptionPromptToClearFinishedScans 1 param → default
GET
/JSON/ascan/action/setOptionRescanInAttackMode/
ascanActionSetOptionRescanInAttackMode 1 param → default
GET
/JSON/ascan/action/setOptionScanHeadersAllRequests/
Sets whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.
ascanActionSetOptionScanHeadersAllRequests 1 param → default
GET
/JSON/ascan/action/setOptionScanNullJsonValues/
Sets whether or not the active scanner should scan null JSON values.
ascanActionSetOptionScanNullJsonValues 1 param → default
GET
/JSON/ascan/action/setOptionShowAdvancedDialog/
ascanActionSetOptionShowAdvancedDialog 1 param → default
GET
/JSON/ascan/action/setOptionTargetParamsEnabledRPC/
ascanActionSetOptionTargetParamsEnabledRPC 1 param → default
GET
/JSON/ascan/action/setOptionTargetParamsInjectable/
ascanActionSetOptionTargetParamsInjectable 1 param → default
GET
/JSON/ascan/action/setOptionThreadPerHost/
ascanActionSetOptionThreadPerHost 1 param → default
GET
/JSON/ascan/action/setPolicyAlertThreshold/
ascanActionSetPolicyAlertThreshold 3 params → default
GET
/JSON/ascan/action/setPolicyAttackStrength/
ascanActionSetPolicyAttackStrength 3 params → default
GET
/JSON/ascan/action/setScannerAlertThreshold/
ascanActionSetScannerAlertThreshold 3 params → default
GET
/JSON/ascan/action/setScannerAttackStrength/
ascanActionSetScannerAttackStrength 3 params → default
GET
/JSON/ascan/action/skipScanner/
Skips the scan rule using the given IDs of the scan and the scan rule.
ascanActionSkipScanner 2 params → default
GET
/JSON/ascan/action/stop/
ascanActionStop 1 param → default
GET
/JSON/ascan/action/stopAllScans/
ascanActionStopAllScans → default
GET
/JSON/ascan/action/updateScanPolicy/
ascanActionUpdateScanPolicy 3 params → default
GET
/JSON/ascan/view/alertsIds/
Gets the IDs of the alerts raised during the scan with the given ID. An alert can be obtained with 'alert' core view.
ascanViewAlertsIds 1 param → default
GET
/JSON/ascan/view/attackModeQueue/
ascanViewAttackModeQueue → default
GET
/JSON/ascan/view/excludedFromScan/
Gets the regexes of URLs excluded from the active scans.
ascanViewExcludedFromScan → default
GET
/JSON/ascan/view/excludedParamTypes/
Gets all the types of excluded parameters. For each type the following are shown: the ID and the name.
ascanViewExcludedParamTypes → default
GET
/JSON/ascan/view/excludedParams/
Gets all the parameters that are excluded. For each parameter the following are shown: the name, the URL, and the parameter type.
ascanViewExcludedParams → default
GET
/JSON/ascan/view/messagesIds/
Gets the IDs of the messages sent during the scan with the given ID. A message can be obtained with 'message' core view.
ascanViewMessagesIds 1 param → default
GET
/JSON/ascan/view/optionAddQueryParam/
Tells whether or not the active scanner should add a query parameter to GET request that don't have parameters to start with.
ascanViewOptionAddQueryParam → default
GET
/JSON/ascan/view/optionAllowAttackOnStart/
ascanViewOptionAllowAttackOnStart → default
GET
/JSON/ascan/view/optionAttackPolicy/
ascanViewOptionAttackPolicy → default
GET
/JSON/ascan/view/optionDefaultPolicy/
ascanViewOptionDefaultPolicy → default
GET
/JSON/ascan/view/optionDelayInMs/deprecated
This option has been superseded. Use the API rate limit endpoints in the 'network' component instead.
ascanViewOptionDelayInMs → default
GET
/JSON/ascan/view/optionEncodeCookieValues/
Tells whether or not the active scanner should encode cookie values.
ascanViewOptionEncodeCookieValues → default
GET
/JSON/ascan/view/optionExcludedParamList/deprecated
Use view excludedParams instead.
ascanViewOptionExcludedParamList → default
GET
/JSON/ascan/view/optionHandleAntiCSRFTokens/
ascanViewOptionHandleAntiCSRFTokens → default
GET
/JSON/ascan/view/optionHostPerScan/
ascanViewOptionHostPerScan → default
GET
/JSON/ascan/view/optionInjectPluginIdInHeader/
Tells whether or not the active scanner should inject the HTTP request header X-ZAP-Scan-ID, with the ID of the scan rule that's sending the requests.
ascanViewOptionInjectPluginIdInHeader → default
GET
/JSON/ascan/view/optionMaxAlertsPerRule/
Gets the maximum number of alerts that a rule can raise before being skipped.
ascanViewOptionMaxAlertsPerRule → default
GET
/JSON/ascan/view/optionMaxChartTimeInMins/
ascanViewOptionMaxChartTimeInMins → default
GET
/JSON/ascan/view/optionMaxResultsToList/
ascanViewOptionMaxResultsToList → default
GET
/JSON/ascan/view/optionMaxRuleDurationInMins/
ascanViewOptionMaxRuleDurationInMins → default
GET
/JSON/ascan/view/optionMaxScanDurationInMins/
ascanViewOptionMaxScanDurationInMins → default
GET
/JSON/ascan/view/optionMaxScansInUI/
ascanViewOptionMaxScansInUI → default
GET
/JSON/ascan/view/optionPromptInAttackMode/
ascanViewOptionPromptInAttackMode → default
GET
/JSON/ascan/view/optionPromptToClearFinishedScans/
ascanViewOptionPromptToClearFinishedScans → default
GET
/JSON/ascan/view/optionRescanInAttackMode/
ascanViewOptionRescanInAttackMode → default
GET
/JSON/ascan/view/optionScanHeadersAllRequests/
Tells whether or not the HTTP Headers of all requests should be scanned. Not just requests that send parameters, through the query or request body.
ascanViewOptionScanHeadersAllRequests → default
GET
/JSON/ascan/view/optionScanNullJsonValues/
Tells whether or not the active scanner should scan null JSON values.
ascanViewOptionScanNullJsonValues → default
GET
/JSON/ascan/view/optionShowAdvancedDialog/
ascanViewOptionShowAdvancedDialog → default
GET
/JSON/ascan/view/optionTargetParamsEnabledRPC/
ascanViewOptionTargetParamsEnabledRPC → default
GET
/JSON/ascan/view/optionTargetParamsInjectable/
ascanViewOptionTargetParamsInjectable → default
GET
/JSON/ascan/view/optionThreadPerHost/
ascanViewOptionThreadPerHost → default
GET
/JSON/ascan/view/policies/
ascanViewPolicies 2 params → default
GET
/JSON/ascan/view/scanPolicyNames/
ascanViewScanPolicyNames → default
GET
/JSON/ascan/view/scanProgress/
ascanViewScanProgress 1 param → default
GET
/JSON/ascan/view/scanners/
Gets the scan rules, optionally, of the given scan policy or scanner policy/category ID.
ascanViewScanners 2 params → default
GET
/JSON/ascan/view/scans/
ascanViewScans → default
GET
/JSON/ascan/view/status/
ascanViewStatus 1 param → default

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ErrorJson (3 properties). Each schema is shown below with its type and property counts.

ErrorJson
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

owasp-zap-ascan-api-openapi.yml Raw ↑

Other APIs OWASP ZAP publishes across the network.

OWASP ZAP accessControl API
OWASP ZAP acsrf API
OWASP ZAP ajaxSpider API
OWASP ZAP alert API
OWASP ZAP alertFilter API
OWASP ZAP authentication API
OWASP ZAP authorization API
OWASP ZAP automation API
OWASP ZAP autoupdate API
OWASP ZAP break API
OWASP ZAP client API
OWASP ZAP clientSpider API
Where this information came from

This is an independent, third-party profile of OWASP ZAP ascan API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.