-
Notifications
You must be signed in to change notification settings - Fork 10.4k
[API Shield] Endpoint Labeling Service #17480
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.
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
Closed
Closed
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
37041cd
labeling system
patriciasantaana 90b0248
Merge branch 'production' into patricia/pcx10747-apishield-labels
patriciasantaana 6f44d31
api shield labeling service
patriciasantaana 72a629b
fixes
patriciasantaana 9d8d3a2
hyperlint updates
patriciasantaana 2841d28
remove space
patriciasantaana cada733
Update src/content/docs/api-shield/management-and-monitoring/endpoint…
patriciasantaana 02fcc06
Apply suggestions from code review
patriciasantaana File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ pcx_content_type: how-to | |
| type: overview | ||
| title: API Routing | ||
| sidebar: | ||
| order: 2 | ||
| order: 3 | ||
|
|
||
| --- | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ pcx_content_type: how-to | |
| type: overview | ||
| title: Build developer portals | ||
| sidebar: | ||
| order: 3 | ||
| order: 4 | ||
|
|
||
| --- | ||
|
|
||
|
|
||
90 changes: 90 additions & 0 deletions
90
src/content/docs/api-shield/management-and-monitoring/endpoint-labels.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| --- | ||
| pcx_content_type: how-to | ||
| type: overview | ||
| title: Endpoint labeling service | ||
| sidebar: | ||
| order: 1 | ||
| label: Labeling service | ||
|
|
||
| --- | ||
|
|
||
| API Shield's labeling service will help you organize your endpoints and address vulnerabilities in your API. The labeling service comes with managed and user-defined labels. | ||
|
|
||
| Today, managed labels are useful for organizing endpoints by use case. In a future release, managed labels will automatically label endpoints by use case and those with informative or security risks, alerting you on endpoints that need attention. | ||
|
|
||
| User-defined labels can also be added to endpoints in API Shield by creating a label and adding it to an individual endpoint or multiple endpoints. User-defined labels will be useful for organizing your endpoints by owner, version, or type. | ||
|
|
||
| You can filter your endpoints based on the labels. | ||
|
|
||
| ## Managed labels | ||
|
|
||
| `cf-log-in`: Add this label to endpoints that accept user credentials. You may have multiple endpoints if you accept username, password, and MFA across multiple endpoints or requests. | ||
|
|
||
| `cf-sign-up`: Add this label to endpoints that are the final step in creating user accounts for your site or application. | ||
|
|
||
| `cf-content`: Add this label to endpoints that provide unique content, such as product details, user reviews, pricing, or other unique information. | ||
|
|
||
| `cf-purchase`: Add this label to endpoints that are the final step in purchasing goods or services online. | ||
|
|
||
| `cf-password-reset`: Add this label to endpoints that participate in the user password reset process. This includes initial password reset requests and final password reset submissions. | ||
|
|
||
| `cf-add-cart`: Add this label to endpoints that add items to a user’s shopping cart or verify item availability. | ||
|
|
||
| `cf-add-payment`: Add this label to endpoints that accept credit card or bank account details where fraudsters may iterate through account numbers to guess valid combinations of payment information. | ||
|
|
||
| `cf-check-value`: Add this label to endpoints that check the balance of rewards points, in-game currency, or other stored value products that can be earned, transferred, and redeemed for cash or physical goods. | ||
|
|
||
| `cf-add-post`: Add this label to endpoints that post messages in a communication forum, or product or merchant review. | ||
|
|
||
| `cf-account-update`: Add this label to endpoints that participate in user account or profile updates. | ||
|
|
||
| `cf-missing-auth`: Cloudflare will automatically add this label to endpoints where all successful responses are sent back to requests made by unauthenticated users without a session identifier. Refer to the table below for more information. | ||
|
|
||
| `cf-mixed-auth`: Cloudflare will automatically add this label to endpoints that respond successfully to requests sent by users who are not required to be authenticated, both with and without session identifiers. Refer to the table below for more information. | ||
|
|
||
| `cf-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. | ||
patriciasantaana marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| | Description | 4xx, 5xx responses | 2xx responses | | ||
| | --- | --- | --- | | ||
| | If _all_ requests are missing authentication, Cloudflare will apply the label: | (no label) | `cf-missing-auth` | | ||
| | If only _some_ requests are missing authentication, Cloudflare will apply the label: | (no label) | `cf-mixed-auth` | | ||
|
|
||
| ## Create a label | ||
|
|
||
| 1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. | ||
| 2. Go to **Security** > **Settings** > **Labels**. | ||
| 3. Under **Security labels**, select **Create label**. | ||
| 4. Name the label and add an optional label description. | ||
| 5. Apply the label to your selected endpoints. | ||
| 6. Select **Create label**. | ||
|
|
||
| Alternatively, you can create a user-defined label via Endpoint Management in API Shield. | ||
|
|
||
| 1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. | ||
| 2. Go to **Security** > **Settings** > **Labels**. | ||
| 3. Choose the endpoint that you want to label. | ||
| 4. Select **Edit labels**. | ||
| 5. Under **User**, select **Create user label**. | ||
| 6. Enter the label name. | ||
| 7. Select **Create**. | ||
|
|
||
| ## Apply a label to an individual endpoint | ||
|
|
||
| 1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. | ||
| 2. Go to **Security** > **API Shield**. | ||
| 3. Choose the endpoint that you want to label. | ||
| 4. Select **Edit labels**. | ||
| 5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels. | ||
| 6. Select **Save labels**. | ||
|
|
||
| ## Bulk apply labels to multiple endpoints | ||
|
|
||
| 1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. | ||
| 2. Go to **Security** > **Settings** > **Labels**. | ||
| 3. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**. | ||
| 4. Choose the endpoints that you want to label by selecting its checkbox. | ||
| 5. Select **Save label**. | ||
|
|
||
| ## Availability | ||
|
|
||
| Endpoint Management's labeling service is currently available to Enterprise API Shield subscribers. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ pcx_content_type: how-to | |
| type: overview | ||
| title: Session identifiers | ||
| sidebar: | ||
| order: 1 | ||
| order: 2 | ||
|
|
||
| --- | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.