Skip to content

docs(api-shield): surface discovery requirements inline including Workers exclusion #32044

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

Open
zeinjaber wants to merge 1 commit into
base: production
Choose a base branch
from
Open

docs(api-shield): surface discovery requirements inline including Workers exclusion #32044

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion src/content/docs/api-shield/security/api-discovery.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,15 @@ You can direct any feedback about your API Discovery results to your account tea

## Requirements

API endpoints are discovered based on machine learning or session identifiers. Machine learning based API discovery has traffic requirements. For more information, refer to [Discovery requirements](/security/web-assets/manage-operations/#discovery-requirements/).
API Discovery requires an active API Shield subscription at both the account and zone level. If your subscription is active at the account level but not assigned to the zone, Discovery will not run for that zone.

For an endpoint to appear in Discovery results, every request must meet the following conditions:

- The request must return a `2xx` response code from the Cloudflare edge.
- The request must not originate directly from a Cloudflare Worker. Traffic sent through the Cloudflare traffic simulator or other Worker-based test harnesses will not be counted toward Discovery thresholds.
- The endpoint must receive at least 500 requests within a continuous 10-day period.

For more information, refer to [Discovery requirements](/security/web-assets/manage-operations/#discovery-requirements/).

## Availability

Expand Down