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

OWASP ZAP break API

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

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

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

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

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

11 operations 11 paths 1 schemas 11 GET

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

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

Paths & Operations 11

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

break 11
GET
/JSON/break/action/addHttpBreakpoint/
Adds a custom HTTP breakpoint. The string is the string to match. Location may be one of: url, requestheader, requestbody, responseheader or responsebody. Match may be: contains or regex. Inverse (ma…
breakActionAddHttpBreakpoint 5 params → default
GET
/JSON/break/action/break/
Controls the global break functionality. The type may be one of: http-all, http-request or http-response. The state may be true (for turning break on for the specified type) or false (for turning bre…
breakActionBreak 3 params → default
GET
/JSON/break/action/continue/
Submits the currently intercepted message and unsets the global request/response breakpoints
breakActionContinue → default
GET
/JSON/break/action/drop/
Drops the currently intercepted message
breakActionDrop → default
GET
/JSON/break/action/removeHttpBreakpoint/
Removes the specified breakpoint
breakActionRemoveHttpBreakpoint 5 params → default
GET
/JSON/break/action/setHttpMessage/
Overwrites the currently intercepted message with the data provided
breakActionSetHttpMessage 2 params → default
GET
/JSON/break/action/step/
Submits the currently intercepted message, the next request or response will automatically be intercepted
breakActionStep → default
GET
/JSON/break/view/httpMessage/
Returns the HTTP message currently intercepted (if any)
breakViewHttpMessage → default
GET
/JSON/break/view/isBreakAll/
Returns True if ZAP will break on both requests and responses
breakViewIsBreakAll → default
GET
/JSON/break/view/isBreakRequest/
Returns True if ZAP will break on requests
breakViewIsBreakRequest → default
GET
/JSON/break/view/isBreakResponse/
Returns True if ZAP will break on responses
breakViewIsBreakResponse → default

Schemas 1

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

ErrorJson
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs OWASP ZAP publishes across the network.

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

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

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

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

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