OWASP ZAP Graph QL API
The Graph QL API from OWASP ZAP — 20 operation(s) for graph ql.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/owasp-zap-graph-ql-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: ZAP GraphQL 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: Graph QL
paths:
/JSON/graphql/action/importFile/:
parameters:
- name: endurl
in: query
required: true
description: The Endpoint URL.
schema:
type: string
- name: file
in: query
required: true
description: The File That Contains the GraphQL Schema.
schema:
type: string
get:
description: Imports a GraphQL Schema from a File.
operationId: graphqlActionImportFile
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action import file
x-summary-source: derived
/JSON/graphql/action/importUrl/:
parameters:
- name: endurl
in: query
required: true
description: The Endpoint URL.
schema:
type: string
- name: url
in: query
description: The URL Locating the GraphQL Schema.
schema:
type: string
get:
description: Imports a GraphQL Schema from a URL.
operationId: graphqlActionImportUrl
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action import url
x-summary-source: derived
/JSON/graphql/action/setOptionArgsType/:
parameters:
- name: String
in: query
required: true
description: Can be "INLINE", "VARIABLES", or "BOTH".
schema:
type: string
get:
description: Sets how arguments are specified.
operationId: graphqlActionSetOptionArgsType
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action set option args type
x-summary-source: derived
/JSON/graphql/action/setOptionLenientMaxQueryDepthEnabled/:
parameters:
- name: Boolean
in: query
required: true
description: Enforce Leniently (true or false).
schema:
type: boolean
get:
description: Sets whether or not Maximum Query Depth is enforced leniently.
operationId: graphqlActionSetOptionLenientMaxQueryDepthEnabled
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action set option lenient max query depth enabled
x-summary-source: derived
/JSON/graphql/action/setOptionMaxAdditionalQueryDepth/:
parameters:
- name: Integer
in: query
required: true
description: The Maximum Additional Depth.
schema:
type: integer
get:
description: Sets the maximum additional query generation depth (used if enforced leniently).
operationId: graphqlActionSetOptionMaxAdditionalQueryDepth
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action set option max additional query depth
x-summary-source: derived
/JSON/graphql/action/setOptionMaxArgsDepth/:
parameters:
- name: Integer
in: query
required: true
description: The Maximum Depth.
schema:
type: integer
get:
description: Sets the maximum arguments generation depth.
operationId: graphqlActionSetOptionMaxArgsDepth
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action set option max args depth
x-summary-source: derived
/JSON/graphql/action/setOptionMaxQueryDepth/:
parameters:
- name: Integer
in: query
required: true
description: The Maximum Depth.
schema:
type: integer
get:
description: Sets the maximum query generation depth.
operationId: graphqlActionSetOptionMaxQueryDepth
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action set option max query depth
x-summary-source: derived
/JSON/graphql/action/setOptionOptionalArgsEnabled/:
parameters:
- name: Boolean
in: query
required: true
description: Specify Optional Arguments (true or false).
schema:
type: boolean
get:
description: Sets whether or not Optional Arguments should be specified.
operationId: graphqlActionSetOptionOptionalArgsEnabled
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action set option optional args enabled
x-summary-source: derived
/JSON/graphql/action/setOptionQueryGenEnabled/:
parameters:
- name: Boolean
in: query
required: true
description: Enable query generation (true or false).
schema:
type: boolean
get:
description: Sets whether the query generator is enabled.
operationId: graphqlActionSetOptionQueryGenEnabled
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action set option query gen enabled
x-summary-source: derived
/JSON/graphql/action/setOptionQuerySplitType/:
parameters:
- name: String
in: query
required: true
description: Can be "LEAF", "ROOT_FIELD", or "OPERATION".
schema:
type: string
get:
description: Sets the level for which a single query is generated.
operationId: graphqlActionSetOptionQuerySplitType
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action set option query split type
x-summary-source: derived
/JSON/graphql/action/setOptionRequestMethod/:
parameters:
- name: String
in: query
required: true
description: Can be "POST_JSON", "POST_GRAPHQL", or "GET".
schema:
type: string
get:
description: Sets the request method.
operationId: graphqlActionSetOptionRequestMethod
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql action set option request method
x-summary-source: derived
/JSON/graphql/view/optionArgsType/:
get:
description: Returns how arguments are currently specified.
operationId: graphqlViewOptionArgsType
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql view option args type
x-summary-source: derived
/JSON/graphql/view/optionLenientMaxQueryDepthEnabled/:
get:
description: Returns whether or not lenient maximum query generation depth is enabled.
operationId: graphqlViewOptionLenientMaxQueryDepthEnabled
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql view option lenient max query depth enabled
x-summary-source: derived
/JSON/graphql/view/optionMaxAdditionalQueryDepth/:
get:
description: Returns the current maximum additional query generation depth.
operationId: graphqlViewOptionMaxAdditionalQueryDepth
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql view option max additional query depth
x-summary-source: derived
/JSON/graphql/view/optionMaxArgsDepth/:
get:
description: Returns the current maximum arguments generation depth.
operationId: graphqlViewOptionMaxArgsDepth
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql view option max args depth
x-summary-source: derived
/JSON/graphql/view/optionMaxQueryDepth/:
get:
description: Returns the current maximum query generation depth.
operationId: graphqlViewOptionMaxQueryDepth
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql view option max query depth
x-summary-source: derived
/JSON/graphql/view/optionOptionalArgsEnabled/:
get:
description: Returns whether or not optional arguments are currently specified.
operationId: graphqlViewOptionOptionalArgsEnabled
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql view option optional args enabled
x-summary-source: derived
/JSON/graphql/view/optionQueryGenEnabled/:
get:
description: Returns whether the query generator is enabled.
operationId: graphqlViewOptionQueryGenEnabled
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql view option query gen enabled
x-summary-source: derived
/JSON/graphql/view/optionQuerySplitType/:
get:
description: Returns the current level for which a single query is generated.
operationId: graphqlViewOptionQuerySplitType
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql view option query split type
x-summary-source: derived
/JSON/graphql/view/optionRequestMethod/:
get:
description: Returns the current request method.
operationId: graphqlViewOptionRequestMethod
tags:
- Graph QL
responses:
default:
$ref: '#/components/responses/ErrorJson'
summary: Graphql view option request method
x-summary-source: derived
components:
schemas:
ErrorJson:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
detail:
type: string
responses:
ErrorJson:
description: Error of JSON endpoints.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorJson'
securitySchemes:
apiKeyHeader:
type: apiKey
name: X-ZAP-API-Key
in: header
apiKeyQuery:
type: apiKey
name: apikey
in: query