OWASP ZAP

OWASP ZAP Oast API

The oast API from OWASP ZAP — 11 operation(s) for oast.

GitHub OpenAPI

Operations 11

GET /JSON/oast/action/setActiveScanService/ Oast action set active scan service #
GET /JSON/oast/action/setBoastOptions/ Oast action set boast options #
GET /JSON/oast/action/setCallbackOptions/ Oast action set callback options #
GET /JSON/oast/action/setDaysToKeepRecords/ Oast action set days to keep records #
GET /JSON/oast/action/setInteractshOptions/ Oast action set interactsh options #
GET /JSON/oast/view/getActiveScanService/ Oast view get active scan service #
GET /JSON/oast/view/getBoastOptions/ Oast view get boast options #
GET /JSON/oast/view/getCallbackOptions/ Oast view get callback options #
GET /JSON/oast/view/getDaysToKeepRecords/ Oast view get days to keep records #
GET /JSON/oast/view/getInteractshOptions/ Oast view get interactsh options #
GET /JSON/oast/view/getServices/ Oast view get services #

Documentation

📖
Documentation
https://www.zaproxy.org/docs/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/owasp-zap/refs/heads/main/openapi/owasp-zap-oast-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/zaproxy/zaproxy

Other Resources

🔗
API Documentation
https://www.zaproxy.org/docs/api/
🔗
GitHub API Docs
https://github.com/zaproxy/zap-api-docs

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/owasp-zap:owasp-zap-oast-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

owasp-zap-oast-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ZAP Oast 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: oast
paths:
  /JSON/oast/action/setActiveScanService/:
    parameters:
    - name: name
      in: query
      required: true
      description: The name of the service.
      schema:
        type: string
    get:
      description: Sets the service used with the active scanner.
      operationId: oastActionSetActiveScanService
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast action set active scan service
      x-summary-source: derived
  /JSON/oast/action/setBoastOptions/:
    parameters:
    - name: server
      in: query
      required: true
      description: The server URL.
      schema:
        type: string
    - name: pollInSecs
      in: query
      required: true
      description: The polling frequency.
      schema:
        type: string
    get:
      description: Sets the BOAST options.
      operationId: oastActionSetBoastOptions
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast action set boast options
      x-summary-source: derived
  /JSON/oast/action/setCallbackOptions/:
    parameters:
    - name: localAddress
      in: query
      required: true
      description: The local address
      schema:
        type: string
    - name: remoteAddress
      in: query
      required: true
      description: The remote address.
      schema:
        type: string
    - name: port
      in: query
      required: true
      description: The port to listen on.
      schema:
        type: string
    get:
      description: Sets the Callback options.
      operationId: oastActionSetCallbackOptions
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast action set callback options
      x-summary-source: derived
  /JSON/oast/action/setDaysToKeepRecords/:
    parameters:
    - name: days
      in: query
      required: true
      description: The number of days.
      schema:
        type: string
    get:
      description: Sets the number of days the OAST records will be kept for.
      operationId: oastActionSetDaysToKeepRecords
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast action set days to keep records
      x-summary-source: derived
  /JSON/oast/action/setInteractshOptions/:
    parameters:
    - name: server
      in: query
      required: true
      description: The server URL.
      schema:
        type: string
    - name: pollInSecs
      in: query
      required: true
      description: The polling frequency.
      schema:
        type: string
    - name: authToken
      in: query
      required: true
      description: The Interactsh authentication token.
      schema:
        type: string
    get:
      description: Sets the Interactsh options.
      operationId: oastActionSetInteractshOptions
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast action set interactsh options
      x-summary-source: derived
  /JSON/oast/view/getActiveScanService/:
    get:
      description: Gets the service used with the active scanner, if any.
      operationId: oastViewGetActiveScanService
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast view get active scan service
      x-summary-source: derived
  /JSON/oast/view/getBoastOptions/:
    get:
      description: Gets the BOAST options.
      operationId: oastViewGetBoastOptions
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast view get boast options
      x-summary-source: derived
  /JSON/oast/view/getCallbackOptions/:
    get:
      description: Gets the Callback options.
      operationId: oastViewGetCallbackOptions
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast view get callback options
      x-summary-source: derived
  /JSON/oast/view/getDaysToKeepRecords/:
    get:
      description: Gets the number of days the OAST records will be kept for.
      operationId: oastViewGetDaysToKeepRecords
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast view get days to keep records
      x-summary-source: derived
  /JSON/oast/view/getInteractshOptions/:
    get:
      description: Gets the Interactsh options.
      operationId: oastViewGetInteractshOptions
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast view get interactsh options
      x-summary-source: derived
  /JSON/oast/view/getServices/:
    get:
      description: Gets all of the services.
      operationId: oastViewGetServices
      tags:
      - oast
      responses:
        default:
          $ref: '#/components/responses/ErrorJson'
      summary: Oast view get services
      x-summary-source: derived
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
x-provenance:
  method: harvested
  publisher: OWASP ZAP
  source: https://raw.githubusercontent.com/zaproxy/zap-api-docs/HEAD/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)