Skip to content

Add general guidance for using the ZAP API with curl #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kingthorin merged 11 commits into from
Jan 17, 2026
Merged

Add general guidance for using the ZAP API with curl #247

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
419ab9e
Clarify alertFilter API documentation
SachinAditya Dec 27, 2025
7413e47
Add general guidance for using the ZAP API with curl
SachinAditya Jan 2, 2026
4a50947
Add general guidance for using the ZAP API with curl
SachinAditya Jan 2, 2026
0103c94
docs: move curl usage guidance under Access the API
SachinAditya Jan 3, 2026
7d9d186
Clarify curl API parameter guidance and remove redundancy
SachinAditya Jan 15, 2026
2cfa97f
Remove unrelated API basics text and keep PR focused on curl usage
SachinAditya Jan 15, 2026
e4d94b7
Revert alertFilter endpoint description to original
SachinAditya Jan 16, 2026
77600ae
Restore API basics sections and revert endpoint docs
SachinAditya Jan 16, 2026
2e42ca1
Revert openapi.yaml to upstream
SachinAditya Jan 16, 2026
30304e5
Add curl usage guidance section
SachinAditya Jan 16, 2026
3bfc477
fix: add blank line before Client SDKs heading
SachinAditya Jan 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions source/includes/welcome.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,17 @@ when you are proxying through ZAP, or via the host and port ZAP is listening on,
By default only the machine ZAP is running on is able to access the APIs. You can [allow other machines](https://www.zaproxy.org/faq/how-can-i-connect-to-zap-remotely/),
that are able to use ZAP as a proxy, access to the API.

### Using the ZAP API with curl

When interacting with the ZAP API using curl, keep the following points in mind:

- All parameter values must be URL-encoded.
- Some boolean parameters (for example `enabled`) may need to be explicitly provided when deviating from default values.

```bash
curl "http://zap/<format>/<component>/<operation>/<operation-name>/?param1=value1&param2=value2"
```

### Client SDKs
Comment on lines 109 to 111
Copy link
Member

@kingthorin kingthorin Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a blank line between the code fence and heading.

Copy link
Contributor Author

@SachinAditya SachinAditya Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kingthorin
Fixed, thanks!

Copy link
Contributor Author

@SachinAditya SachinAditya Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kingthorin
Fixed, thanks!


API clients are available for the following languages:
Expand Down