Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
9445 lines (9294 sloc) 246 KB
openapi: "3.0.2"
info:
title: ZAP API
description: The HTTP API for controlling and accessing ZAP.
contact:
name: OWASP ZAP User Group
url: https://groups.google.com/group/zaproxy-users
email: zaproxy-users@googlegroups.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: Dev Build
servers:
- url: http://zap
description: The URL while proxying through ZAP.
- url: http://{address}:{port}
description: The URL of a Local Proxy of ZAP.
variables:
address:
default: 127.0.0.1
description: The address ZAP is listening on.
port:
default: '8080'
description: The port ZAP is bound to.
components:
securitySchemes:
apiKeyHeader:
type: apiKey
name: X-ZAP-API-Key
in: header
apiKeyQuery:
type: apiKey
name: apikey
in: query
schemas:
Error:
type: object
required:
- message
- code
properties:
message:
type: string
code:
type: integer
minimum: 100
maximum: 600
security:
- apiKeyHeader: []
- apiKeyQuery: []
paths:
/JSON/alert/view/alert/:
get:
description: >-
Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method
operationId: alertViewAlert
tags:
- alert
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/alert/view/alerts/:
get:
description: >-
Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts
operationId: alertViewAlerts
tags:
- alert
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: riskId
in: query
required: false
deprecated: false
description: ""
schema:
type: string
/JSON/alert/view/alertsSummary/:
get:
description: >-
Gets number of alerts grouped by each risk level, optionally filtering by URL
operationId: alertViewAlertsSummary
tags:
- alert
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
/JSON/alert/view/numberOfAlerts/:
get:
description: >-
Gets the number of alerts, optionally filtering by URL or riskId
operationId: alertViewNumberOfAlerts
tags:
- alert
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: riskId
in: query
required: false
deprecated: false
description: ""
schema:
type: string
/JSON/alert/view/alertsByRisk/:
get:
description: >-
Gets a summary of the alerts, optionally filtered by a 'url'. If 'recurse' is true then all alerts that apply to urls that start with the specified 'url' will be returned, otherwise only those on exactly the same 'url' (ignoring url parameters)
operationId: alertViewAlertsByRisk
tags:
- alert
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: url
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: recurse
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
/JSON/alert/view/alertCountsByRisk/:
get:
description: >-
Gets a count of the alerts, optionally filtered as per alertsPerRisk
operationId: alertViewAlertCountsByRisk
tags:
- alert
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: url
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: recurse
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
/JSON/alert/action/deleteAllAlerts/:
get:
description: >-
Deletes all alerts of the current session.
operationId: alertActionDeleteAllAlerts
tags:
- alert
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/alert/action/deleteAlert/:
get:
description: >-
Deletes the alert with the given ID.
operationId: alertActionDeleteAlert
tags:
- alert
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/acsrf/view/optionTokensNames/:
get:
description: >-
Lists the names of all anti-CSRF tokens
operationId: acsrfViewOptionTokensNames
tags:
- acsrf
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/acsrf/action/addOptionToken/:
get:
description: >-
Adds an anti-CSRF token with the given name, enabled by default
operationId: acsrfActionAddOptionToken
tags:
- acsrf
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: String
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/acsrf/action/removeOptionToken/:
get:
description: >-
Removes the anti-CSRF token with the given name
operationId: acsrfActionRemoveOptionToken
tags:
- acsrf
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: String
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/OTHER/acsrf/other/genForm/:
get:
description: >-
Generate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP
operationId: acsrfOtherGenForm
tags:
- acsrf
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: hrefId
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/pscan/view/scanOnlyInScope/:
get:
description: >-
Tells whether or not the passive scan should be performed only on messages that are in scope.
operationId: pscanViewScanOnlyInScope
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/pscan/view/recordsToScan/:
get:
description: >-
The number of records the passive scanner still has to scan
operationId: pscanViewRecordsToScan
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/pscan/view/scanners/:
get:
description: >-
Lists all passive scanners with its ID, name, enabled state and alert threshold.
operationId: pscanViewScanners
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/pscan/view/currentRule/:
get:
description: >-
Show information about the passive scan rule currently being run (if any).
operationId: pscanViewCurrentRule
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/pscan/view/maxAlertsPerRule/:
get:
description: >-
Gets the maximum number of alerts a passive scan rule should raise.
operationId: pscanViewMaxAlertsPerRule
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/pscan/action/setEnabled/:
get:
description: >-
Sets whether or not the passive scanning is enabled (Note: the enabled state is not persisted).
operationId: pscanActionSetEnabled
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: enabled
in: query
required: true
deprecated: false
description: ""
schema:
type: boolean
/JSON/pscan/action/setScanOnlyInScope/:
get:
description: >-
Sets whether or not the passive scan should be performed only on messages that are in scope.
operationId: pscanActionSetScanOnlyInScope
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: onlyInScope
in: query
required: true
deprecated: false
description: ""
schema:
type: boolean
/JSON/pscan/action/enableAllScanners/:
get:
description: >-
Enables all passive scanners
operationId: pscanActionEnableAllScanners
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/pscan/action/disableAllScanners/:
get:
description: >-
Disables all passive scanners
operationId: pscanActionDisableAllScanners
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/pscan/action/enableScanners/:
get:
description: >-
Enables all passive scanners with the given IDs (comma separated list of IDs)
operationId: pscanActionEnableScanners
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: ids
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/pscan/action/disableScanners/:
get:
description: >-
Disables all passive scanners with the given IDs (comma separated list of IDs)
operationId: pscanActionDisableScanners
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: ids
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/pscan/action/setScannerAlertThreshold/:
get:
description: >-
Sets the alert threshold of the passive scanner with the given ID, accepted values for alert threshold: OFF, DEFAULT, LOW, MEDIUM and HIGH
operationId: pscanActionSetScannerAlertThreshold
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
- name: alertThreshold
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/pscan/action/setMaxAlertsPerRule/:
get:
description: >-
Sets the maximum number of alerts a passive scan rule should raise.
operationId: pscanActionSetMaxAlertsPerRule
tags:
- pscan
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: maxAlerts
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/search/view/urlsByUrlRegex/:
get:
description: >-
Returns the URLs of the HTTP messages that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchViewUrlsByUrlRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/search/view/urlsByRequestRegex/:
get:
description: >-
Returns the URLs of the HTTP messages that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchViewUrlsByRequestRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/search/view/urlsByResponseRegex/:
get:
description: >-
Returns the URLs of the HTTP messages that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchViewUrlsByResponseRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/search/view/urlsByHeaderRegex/:
get:
description: >-
Returns the URLs of the HTTP messages that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchViewUrlsByHeaderRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/search/view/messagesByUrlRegex/:
get:
description: >-
Returns the HTTP messages that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchViewMessagesByUrlRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/search/view/messagesByRequestRegex/:
get:
description: >-
Returns the HTTP messages that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchViewMessagesByRequestRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/search/view/messagesByResponseRegex/:
get:
description: >-
Returns the HTTP messages that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchViewMessagesByResponseRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/search/view/messagesByHeaderRegex/:
get:
description: >-
Returns the HTTP messages that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchViewMessagesByHeaderRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/OTHER/search/other/harByUrlRegex/:
get:
description: >-
Returns the HTTP messages, in HAR format, that match the given regular expression in the URL optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchOtherHarByUrlRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/OTHER/search/other/harByRequestRegex/:
get:
description: >-
Returns the HTTP messages, in HAR format, that match the given regular expression in the request optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchOtherHarByRequestRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/OTHER/search/other/harByResponseRegex/:
get:
description: >-
Returns the HTTP messages, in HAR format, that match the given regular expression in the response optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchOtherHarByResponseRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/OTHER/search/other/harByHeaderRegex/:
get:
description: >-
Returns the HTTP messages, in HAR format, that match the given regular expression in the header(s) optionally filtered by URL and paginated with 'start' position and 'count' of messages.
operationId: searchOtherHarByHeaderRegex
tags:
- search
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/autoupdate/view/latestVersionNumber/:
get:
description: >-
Returns the latest version number
operationId: autoupdateViewLatestVersionNumber
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/isLatestVersion/:
get:
description: >-
Returns 'true' if ZAP is on the latest version
operationId: autoupdateViewIsLatestVersion
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/installedAddons/:
get:
description: >-
Return a list of all of the installed add-ons
operationId: autoupdateViewInstalledAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/localAddons/:
get:
description: >-
Returns a list with all local add-ons, installed or not.
operationId: autoupdateViewLocalAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/newAddons/:
get:
description: >-
Return a list of any add-ons that have been added to the Marketplace since the last check for updates
operationId: autoupdateViewNewAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/updatedAddons/:
get:
description: >-
Return a list of any add-ons that have been changed in the Marketplace since the last check for updates
operationId: autoupdateViewUpdatedAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/marketplaceAddons/:
get:
description: >-
Return a list of all of the add-ons on the ZAP Marketplace (this information is read once and then cached)
operationId: autoupdateViewMarketplaceAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionAddonDirectories/:
get:
description: >-
operationId: autoupdateViewOptionAddonDirectories
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionDayLastChecked/:
get:
description: >-
operationId: autoupdateViewOptionDayLastChecked
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionDayLastInstallWarned/:
get:
description: >-
operationId: autoupdateViewOptionDayLastInstallWarned
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionDayLastUpdateWarned/:
get:
description: >-
operationId: autoupdateViewOptionDayLastUpdateWarned
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionDownloadDirectory/:
get:
description: >-
operationId: autoupdateViewOptionDownloadDirectory
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionCheckAddonUpdates/:
get:
description: >-
operationId: autoupdateViewOptionCheckAddonUpdates
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionCheckOnStart/:
get:
description: >-
operationId: autoupdateViewOptionCheckOnStart
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionDownloadNewRelease/:
get:
description: >-
operationId: autoupdateViewOptionDownloadNewRelease
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionInstallAddonUpdates/:
get:
description: >-
operationId: autoupdateViewOptionInstallAddonUpdates
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionInstallScannerRules/:
get:
description: >-
operationId: autoupdateViewOptionInstallScannerRules
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionReportAlphaAddons/:
get:
description: >-
operationId: autoupdateViewOptionReportAlphaAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionReportBetaAddons/:
get:
description: >-
operationId: autoupdateViewOptionReportBetaAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/view/optionReportReleaseAddons/:
get:
description: >-
operationId: autoupdateViewOptionReportReleaseAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/action/downloadLatestRelease/:
get:
description: >-
Downloads the latest release, if any
operationId: autoupdateActionDownloadLatestRelease
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/autoupdate/action/installAddon/:
get:
description: >-
Installs or updates the specified add-on, returning when complete (ie not asynchronously)
operationId: autoupdateActionInstallAddon
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/autoupdate/action/installLocalAddon/:
get:
description: >-
operationId: autoupdateActionInstallLocalAddon
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: file
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/autoupdate/action/uninstallAddon/:
get:
description: >-
Uninstalls the specified add-on
operationId: autoupdateActionUninstallAddon
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/autoupdate/action/setOptionCheckAddonUpdates/:
get:
description: >-
operationId: autoupdateActionSetOptionCheckAddonUpdates
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/autoupdate/action/setOptionCheckOnStart/:
get:
description: >-
operationId: autoupdateActionSetOptionCheckOnStart
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/autoupdate/action/setOptionDownloadNewRelease/:
get:
description: >-
operationId: autoupdateActionSetOptionDownloadNewRelease
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/autoupdate/action/setOptionInstallAddonUpdates/:
get:
description: >-
operationId: autoupdateActionSetOptionInstallAddonUpdates
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/autoupdate/action/setOptionInstallScannerRules/:
get:
description: >-
operationId: autoupdateActionSetOptionInstallScannerRules
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/autoupdate/action/setOptionReportAlphaAddons/:
get:
description: >-
operationId: autoupdateActionSetOptionReportAlphaAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/autoupdate/action/setOptionReportBetaAddons/:
get:
description: >-
operationId: autoupdateActionSetOptionReportBetaAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/autoupdate/action/setOptionReportReleaseAddons/:
get:
description: >-
operationId: autoupdateActionSetOptionReportReleaseAddons
tags:
- autoupdate
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/view/status/:
get:
description: >-
operationId: spiderViewStatus
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: scanId
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/view/results/:
get:
description: >-
operationId: spiderViewResults
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: scanId
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/view/fullResults/:
get:
description: >-
operationId: spiderViewFullResults
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: scanId
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/view/scans/:
get:
description: >-
operationId: spiderViewScans
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/excludedFromScan/:
get:
description: >-
Gets the regexes of URLs excluded from the spider scans.
operationId: spiderViewExcludedFromScan
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/allUrls/:
get:
description: >-
Returns a list of unique URLs from the history table based on HTTP messages added by the Spider.
operationId: spiderViewAllUrls
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/addedNodes/:
get:
description: >-
Returns a list of the names of the nodes added to the Sites tree by the specified scan.
operationId: spiderViewAddedNodes
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: scanId
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/view/domainsAlwaysInScope/:
get:
description: >-
Gets all the domains that are always in scope. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex.
operationId: spiderViewDomainsAlwaysInScope
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionDomainsAlwaysInScope/:
get:
description: >-
Use view domainsAlwaysInScope instead.
deprecated: true
operationId: spiderViewOptionDomainsAlwaysInScope
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionDomainsAlwaysInScopeEnabled/:
get:
description: >-
Use view domainsAlwaysInScope instead.
deprecated: true
operationId: spiderViewOptionDomainsAlwaysInScopeEnabled
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionHandleParameters/:
get:
description: >-
operationId: spiderViewOptionHandleParameters
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionMaxChildren/:
get:
description: >-
Gets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
operationId: spiderViewOptionMaxChildren
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionMaxDepth/:
get:
description: >-
Gets the maximum depth the spider can crawl, 0 if unlimited.
operationId: spiderViewOptionMaxDepth
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionMaxDuration/:
get:
description: >-
operationId: spiderViewOptionMaxDuration
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionMaxParseSizeBytes/:
get:
description: >-
Gets the maximum size, in bytes, that a response might have to be parsed.
operationId: spiderViewOptionMaxParseSizeBytes
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionMaxScansInUI/:
get:
description: >-
operationId: spiderViewOptionMaxScansInUI
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionRequestWaitTime/:
get:
description: >-
operationId: spiderViewOptionRequestWaitTime
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionScope/:
get:
description: >-
operationId: spiderViewOptionScope
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionScopeText/:
get:
description: >-
operationId: spiderViewOptionScopeText
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionSkipURLString/:
get:
description: >-
operationId: spiderViewOptionSkipURLString
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionThreadCount/:
get:
description: >-
operationId: spiderViewOptionThreadCount
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionUserAgent/:
get:
description: >-
operationId: spiderViewOptionUserAgent
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionAcceptCookies/:
get:
description: >-
Gets whether or not a spider process should accept cookies while spidering.
operationId: spiderViewOptionAcceptCookies
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionHandleODataParametersVisited/:
get:
description: >-
operationId: spiderViewOptionHandleODataParametersVisited
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionParseComments/:
get:
description: >-
operationId: spiderViewOptionParseComments
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionParseGit/:
get:
description: >-
operationId: spiderViewOptionParseGit
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionParseRobotsTxt/:
get:
description: >-
operationId: spiderViewOptionParseRobotsTxt
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionParseSVNEntries/:
get:
description: >-
operationId: spiderViewOptionParseSVNEntries
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionParseSitemapXml/:
get:
description: >-
operationId: spiderViewOptionParseSitemapXml
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionPostForm/:
get:
description: >-
operationId: spiderViewOptionPostForm
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionProcessForm/:
get:
description: >-
operationId: spiderViewOptionProcessForm
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionSendRefererHeader/:
get:
description: >-
Gets whether or not the 'Referer' header should be sent while spidering.
operationId: spiderViewOptionSendRefererHeader
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/view/optionShowAdvancedDialog/:
get:
description: >-
operationId: spiderViewOptionShowAdvancedDialog
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/action/scan/:
get:
description: >-
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').
operationId: spiderActionScan
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: url
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: maxChildren
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: recurse
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
- name: contextName
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: subtreeOnly
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
/JSON/spider/action/scanAsUser/:
get:
description: >-
Runs the spider from the perspective of a User, obtained using the given Context ID and User ID. See 'scan' action for more details.
operationId: spiderActionScanAsUser
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: contextId
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
- name: userId
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
- name: url
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: maxChildren
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: recurse
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
- name: subtreeOnly
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
/JSON/spider/action/pause/:
get:
description: >-
operationId: spiderActionPause
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: scanId
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/resume/:
get:
description: >-
operationId: spiderActionResume
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: scanId
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/stop/:
get:
description: >-
operationId: spiderActionStop
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: scanId
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/removeScan/:
get:
description: >-
operationId: spiderActionRemoveScan
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: scanId
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/pauseAllScans/:
get:
description: >-
operationId: spiderActionPauseAllScans
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/action/resumeAllScans/:
get:
description: >-
operationId: spiderActionResumeAllScans
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/action/stopAllScans/:
get:
description: >-
operationId: spiderActionStopAllScans
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/action/removeAllScans/:
get:
description: >-
operationId: spiderActionRemoveAllScans
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/action/clearExcludedFromScan/:
get:
description: >-
Clears the regexes of URLs excluded from the spider scans.
operationId: spiderActionClearExcludedFromScan
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/action/excludeFromScan/:
get:
description: >-
Adds a regex of URLs that should be excluded from the spider scans.
operationId: spiderActionExcludeFromScan
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: regex
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/addDomainAlwaysInScope/:
get:
description: >-
Adds a new domain that's always in scope, using the specified value. Optionally sets if the new entry is enabled (default, true) and whether or not the new value is specified as a regex (default, false).
operationId: spiderActionAddDomainAlwaysInScope
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: value
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: isRegex
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
- name: isEnabled
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
/JSON/spider/action/modifyDomainAlwaysInScope/:
get:
description: >-
Modifies a domain that's always in scope. Allows to modify the value, if enabled or if a regex. The domain is selected with its index, which can be obtained with the view domainsAlwaysInScope.
operationId: spiderActionModifyDomainAlwaysInScope
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: idx
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
- name: value
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: isRegex
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
- name: isEnabled
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
/JSON/spider/action/removeDomainAlwaysInScope/:
get:
description: >-
Removes a domain that's always in scope, with the given index. The index can be obtained with the view domainsAlwaysInScope.
operationId: spiderActionRemoveDomainAlwaysInScope
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: idx
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/enableAllDomainsAlwaysInScope/:
get:
description: >-
Enables all domains that are always in scope.
operationId: spiderActionEnableAllDomainsAlwaysInScope
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/action/disableAllDomainsAlwaysInScope/:
get:
description: >-
Disables all domains that are always in scope.
operationId: spiderActionDisableAllDomainsAlwaysInScope
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/spider/action/setOptionHandleParameters/:
get:
description: >-
operationId: spiderActionSetOptionHandleParameters
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: String
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionScopeString/:
get:
description: >-
Use actions [add|modify|remove]DomainAlwaysInScope instead.
operationId: spiderActionSetOptionScopeString
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: String
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionSkipURLString/:
get:
description: >-
operationId: spiderActionSetOptionSkipURLString
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: String
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionUserAgent/:
get:
description: >-
operationId: spiderActionSetOptionUserAgent
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: String
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionAcceptCookies/:
get:
description: >-
Sets whether or not a spider process should accept cookies while spidering.
operationId: spiderActionSetOptionAcceptCookies
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionHandleODataParametersVisited/:
get:
description: >-
operationId: spiderActionSetOptionHandleODataParametersVisited
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionMaxChildren/:
get:
description: >-
Sets the maximum number of child nodes (per node) that can be crawled, 0 means no limit.
operationId: spiderActionSetOptionMaxChildren
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Integer
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/setOptionMaxDepth/:
get:
description: >-
Sets the maximum depth the spider can crawl, 0 for unlimited depth.
operationId: spiderActionSetOptionMaxDepth
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Integer
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/setOptionMaxDuration/:
get:
description: >-
operationId: spiderActionSetOptionMaxDuration
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Integer
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/setOptionMaxParseSizeBytes/:
get:
description: >-
Sets the maximum size, in bytes, that a response might have to be parsed. This allows the spider to skip big responses/files.
operationId: spiderActionSetOptionMaxParseSizeBytes
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Integer
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/setOptionMaxScansInUI/:
get:
description: >-
operationId: spiderActionSetOptionMaxScansInUI
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Integer
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/setOptionParseComments/:
get:
description: >-
operationId: spiderActionSetOptionParseComments
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionParseGit/:
get:
description: >-
operationId: spiderActionSetOptionParseGit
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionParseRobotsTxt/:
get:
description: >-
operationId: spiderActionSetOptionParseRobotsTxt
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionParseSVNEntries/:
get:
description: >-
operationId: spiderActionSetOptionParseSVNEntries
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionParseSitemapXml/:
get:
description: >-
operationId: spiderActionSetOptionParseSitemapXml
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionPostForm/:
get:
description: >-
operationId: spiderActionSetOptionPostForm
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionProcessForm/:
get:
description: >-
operationId: spiderActionSetOptionProcessForm
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionRequestWaitTime/:
get:
description: >-
operationId: spiderActionSetOptionRequestWaitTime
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Integer
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/spider/action/setOptionSendRefererHeader/:
get:
description: >-
Sets whether or not the 'Referer' header should be sent while spidering.
operationId: spiderActionSetOptionSendRefererHeader
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionShowAdvancedDialog/:
get:
description: >-
operationId: spiderActionSetOptionShowAdvancedDialog
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Boolean
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/spider/action/setOptionThreadCount/:
get:
description: >-
operationId: spiderActionSetOptionThreadCount
tags:
- spider
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: Integer
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/core/view/hosts/:
get:
description: >-
Gets the name of the hosts accessed through/by ZAP
operationId: coreViewHosts
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/sites/:
get:
description: >-
Gets the sites accessed through/by ZAP (scheme and domain)
operationId: coreViewSites
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/urls/:
get:
description: >-
Gets the URLs accessed through/by ZAP, optionally filtering by (base) URL.
operationId: coreViewUrls
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
/JSON/core/view/childNodes/:
get:
description: >-
Gets the child nodes underneath the specified URL in the Sites tree
operationId: coreViewChildNodes
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: url
in: query
required: false
deprecated: false
description: ""
schema:
type: string
/JSON/core/view/message/:
get:
description: >-
Gets the HTTP message with the given ID. Returns the ID, request/response headers and bodies, cookies, note, type, RTT, and timestamp.
operationId: coreViewMessage
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/core/view/messages/:
get:
description: >-
Gets the HTTP messages sent by ZAP, request and response, optionally filtered by URL and paginated with 'start' position and 'count' of messages
operationId: coreViewMessages
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
/JSON/core/view/messagesById/:
get:
description: >-
Gets the HTTP messages with the given IDs.
operationId: coreViewMessagesById
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: ids
in: query
required: true
deprecated: false
description: ""
schema:
type: string
/JSON/core/view/numberOfMessages/:
get:
description: >-
Gets the number of messages, optionally filtering by URL
operationId: coreViewNumberOfMessages
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
/JSON/core/view/mode/:
get:
description: >-
Gets the mode
operationId: coreViewMode
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/version/:
get:
description: >-
Gets ZAP version
operationId: coreViewVersion
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/excludedFromProxy/:
get:
description: >-
Gets the regular expressions, applied to URLs, to exclude from the local proxies.
operationId: coreViewExcludedFromProxy
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/homeDirectory/:
get:
description: >-
operationId: coreViewHomeDirectory
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/sessionLocation/:
get:
description: >-
Gets the location of the current session file
operationId: coreViewSessionLocation
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/proxyChainExcludedDomains/:
get:
description: >-
Gets all the domains that are excluded from the outgoing proxy. For each domain the following are shown: the index, the value (domain), if enabled, and if specified as a regex.
operationId: coreViewProxyChainExcludedDomains
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionProxyChainSkipName/:
get:
description: >-
Use view proxyChainExcludedDomains instead.
deprecated: true
operationId: coreViewOptionProxyChainSkipName
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionProxyExcludedDomains/:
get:
description: >-
Use view proxyChainExcludedDomains instead.
deprecated: true
operationId: coreViewOptionProxyExcludedDomains
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionProxyExcludedDomainsEnabled/:
get:
description: >-
Use view proxyChainExcludedDomains instead.
deprecated: true
operationId: coreViewOptionProxyExcludedDomainsEnabled
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/zapHomePath/:
get:
description: >-
Gets the path to ZAP's home directory.
operationId: coreViewZapHomePath
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionMaximumAlertInstances/:
get:
description: >-
Gets the maximum number of alert instances to include in a report.
operationId: coreViewOptionMaximumAlertInstances
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionMergeRelatedAlerts/:
get:
description: >-
Gets whether or not related alerts will be merged in any reports generated.
operationId: coreViewOptionMergeRelatedAlerts
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionAlertOverridesFilePath/:
get:
description: >-
Gets the path to the file with alert overrides.
operationId: coreViewOptionAlertOverridesFilePath
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/alert/:
get:
description: >-
Gets the alert with the given ID, the corresponding HTTP message can be obtained with the 'messageId' field and 'message' API method
deprecated: true
operationId: coreViewAlert
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: id
in: query
required: true
deprecated: false
description: ""
schema:
type: integer
/JSON/core/view/alerts/:
get:
description: >-
Gets the alerts raised by ZAP, optionally filtering by URL or riskId, and paginating with 'start' position and 'count' of alerts
deprecated: true
operationId: coreViewAlerts
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: start
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: count
in: query
required: false
deprecated: false
description: ""
schema:
type: integer
- name: riskId
in: query
required: false
deprecated: false
description: ""
schema:
type: string
/JSON/core/view/alertsSummary/:
get:
description: >-
Gets number of alerts grouped by each risk level, optionally filtering by URL
deprecated: true
operationId: coreViewAlertsSummary
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
/JSON/core/view/numberOfAlerts/:
get:
description: >-
Gets the number of alerts, optionally filtering by URL or riskId
deprecated: true
operationId: coreViewNumberOfAlerts
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: baseurl
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: riskId
in: query
required: false
deprecated: false
description: ""
schema:
type: string
/JSON/core/view/optionDefaultUserAgent/:
get:
description: >-
Gets the user agent that ZAP should use when creating HTTP messages (for example, spider messages or CONNECT requests to outgoing proxy).
operationId: coreViewOptionDefaultUserAgent
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionDnsTtlSuccessfulQueries/:
get:
description: >-
Gets the TTL (in seconds) of successful DNS queries.
operationId: coreViewOptionDnsTtlSuccessfulQueries
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionHttpState/:
get:
description: >-
operationId: coreViewOptionHttpState
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionProxyChainName/:
get:
description: >-
operationId: coreViewOptionProxyChainName
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionProxyChainPassword/:
get:
description: >-
operationId: coreViewOptionProxyChainPassword
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionProxyChainPort/:
get:
description: >-
operationId: coreViewOptionProxyChainPort
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionProxyChainRealm/:
get:
description: >-
operationId: coreViewOptionProxyChainRealm
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionProxyChainUserName/:
get:
description: >-
operationId: coreViewOptionProxyChainUserName
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionTimeoutInSecs/:
get:
description: >-
Gets the connection time out, in seconds.
operationId: coreViewOptionTimeoutInSecs
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionHttpStateEnabled/:
get:
description: >-
operationId: coreViewOptionHttpStateEnabled
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionProxyChainPrompt/:
get:
description: >-
operationId: coreViewOptionProxyChainPrompt
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionSingleCookieRequestHeader/:
get:
description: >-
operationId: coreViewOptionSingleCookieRequestHeader
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionUseProxyChain/:
get:
description: >-
operationId: coreViewOptionUseProxyChain
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/view/optionUseProxyChainAuth/:
get:
description: >-
operationId: coreViewOptionUseProxyChainAuth
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/action/accessUrl/:
get:
description: >-
Convenient and simple action to access a URL, optionally following redirections. Returns the request sent and response received and followed redirections, if any. Other actions are available which offer more control on what is sent, like, 'sendRequest' or 'sendHarRequest'.
operationId: coreActionAccessUrl
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: url
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: followRedirects
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
/JSON/core/action/shutdown/:
get:
description: >-
Shuts down ZAP
operationId: coreActionShutdown
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/action/newSession/:
get:
description: >-
Creates a new session, optionally overwriting existing files. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.
operationId: coreActionNewSession
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: name
in: query
required: false
deprecated: false
description: ""
schema:
type: string
- name: overwrite
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
/JSON/core/action/loadSession/:
get:
description: >-
Loads the session with the given name. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.
operationId: coreActionLoadSession
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: name
in: query
required: false
deprecated: false
description: ""
schema:
type: string
/JSON/core/action/saveSession/:
get:
description: >-
Saves the session with the name supplied, optionally overwriting existing files. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.
operationId: coreActionSaveSession
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: name
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: overwrite
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
/JSON/core/action/snapshotSession/:
get:
description: >-
Snapshots the session, optionally with the given name, and overwriting existing files. If no name is specified the name of the current session with a timestamp appended is used. If a relative path is specified it will be resolved against the "session" directory in ZAP "home" dir.
operationId: coreActionSnapshotSession
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
parameters:
- name: name
in: query
required: true
deprecated: false
description: ""
schema:
type: string
- name: overwrite
in: query
required: false
deprecated: false
description: ""
schema:
type: boolean
/JSON/core/action/clearExcludedFromProxy/:
get:
description: >-
Clears the regexes of URLs excluded from the local proxies.
operationId: coreActionClearExcludedFromProxy
tags:
- core
responses:
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/JSON/core/action/excludeFromProxy/:
get:
description: >-