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 context API

The context API from OWASP ZAP — 21 operation(s) for context.

OWASP ZAP context 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 Context. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 21 operations across 21 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}.

21 operations 21 paths 1 schemas 21 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 context 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 21

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

context 21
GET
/JSON/context/action/excludeAllContextTechnologies/
Excludes all built in technologies from a context
contextActionExcludeAllContextTechnologies 1 param → default
GET
/JSON/context/action/excludeContextTechnologies/
Excludes technologies with the given names, separated by a comma, from a context
contextActionExcludeContextTechnologies 2 params → default
GET
/JSON/context/action/excludeFromContext/
Add exclude regex to context
contextActionExcludeFromContext 2 params → default
GET
/JSON/context/action/exportContext/
Exports the context with the given name to a file. If a relative file path is specified it will be resolved against the "contexts" directory in ZAP "home" dir.
contextActionExportContext 2 params → default
GET
/JSON/context/action/importContext/
Imports a context from a file. If a relative file path is specified it will be resolved against the "contexts" directory in ZAP "home" dir.
contextActionImportContext 1 param → default
GET
/JSON/context/action/includeAllContextTechnologies/
Includes all built in technologies in to a context
contextActionIncludeAllContextTechnologies 1 param → default
GET
/JSON/context/action/includeContextTechnologies/
Includes technologies with the given names, separated by a comma, to a context
contextActionIncludeContextTechnologies 2 params → default
GET
/JSON/context/action/includeInContext/
Add include regex to context
contextActionIncludeInContext 2 params → default
GET
/JSON/context/action/newContext/
Creates a new context with the given name in the current session
contextActionNewContext 1 param → default
GET
/JSON/context/action/removeContext/
Removes a context in the current session
contextActionRemoveContext 1 param → default
GET
/JSON/context/action/setContextCheckingStrategy/
Set the checking strategy for a context - this defines how ZAP checks that a request is authenticated
contextActionSetContextCheckingStrategy 7 params → default
GET
/JSON/context/action/setContextInScope/
Sets a context to in scope (contexts are in scope by default)
contextActionSetContextInScope 2 params → default
GET
/JSON/context/action/setContextRegexs/
Set the regexs to include and exclude for a context, both supplied as JSON string arrays
contextActionSetContextRegexs 3 params → default
GET
/JSON/context/view/context/
List the information about the named context
contextViewContext 1 param → default
GET
/JSON/context/view/contextList/
List context names of current session
contextViewContextList → default
GET
/JSON/context/view/excludeRegexs/
List excluded regexs for context
contextViewExcludeRegexs 1 param → default
GET
/JSON/context/view/excludedTechnologyList/
Lists the names of all technologies excluded from a context
contextViewExcludedTechnologyList 1 param → default
GET
/JSON/context/view/includeRegexs/
List included regexs for context
contextViewIncludeRegexs 1 param → default
GET
/JSON/context/view/includedTechnologyList/
Lists the names of all technologies included in a context
contextViewIncludedTechnologyList 1 param → default
GET
/JSON/context/view/technologyList/
Lists the names of all built in technologies
contextViewTechnologyList → default
GET
/JSON/context/view/urls/
Lists the URLs accessed through/by ZAP, that belong to the context with the given name.
contextViewUrls 1 param → 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-context-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 break API
OWASP ZAP client API
Where this information came from

This is an independent, third-party profile of OWASP ZAP context 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.