hud

GET /JSON/hud/view/hudAlertData/

Changed on Jul 17, 2026

Returns the alert summary needed by the HUD for the specified URL

Request

Base URL
http://zap
Auth
- none
- or API key in header X-ZAP-API-Key
- or API key in query parameter apikey
TypeScript
https://skmtc.dev/zaproxy/apis/zap-api/docs/JSON/hud/view/hudAlertData/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

Error of JSON endpoints.

codestring required

messagestring required

detailstring

Changes

Jul 17, 2026bbb71f68ed4c Revision changes
- info
  endpoint added
Oct 11, 2019c7cc14d831c3 Revision changes
- breaking
  api path removed without deprecation

Operation history