|
| 1 | +--- |
| 2 | +pcx_content_type: how-to |
| 3 | +type: overview |
| 4 | +title: Endpoint labeling service |
| 5 | +sidebar: |
| 6 | + order: 1 |
| 7 | + label: Labeling service |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +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. |
| 12 | + |
| 13 | +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. |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | +You can filter your endpoints based on the labels. |
| 18 | + |
| 19 | +## Managed labels |
| 20 | + |
| 21 | +`cf-log-in`: Add this label to endpoints that accept user credentials. You may have multiple endpoints if you accept username, password, and multi-factor authentication (MFA) across multiple endpoints or requests. |
| 22 | + |
| 23 | +`cf-sign-up`: Add this label to endpoints that are the final step in creating user accounts for your site or application. |
| 24 | + |
| 25 | +`cf-content`: Add this label to endpoints that provide unique content, such as product details, user reviews, pricing, or other unique information. |
| 26 | + |
| 27 | +`cf-purchase`: Add this label to endpoints that are the final step in purchasing goods or services online. |
| 28 | + |
| 29 | +`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. |
| 30 | + |
| 31 | +`cf-add-cart`: Add this label to endpoints that add items to a user's shopping cart or verify item availability. |
| 32 | + |
| 33 | +`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. |
| 34 | + |
| 35 | +`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. |
| 36 | + |
| 37 | +`cf-add-post`: Add this label to endpoints that post messages in a communication forum, or product or merchant reviews. |
| 38 | + |
| 39 | +`cf-account-update`: Add this label to endpoints that participate in user account or profile updates. |
| 40 | + |
| 41 | +:::note |
| 42 | +Cloudflare will only add authentication labels to endpoints with successful response codes. Refer to the below table for more details. |
| 43 | +::: |
| 44 | + |
| 45 | +| Description | 4xx, 5xx response codes | 2xx response codes | |
| 46 | +| --- | --- | --- | |
| 47 | +| If _all_ requests are missing authentication, Cloudflare will apply the label: | (no label) | `cf-missing-auth` | |
| 48 | +| If only _some_ requests are missing authentication, Cloudflare will apply the label: | (no label) | `cf-mixed-auth` | |
| 49 | + |
| 50 | +## Create a label |
| 51 | + |
| 52 | +1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. |
| 53 | +2. Go to **Security** > **Settings** > **Labels**. |
| 54 | +3. Under **Security labels**, select **Create label**. |
| 55 | +4. Name the label and add an optional label description. |
| 56 | +5. Apply the label to your selected endpoints. |
| 57 | +6. Select **Create label**. |
| 58 | + |
| 59 | +Alternatively, you can create a user-defined label via Endpoint Management in API Shield. |
| 60 | + |
| 61 | +1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. |
| 62 | +2. Go to **Security** > **Settings** > **Labels**. |
| 63 | +3. Choose the endpoint that you want to label. |
| 64 | +4. Select **Edit labels**. |
| 65 | +5. Under **User**, select **Create user label**. |
| 66 | +6. Enter the label name. |
| 67 | +7. Select **Create**. |
| 68 | + |
| 69 | +## Apply a label to an individual endpoint |
| 70 | + |
| 71 | +1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. |
| 72 | +2. Go to **Security** > **API Shield** > **Endpoint Management**. |
| 73 | +3. Choose the endpoint that you want to label. |
| 74 | +4. Select **Edit labels**. |
| 75 | +5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels. |
| 76 | +6. Select **Save labels**. |
| 77 | + |
| 78 | +## Bulk apply labels to multiple endpoints |
| 79 | + |
| 80 | +1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. |
| 81 | +2. Go to **Security** > **Settings** > **Labels**. |
| 82 | +3. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**. |
| 83 | +4. Choose the endpoints that you want to label by selecting its checkbox. |
| 84 | +5. Select **Save label**. |
| 85 | + |
| 86 | +## Availability |
| 87 | + |
| 88 | +Endpoint Management's labeling service is currently available to Enterprise API Shield subscribers. |
0 commit comments