Skip to content

Commit 345c30e

Browse files
pedrosousaOxyjun
andauthored
[Security] Update settings (new nav) (#23597)
--------- Co-authored-by: Jun Lee <[email protected]>
1 parent 9629284 commit 345c30e

File tree

24 files changed

+201
-131
lines changed

24 files changed

+201
-131
lines changed

src/content/docs/api-shield/management-and-monitoring/developer-portal.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,9 @@ type: overview
44
title: Build developer portals
55
sidebar:
66
order: 5
7-
87
---
98

10-
import { GlossaryTooltip, Tabs, TabItem, Steps } from "~/components"
9+
import { GlossaryTooltip, Tabs, TabItem, Steps } from "~/components";
1110

1211
Once your <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> are saved, API Shield doubles as an API catalog. API Shield can build an interactive documentation portal with the knowledge it has of your APIs, or you can upload a new OpenAPI schema file to build a documentation portal ad-hoc.
1312

@@ -29,23 +28,25 @@ To create a developer portal:
2928
6. Select **Create pages project** to begin project creation. A new Pages project will be automatically created and your API schema will be automatically uploaded to the project along with other supporting static content.
3029
7. Select **Deploy site**.
3130
</Steps>
31+
3232
</TabItem>
3333
<TabItem label="New dashboard" icon="rocket">
3434
<Steps>
3535
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
36-
2. Go to **Security** > **Settings**
36+
2. Go to **Security** > **Settings**.
3737
3. Filter by **API abuse**.
3838
4. On **Create a developer portal**, select **Create site**.
39-
4. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
39+
5. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
4040
:::note
4141
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.
4242

4343
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas.
4444
:::
45-
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.
46-
6. Select **Create pages project** to begin project creation. A new Pages project will be automatically created and your API schema will be automatically uploaded to the project along with other supporting static content.
47-
7. Select **Deploy site**.
45+
6. 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.
46+
7. Select **Create pages project** to begin project creation. A new Pages project will be automatically created and your API schema will be automatically uploaded to the project along with other supporting static content.
47+
8. Select **Deploy site**.
4848
</Steps>
49+
4950
</TabItem>
5051
</Tabs>
5152

src/content/docs/api-shield/management-and-monitoring/endpoint-labels.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Cloudflare will only add authentication labels to endpoints with successful resp
109109
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
110110
2. Go to **Security** > **Settings**.
111111
3. Filter by **API abuse**.
112-
4. Under **Endpoint labels**, select **Manage label**.
112+
4. Under **Endpoint labels**, select **Manage labels**.
113113
5. Name the label and add an optional label description.
114114
6. Apply the label to your selected endpoints.
115115
7. Select **Create label**.

src/content/docs/api-shield/security/jwt-validation/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ A JWT validation configuration consists of creating a token validation configura
3636
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
3737
2. Go to **Security** > **Settings**.
3838
3. Filter by **API abuse**.
39-
4. On **Token configurations**, select **Configure tokens**.
39+
4. On **Token configurations**, select **Configure tokens**. If you already have one or more tokens, select **&lt;N> out of &lt;M> configurations used** instead.
4040
5. Add a name for your configuration.
4141
6. Choose where Cloudflare can locate the JWT for this configuration on incoming requests, such as a header or cookie and its name.
4242
7. Copy and paste your JWT issuer's public key(s) (JWKS).
@@ -87,7 +87,7 @@ To automatically keep your JWKS up to date when your identity provider refreshes
8787

8888
:::note
8989

90-
Token configuration rules will automatically apply to new endpoints added to Endpoint Management if those endpoints also match the rule.
90+
Token configuration rules will automatically apply to new endpoints added to Endpoint Management if those endpoints also match the rule.
9191
:::
9292

9393
## Special cases

src/content/docs/api-shield/security/schema-validation/index.mdx

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If you are uploading a schema via the API or Terraform, you must parse the schem
2828

2929
:::note
3030

31-
To view the contents in your learned schema, refer to [Export a schema](/api-shield/management-and-monitoring/#export-a-schema) in Endpoint Management.
31+
To view the contents in your learned schema, refer to [Export a schema](/api-shield/management-and-monitoring/#export-a-schema) in Endpoint Management.
3232
:::
3333

3434
### Add validation by uploading a schema
@@ -48,7 +48,7 @@ To view the contents in your learned schema, refer to [Export a schema](/api-shi
4848
<TabItem label="New dashboard" icon="rocket">
4949
<Steps>
5050
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
51-
2. Go to **Security** > **Web assets** > **Schema Validation**.
51+
2. Go to **Security** > **Web assets** > **Schema validation**.
5252
3. Select **Add validation**.
5353
4. Upload a schema file.
5454
5. Select **Add schema and endpoints**.
@@ -57,7 +57,7 @@ To view the contents in your learned schema, refer to [Export a schema](/api-shi
5757
</Tabs>
5858

5959
:::note
60-
Changes may take a few minutes to process depending on the number of added endpoints.
60+
Changes may take a few minutes to process depending on the number of added endpoints.
6161
:::
6262

6363
### Add validation by applying a learned schema to a single endpoint
@@ -113,12 +113,12 @@ At this time, learned schemas will not overwrite customer-uploaded schemas. If a
113113
</Tabs>
114114

115115
:::note
116-
If an endpoint is currently protected by a learned schema, the date of the last applied learned schema will be shown in the current schema field.
116+
If an endpoint is currently protected by a learned schema, the date of the last applied learned schema will be shown in the current schema field.
117117
:::
118118

119119
### Add validation by adding a fallthrough rule
120120

121-
A fallthrough rule acts as a catch-all for requests that do not match endpoints in [Endpoint Management](/api-shield/management-and-monitoring/).
121+
A fallthrough rule acts as a catch-all for requests that do not match endpoints in [Endpoint Management](/api-shield/management-and-monitoring/).
122122

123123
By ensuring that all your endpoints in a schema are added to Endpoint Management, the fallthrough action can protect you against legacy or zombie endpoints that your team may be unaware of.
124124

@@ -136,22 +136,25 @@ To set up a fallthrough action:
136136
7. Name your rule and select your action.
137137
8. Select **Save as draft** to deploy later, or **Deploy** to deploy now.
138138
</Steps>
139+
140+
Your current fallthrough rules can be viewed in the custom rules list.
141+
139142
</TabItem>
140143
<TabItem label="New dashboard" icon="rocket">
141144
<Steps>
142145
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
143-
2. Go to **Security** > **Settings**.
144-
3. Filter by **API abuse**.
145-
4. Under **Custom fallthrough rules**, select **Create custom fallthrough rule** to create a custom fallthrough rule with the template.
146+
2. Go to **Security** > **Security rules**.
147+
3. Select **Templates**.
148+
4. Search for the template named `Mitigate API requests to unidentified endpoints` and select **Preview template**.
146149
5. Give your rule a descriptive name.
147150
6. Choose one or more hostnames from the dropdown menu and select your action.
148151
7. Select **Save as draft** to deploy later, or **Deploy** to deploy now.
149152
</Steps>
153+
154+
Your current fallthrough rules can be viewed in the security rules list.
150155
</TabItem>
151156
</Tabs>
152157

153-
Your current fallthrough rules can be viewed in the custom rules list.
154-
155158
:::note
156159
You can use the `cf.api_gateway.fallthrough_triggered` syntax in your own custom rule for a more customized logic check. This detection will evaluate as `true` when a request does not match an endpoint in Endpoint Management, so it is important to check against your API's hostname or root path to ensure that you are not blocking any non-API traffic on your zone.
157160
:::
@@ -208,13 +211,11 @@ To change the default action:
208211
<TabItem label="New dashboard" icon="rocket">
209212
<Steps>
210213
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
211-
2. Go to **Security** > **Web assets** > **Schema Validation**.
212-
3. Select **Schema Validation**.
213-
4. Under the default `Log` action, select **Change**.
214-
5. Choose a new action from the dropdown menu.
215-
6. Observe the current action and accept the change by selecting **Change default action** in the popup window.
214+
2. Go to **Security** > **Settings** and filter by **API abuse**.
215+
3. Under **Schema validation** > **Configurations**, select the edit icon next to **Default action**.
216+
4. Choose a new action from the dropdown menu.
217+
5. Select **Save**.
216218
</Steps>
217-
Alternatively, you can modify the global action via **Security** > **Settings** > **Schema Validation**.
218219
</TabItem>
219220
</Tabs>
220221

@@ -241,11 +242,10 @@ To change the action on an individual endpoint:
241242
<TabItem label="New dashboard" icon="rocket">
242243
<Steps>
243244
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
244-
2. Go to **Security** > **Web assets** > **Schema Validation**.
245-
3. Select **Schema Validation** and filter the selected endpoint.
246-
4. Select the ellipses on the endpoint's row.
247-
5. Select **Change action**.
248-
6. Choose a new action from the dropdown menu and select **Set action**.
245+
2. Go to **Security** > **Web assets** > **Schema validation** tab.
246+
3. Search for the endpoint to change.
247+
4. Select the three dots on the endpoint's row > **Change action**.
248+
5. Choose a new action from the dropdown menu and select **Set action**.
249249
</Steps>
250250
</TabItem>
251251
</Tabs>
@@ -268,10 +268,10 @@ To disable Schema Validation without changing actions:
268268
<TabItem label="New dashboard" icon="rocket">
269269
<Steps>
270270
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
271-
2. Go to **Security** > **Web assets** > **Schema Validation**.
271+
2. Go to **Security** > **Web assets** > **Schema validation**.
272272
3. Select **Schema settings**.
273273
4. Filter by **API abuse**.
274-
5. Turn **Schema Validation** off.
274+
5. Turn **Schema validation** off.
275275
</Steps>
276276
</TabItem>
277277
</Tabs>
@@ -293,10 +293,10 @@ Your per-endpoint configurations will be saved when modifying the setting, so th
293293
<TabItem label="New dashboard" icon="rocket">
294294
<Steps>
295295
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
296-
2. Go to **Security** > **Web assets** > **Schema Validation**.
296+
2. Go to **Security** > **Web assets** > **Schema validation** tab.
297297
3. Select **Schema settings**.
298298
4. Filter by **API abuse**.
299-
5. View your schemas on **Schema Validation** > **Active schemas**.
299+
5. View your schemas on **Schema validation** > **Active schemas**.
300300
</Steps>
301301
</TabItem>
302302
</Tabs>
@@ -320,10 +320,10 @@ To delete currently uploaded or learned schemas:
320320
<TabItem label="New dashboard" icon="rocket">
321321
<Steps>
322322
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
323-
2. Go to **Security** > **Web assets** > **Schema Validation**.
323+
2. Go to **Security** > **Web assets** > **Schema validation** tab.
324324
3. Select **Schema settings**.
325325
4. Filter by **API abuse**.
326-
5. View your schemas on **Schema Validation** > **Active schemas**.
326+
5. View your schemas on **Schema validation** > **Active schemas**.
327327
6. Select the ellipses to access the menu and download or delete the listed schema.
328328
</Steps>
329329
</TabItem>
@@ -337,11 +337,11 @@ OpenAPI schemas generated by different tooling may not be specific enough to imp
337337

338338
## Limitations
339339

340-
Schema Validation supports [OpenAPI Version 3.0.x schemas](https://spec.openapis.org/oas/v3.0.3). OpenAPI 3.1 is not supported yet, and we do not plan to expand support for OpenAPI 2.0.
340+
Schema Validation supports [OpenAPI Version 3.0.x schemas](https://spec.openapis.org/oas/v3.0.3). OpenAPI 3.1 is not supported yet, and we do not plan to expand support for OpenAPI 2.0.
341341

342342
Currently, API Shield does not support some features of API schemas, including the following: all responses, external references, non-basic path templating, or unique items.
343343

344-
There is a limit of 10,000 total operations for enabled schemas for Enterprise customers subscribed to [API Shield](/api-shield/). To raise this limit, contact your account team.
344+
There is a limit of 10,000 total operations for enabled schemas for Enterprise customers subscribed to [API Shield](/api-shield/). To raise this limit, contact your account team.
345345

346346
For limits on Free, Pro, Business, or Enterprise customers not subscribed to API Shield, refer to [Plans](/api-shield/plans/).
347347

@@ -456,4 +456,4 @@ Media-ranges can also be configured to enforce a `charset` parameter. For this,
456456

457457
## Availability
458458

459-
Schema Validation is available for all customers. Refer to [Plans](/api-shield/plans/) for more information based on your plan type.
459+
Schema Validation is available for all customers. Refer to [Plans](/api-shield/plans/) for more information based on your plan type.

src/content/docs/bots/additional-configurations/managed-robots-txt.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,24 +47,24 @@ If your website does not have a `robots.txt` file, Cloudflare creates a new file
4747

4848
To implement a `robots.txt` file on your domain:
4949

50-
<Tabs syncKey="dashNewNav">
50+
<Tabs syncKey="dashNewNav">
5151
<TabItem label="Old dashboard">
5252
<Steps>
5353
<Render
5454
file="enable-managed-robots-txt"
5555
params={{ one: "Bot Fight Mode" }}
5656
/>
5757
</Steps>
58-
</TabItem>
58+
</TabItem>
5959
<TabItem label="New dashboard" icon="rocket">
6060
<Steps>
6161
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
6262
2. Go to **Security** > **Settings**.
6363
3. Filter by **Bot traffic**.
64-
4. Go to **Managed robots.txt**.
65-
5. Turn **Managed robots.txt** on.
64+
4. Go to **Manage AI bot traffic with robots.txt**.
65+
5. Turn **Manage AI bot traffic with robots.txt** on.
6666
</Steps>
67-
</TabItem>
67+
</TabItem>
6868
</Tabs>
6969

7070
## Availability

src/content/docs/bots/get-started/bot-management.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This Enterprise product provides the most flexibility to customers by:
2323

2424
Bot Management is automatically enabled for Enterprise zones entitled with the add-on.
2525

26-
<Tabs syncKey="dashNewNav">
26+
<Tabs syncKey="dashNewNav">
2727
<TabItem label="Old dashboard">
2828
To enable a [Bot Management](https://dash.cloudflare.com/?to=/:account/:zone/security/bots) trial on Enterprise zones without the Bot Management add-on entitled:
2929
<Steps>
@@ -37,9 +37,9 @@ Bot Management is automatically enabled for Enterprise zones entitled with the a
3737
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
3838
2. Go to **Security** > **Settings**.
3939
3. Filter by **Bot traffic**.
40-
4. Go to **Bot Management**.
41-
5. Turn **Bot Management** on.
42-
6. Choose how your domain should respond to various types of traffic by selecting the associated edit icon.
40+
4. Go to **Bot management**.
41+
5. Turn **Bot management** on.
42+
6. Choose how your domain should respond to various types of traffic by selecting the associated edit icon.
4343
- For more details on verified bots, refer to [Verified Bots](/bots/concepts/bot/#verified-bots).
4444
- For more details on supported file types, refer to [Static resource protection](/bots/additional-configurations/static-resources/).
4545
- For more details on invisible code injection, refer to [JavaScript detections](/bots/additional-configurations/javascript-detections/).

src/content/docs/cloudflare-challenges/challenge-types/challenge-pages/challenge-passage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To update the Challenge Passage (and the value of the `cf_clearance` cookie):
2424
1. Log into the [Cloudflare dashboard](https://dash.cloudflare.com).
2525
2. Select your account and domain.
2626
3. Go to **Security** > **Settings**.
27-
4. For **Challenge Passage**, set a duration.
27+
4. For **Challenge passage**, set a timeout duration.
2828

2929
### Limitations
3030

src/content/docs/page-shield/get-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you do not have access to Page Shield in the Cloudflare dashboard, check if y
2727

2828
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2929
2. Go to **Security** > **Settings** and filter by **Client side abuse**.
30-
3. Next to **Continuous script monitoring**, set the toggle to **On**.
30+
3. Turn on **Continuous script monitoring**.
3131

3232
If you do not have access to resource monitoring in the Cloudflare dashboard, check if your user has one of the [necessary roles](/page-shield/reference/roles-and-permissions/).
3333

0 commit comments

Comments
 (0)