openapi: 3.0.3
info:
title: ZAP accessControl openapi 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: openapi
paths:
/JSON/openapi/action/importFile/:
parameters:
- name: file
in: query
required: true
description: The file that contains the OpenAPI definition.
schema:
type: string
- name: target
in: query
description: The Target URL to override the server URL present in the definition.
schema:
type: string
- name: contextId
in: query
description: The ID of the context. Defaults to the first context, if any.
schema:
type: string
- name: userId
in: query
description: The ID of the user.
schema:
type: string
get:
description: Imports an OpenAPI definition from a local file.
operationId: openapiActionImportFile
tags:
- openapi
responses:
default:
$ref: '#/components/responses/ErrorJson'
/JSON/openapi/action/importUrl/:
parameters:
- name: url
in: query
required: true
description: The URL locating the OpenAPI definition.
schema:
type: string
- name: hostOverride
in: query
description: The Target URL (called hostOverride for historical reasons) to override the server URL present in the definition.
schema:
type: string
- name: contextId
in: query
description: The ID of the context. Defaults to the first context, if any.
schema:
type: string
- name: userId
in: query
description: The ID of the user.
schema:
type: string
get:
description: Imports an OpenAPI definition from a URL.
operationId: openapiActionImportUrl
tags:
- openapi
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