diff --git a/src/content/docs/api-shield/management-and-monitoring/api-routing/configure.mdx b/src/content/docs/api-shield/management-and-monitoring/api-routing/configure.mdx index 0236cb7c086749..c514ff4120eb46 100644 --- a/src/content/docs/api-shield/management-and-monitoring/api-routing/configure.mdx +++ b/src/content/docs/api-shield/management-and-monitoring/api-routing/configure.mdx @@ -12,7 +12,7 @@ API Shield Routing enables customers to create a unified external-facing API tha :::note -The term **Source Endpoint** refers to the endpoint managed by API Shield in Endpoint Management. The term **Target Endpoint** refers to the ultimate destination the request is sent to by the Routing feature. +The term **Source Endpoint** refers to the endpoint managed by API Shield in Endpoint Management. The term **Target Endpoint** refers to the ultimate destination the request is sent to by the Routing feature. ::: ## Process @@ -84,7 +84,7 @@ If API Shield returns unexpected results, check your Source Endpoint host, metho :::note -You may need to wait up to five minutes for route changes to synchronize across the Cloudflare network. +You may need to wait up to five minutes for route changes to synchronize across the Cloudflare network. ::: ## Limitations diff --git a/src/content/docs/api-shield/management-and-monitoring/api-routing/index.mdx b/src/content/docs/api-shield/management-and-monitoring/api-routing/index.mdx index f721bc1953016a..8774dba7e24cf4 100644 --- a/src/content/docs/api-shield/management-and-monitoring/api-routing/index.mdx +++ b/src/content/docs/api-shield/management-and-monitoring/api-routing/index.mdx @@ -13,7 +13,7 @@ API Shield Routing enables customers to create a unified external-facing API tha :::note -The term **Source Endpoint** refers to the endpoint managed by API Shield in Endpoint Management. The term **Target Endpoint** refers to the ultimate destination the request is sent to by the Routing feature. +The term **Source Endpoint** refers to the endpoint managed by API Shield in Endpoint Management. The term **Target Endpoint** refers to the ultimate destination the request is sent to by the Routing feature. ::: ## Process @@ -48,7 +48,7 @@ If API Shield returns unexpected results, check your Source Endpoint host, metho :::note -You may need to wait up to five minutes for Route changes to synchronize across the Cloudflare network. +You may need to wait up to five minutes for Route changes to synchronize across the Cloudflare network. ::: ## Availability diff --git a/src/content/docs/api-shield/management-and-monitoring/developer-portal.mdx b/src/content/docs/api-shield/management-and-monitoring/developer-portal.mdx index af791445f9244d..b058a258786be3 100644 --- a/src/content/docs/api-shield/management-and-monitoring/developer-portal.mdx +++ b/src/content/docs/api-shield/management-and-monitoring/developer-portal.mdx @@ -22,7 +22,7 @@ Once endpoints are saved If you do not have a schema to upload or to select from a pre-existing schema, export your Endpoint Management schema. For best results, include the learned parameters. - Only API schemas uploaded to Schema Validation 2.0 are available when selecting existing schemas + Only API schemas uploaded to Schema Validation 2.0 are available when selecting existing schemas ::: 5. Select **Download project files** to save a local copy of the files that will be uploaded to Cloudflare Pages. Downloading the project files can be helpful if you wish to modify the project in any way and then upload the new version manually to Pages. diff --git a/src/content/docs/api-shield/management-and-monitoring/endpoint-labels.mdx b/src/content/docs/api-shield/management-and-monitoring/endpoint-labels.mdx index ae6c75e9315adb..a9eb9887bd438b 100644 --- a/src/content/docs/api-shield/management-and-monitoring/endpoint-labels.mdx +++ b/src/content/docs/api-shield/management-and-monitoring/endpoint-labels.mdx @@ -16,7 +16,7 @@ Today, managed labels are useful for organizing endpoints by use case. In a futu 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. +You can filter your endpoints based on the labels. ## Managed labels @@ -32,7 +32,7 @@ You can filter your endpoints based on the labels. `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-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. @@ -44,7 +44,7 @@ You can filter your endpoints based on the labels. `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-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. @@ -56,39 +56,39 @@ Cloudflare will only add authentication labels to endpoints with successful resp ## Create a label -1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. +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**. +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. +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. +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. +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**. +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. +1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. 2. Go to **Security** > **API Shield** > **Endpoint Management**. -3. Choose the endpoint that you want to label. +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**. +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. +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**. +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 diff --git a/src/content/docs/api-shield/management-and-monitoring/index.mdx b/src/content/docs/api-shield/management-and-monitoring/index.mdx index e658736a6e2544..d36e73cfce0ad2 100644 --- a/src/content/docs/api-shield/management-and-monitoring/index.mdx +++ b/src/content/docs/api-shield/management-and-monitoring/index.mdx @@ -22,7 +22,7 @@ Cloudflare will start collecting [performance data](/api-shield/management-and-m :::note -When an endpoint is using [Cloudflare Workers](/workers/), the metrics data will not be populated. +When an endpoint is using [Cloudflare Workers](/workers/), the metrics data will not be populated. ::: ## Access @@ -57,7 +57,7 @@ API Shield will look for duplicate endpoints that have the same host, method, an :::note -If you deselect **Save new endpoints to endpoint management**, the endpoints will not be added. +If you deselect **Save new endpoints to endpoint management**, the endpoints will not be added. ::: ## Add endpoints manually @@ -68,10 +68,10 @@ If you deselect **Save new endpoints to endpoint management**, the endpoints wil :::note -By selecting multiple checkboxes, you can add several endpoints from Discovery at once instead of individually. +By selecting multiple checkboxes, you can add several endpoints from Discovery at once instead of individually. ::: -When adding an endpoint manually, you can specify variable fields in the path or host by enclosing them in braces, `/api/user/{var1}/details` or `{hostVar1}.example.com`. +When adding an endpoint manually, you can specify variable fields in the path or host by enclosing them in braces, `/api/user/{var1}/details` or `{hostVar1}.example.com`. Cloudflare supports hostname variables in the following formats: @@ -84,9 +84,9 @@ foo.{hostVar1}.example.com {hostVar2}.{hostVar1}.example.com ``` -Hostname variables must comprise the entire domain field and must not be used with other text in the field. +Hostname variables must comprise the entire domain field and must not be used with other text in the field. -The following format is not supported: +The following format is not supported: ```txt @@ -119,7 +119,7 @@ To protect your API with a learned schema, refer to [Schema Validation](/api-shi :::note -The schema is saved as a JSON file in OpenAPI `v3.0.0` format. +The schema is saved as a JSON file in OpenAPI `v3.0.0` format. ::: #### Learned schemas will always include: @@ -148,7 +148,7 @@ For each saved endpoint, customers can view: :::note -Customers viewing analytics have the ability to toggle detailed metrics view between the last 24 hours and 7 days. +Customers viewing analytics have the ability to toggle detailed metrics view between the last 24 hours and 7 days. ::: ## Using the Cloudflare API