Skip to content

[API Shield] Risk labels #18876

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
merged 2 commits into from
Dec 20, 2024
Merged

[API Shield] Risk labels #18876

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
353bb9f
risk labels
patriciasantaana Dec 19, 2024
aaa2203
Apply suggestions from code review
patriciasantaana Dec 20, 2024
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
17 changes: 17 additions & 0 deletions src/content/docs/api-shield/management-and-monitoring/endpoint-labels.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,23 @@ You can filter your endpoints based on the labels.

`cf-account-update`: Add this label to endpoints that participate in user account or profile updates.

`cf-rss-feed`: Add this label to endpoints that expect traffic from RSS clients.

`cf-risk-missing-auth`: Automatically added when all successful requests lack a session identifier. Refer to the table below for more information.

`cf-risk-mixed-auth`: Automatically added when some successful requests contain a session identifier and some successful requests lack a session identifier. Refer to the table below for more information.

`cf-risk-sensitive`: Cloudflare will automatically add this label to endpoints when HTTP responses match the WAF's [Sensitive Data Detection](/api-shield/management-and-monitoring/#sensitive-data-detection) ruleset.

:::note
Cloudflare will only add authentication labels to endpoints with successful response codes. Refer to the below table for more details.
:::

| Description | 2xx response codes | 4xx, 5xx response codes |
| --- | --- | --- |
| If all requests are missing authentication, Cloudflare will apply the label: | `cf-missing-auth` | Without successful responses, no label will be added. |
| If only some requests are missing authentication, Cloudflare will apply the label: | `cf-mixed-auth` | Without successful responses, no label will be added. |

## Create a label

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
Expand Down
Loading