OWASP ZAP selenium API
The selenium API from OWASP ZAP — 22 operation(s) for selenium.
The selenium API from OWASP ZAP — 22 operation(s) for selenium.
openapi: 3.0.3
info:
title: ZAP accessControl selenium API
description: The HTTP API for controlling and accessing ZAP.
contact:
name: 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: 2.16.1
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:
description: The address ZAP is listening on.
default: 127.0.0.1
port:
description: The port ZAP is bound to.
default: '8080'
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: selenium
paths:
/JSON/selenium/action/addBrowserArgument/:
parameters:
- name: browser
in: query
required: true
description: The browser, chrome or firefox.
schema:
type: string
- name: argument
in: query
required: true
description: The argument.
schema:
type: string
- name: enabled
in: query
description: The enabled state, true or false.
schema:
type: string
get:
description: Adds a browser argument.
operationId: seleniumActionAddBrowserArgument
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/launchBrowser/:
parameters:
- name: browser
in: query
required: true
description: The browser, chrome or firefox.
schema:
type: string
get:
description: Launches a browser proxying through ZAP, for manual usage.
operationId: seleniumActionLaunchBrowser
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/removeBrowserArgument/:
parameters:
- name: browser
in: query
required: true
description: The browser, chrome or firefox.
schema:
type: string
- name: argument
in: query
required: true
description: The argument.
schema:
type: string
get:
description: Removes a browser argument.
operationId: seleniumActionRemoveBrowserArgument
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/setBrowserArgumentEnabled/:
parameters:
- name: browser
in: query
required: true
description: The browser, chrome or firefox.
schema:
type: string
- name: argument
in: query
required: true
description: The argument.
schema:
type: string
- name: enabled
in: query
required: true
description: The enabled state, true or false.
schema:
type: string
get:
description: Sets whether or not a browser argument is enabled.
operationId: seleniumActionSetBrowserArgumentEnabled
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/setOptionChromeBinaryPath/:
parameters:
- name: String
in: query
required: true
description: ''
schema:
type: string
get:
description: Sets the current path to Chrome binary
operationId: seleniumActionSetOptionChromeBinaryPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/setOptionChromeDriverPath/:
parameters:
- name: String
in: query
required: true
description: ''
schema:
type: string
get:
description: Sets the current path to ChromeDriver
operationId: seleniumActionSetOptionChromeDriverPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/setOptionFirefoxBinaryPath/:
parameters:
- name: String
in: query
required: true
description: ''
schema:
type: string
get:
description: Sets the current path to Firefox binary
operationId: seleniumActionSetOptionFirefoxBinaryPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/setOptionFirefoxDefaultProfile/:
parameters:
- name: String
in: query
required: true
description: ''
schema:
type: string
get:
description: ''
operationId: seleniumActionSetOptionFirefoxDefaultProfile
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/setOptionFirefoxDriverPath/:
parameters:
- name: String
in: query
required: true
description: ''
schema:
type: string
get:
description: Sets the current path to Firefox driver (geckodriver)
operationId: seleniumActionSetOptionFirefoxDriverPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/setOptionIeDriverPath/:
parameters:
- name: String
in: query
required: true
description: ''
schema:
type: string
get:
description: Option no longer in effective use.
deprecated: true
operationId: seleniumActionSetOptionIeDriverPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/setOptionLastDirectory/:
parameters:
- name: String
in: query
required: true
description: ''
schema:
type: string
get:
description: ''
operationId: seleniumActionSetOptionLastDirectory
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/action/setOptionPhantomJsBinaryPath/:
parameters:
- name: String
in: query
required: true
description: ''
schema:
type: string
get:
description: Option no longer in effective use.
deprecated: true
operationId: seleniumActionSetOptionPhantomJsBinaryPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/view/getBrowserArguments/:
parameters:
- name: browser
in: query
required: true
description: The browser, chrome or firefox.
schema:
type: string
get:
description: Gets the browser arguments.
operationId: seleniumViewGetBrowserArguments
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/view/optionBrowserExtensions/:
get:
description: ''
operationId: seleniumViewOptionBrowserExtensions
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/view/optionChromeBinaryPath/:
get:
description: Returns the current path to Chrome binary
operationId: seleniumViewOptionChromeBinaryPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/view/optionChromeDriverPath/:
get:
description: Returns the current path to ChromeDriver
operationId: seleniumViewOptionChromeDriverPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/view/optionFirefoxBinaryPath/:
get:
description: Returns the current path to Firefox binary
operationId: seleniumViewOptionFirefoxBinaryPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/view/optionFirefoxDefaultProfile/:
get:
description: ''
operationId: seleniumViewOptionFirefoxDefaultProfile
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/view/optionFirefoxDriverPath/:
get:
description: Returns the current path to Firefox driver (geckodriver)
operationId: seleniumViewOptionFirefoxDriverPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/view/optionIeDriverPath/:
get:
description: Option no longer in effective use.
deprecated: true
operationId: seleniumViewOptionIeDriverPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/view/optionLastDirectory/:
get:
description: ''
operationId: seleniumViewOptionLastDirectory
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/selenium/view/optionPhantomJsBinaryPath/:
get:
description: Option no longer in effective use.
deprecated: true
operationId: seleniumViewOptionPhantomJsBinaryPath
tags:
- selenium
responses:
default:
$ref: '#/components/responses/ErrorJson'
components:
responses:
ErrorJson:
description: Error of JSON endpoints.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorJson'
schemas:
ErrorJson:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
detail:
type: string
securitySchemes:
apiKeyHeader:
type: apiKey
name: X-ZAP-API-Key
in: header
apiKeyQuery:
type: apiKey
name: apikey
in: query