You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Once your <GlossaryTooltipterm="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.
13
12
@@ -29,23 +28,25 @@ To create a developer portal:
29
28
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.
30
29
7. Select **Deploy site**.
31
30
</Steps>
31
+
32
32
</TabItem>
33
33
<TabItemlabel="New dashboard"icon="rocket">
34
34
<Steps>
35
35
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**.
37
37
3. Filter by **API abuse**.
38
38
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.
40
40
:::note
41
41
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.
42
42
43
43
Only <GlossaryTooltipterm="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas.
44
44
:::
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.
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/security/jwt-validation/index.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ A JWT validation configuration consists of creating a token validation configura
36
36
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
37
37
2. Go to **Security** > **Settings**.
38
38
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 **<N> out of <M> configurations used** instead.
40
40
5. Add a name for your configuration.
41
41
6. Choose where Cloudflare can locate the JWT for this configuration on incoming requests, such as a header or cookie and its name.
42
42
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
87
87
88
88
:::note
89
89
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.
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/security/schema-validation/index.mdx
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ If you are uploading a schema via the API or Terraform, you must parse the schem
28
28
29
29
:::note
30
30
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.
32
32
:::
33
33
34
34
### 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
48
48
<TabItemlabel="New dashboard"icon="rocket">
49
49
<Steps>
50
50
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**.
52
52
3. Select **Add validation**.
53
53
4. Upload a schema file.
54
54
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
57
57
</Tabs>
58
58
59
59
:::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.
61
61
:::
62
62
63
63
### 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
113
113
</Tabs>
114
114
115
115
:::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.
117
117
:::
118
118
119
119
### Add validation by adding a fallthrough rule
120
120
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/).
122
122
123
123
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.
124
124
@@ -136,22 +136,25 @@ To set up a fallthrough action:
136
136
7. Name your rule and select your action.
137
137
8. Select **Save as draft** to deploy later, or **Deploy** to deploy now.
138
138
</Steps>
139
+
140
+
Your current fallthrough rules can be viewed in the custom rules list.
141
+
139
142
</TabItem>
140
143
<TabItemlabel="New dashboard"icon="rocket">
141
144
<Steps>
142
145
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**.
146
149
5. Give your rule a descriptive name.
147
150
6. Choose one or more hostnames from the dropdown menu and select your action.
148
151
7. Select **Save as draft** to deploy later, or **Deploy** to deploy now.
149
152
</Steps>
153
+
154
+
Your current fallthrough rules can be viewed in the security rules list.
150
155
</TabItem>
151
156
</Tabs>
152
157
153
-
Your current fallthrough rules can be viewed in the custom rules list.
154
-
155
158
:::note
156
159
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.
157
160
:::
@@ -208,13 +211,11 @@ To change the default action:
208
211
<TabItemlabel="New dashboard"icon="rocket">
209
212
<Steps>
210
213
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**.
216
218
</Steps>
217
-
Alternatively, you can modify the global action via **Security** > **Settings** > **Schema Validation**.
218
219
</TabItem>
219
220
</Tabs>
220
221
@@ -241,11 +242,10 @@ To change the action on an individual endpoint:
241
242
<TabItemlabel="New dashboard"icon="rocket">
242
243
<Steps>
243
244
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**.
249
249
</Steps>
250
250
</TabItem>
251
251
</Tabs>
@@ -268,10 +268,10 @@ To disable Schema Validation without changing actions:
268
268
<TabItemlabel="New dashboard"icon="rocket">
269
269
<Steps>
270
270
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**.
272
272
3. Select **Schema settings**.
273
273
4. Filter by **API abuse**.
274
-
5. Turn **Schema Validation** off.
274
+
5. Turn **Schema validation** off.
275
275
</Steps>
276
276
</TabItem>
277
277
</Tabs>
@@ -293,10 +293,10 @@ Your per-endpoint configurations will be saved when modifying the setting, so th
293
293
<TabItemlabel="New dashboard"icon="rocket">
294
294
<Steps>
295
295
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.
297
297
3. Select **Schema settings**.
298
298
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**.
300
300
</Steps>
301
301
</TabItem>
302
302
</Tabs>
@@ -320,10 +320,10 @@ To delete currently uploaded or learned schemas:
320
320
<TabItemlabel="New dashboard"icon="rocket">
321
321
<Steps>
322
322
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.
324
324
3. Select **Schema settings**.
325
325
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**.
327
327
6. Select the ellipses to access the menu and download or delete the listed schema.
328
328
</Steps>
329
329
</TabItem>
@@ -337,11 +337,11 @@ OpenAPI schemas generated by different tooling may not be specific enough to imp
337
337
338
338
## Limitations
339
339
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.
341
341
342
342
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.
343
343
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.
345
345
346
346
For limits on Free, Pro, Business, or Enterprise customers not subscribed to API Shield, refer to [Plans](/api-shield/plans/).
347
347
@@ -456,4 +456,4 @@ Media-ranges can also be configured to enforce a `charset` parameter. For this,
456
456
457
457
## Availability
458
458
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.
Copy file name to clipboardExpand all lines: src/content/docs/bots/get-started/bot-management.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ This Enterprise product provides the most flexibility to customers by:
23
23
24
24
Bot Management is automatically enabled for Enterprise zones entitled with the add-on.
25
25
26
-
<TabssyncKey="dashNewNav">
26
+
<TabssyncKey="dashNewNav">
27
27
<TabItemlabel="Old dashboard">
28
28
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:
29
29
<Steps>
@@ -37,9 +37,9 @@ Bot Management is automatically enabled for Enterprise zones entitled with the a
37
37
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
38
38
2. Go to **Security** > **Settings**.
39
39
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.
43
43
- For more details on verified bots, refer to [Verified Bots](/bots/concepts/bot/#verified-bots).
44
44
- For more details on supported file types, refer to [Static resource protection](/bots/additional-configurations/static-resources/).
45
45
- For more details on invisible code injection, refer to [JavaScript detections](/bots/additional-configurations/javascript-detections/).
Copy file name to clipboardExpand all lines: src/content/docs/page-shield/get-started.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ If you do not have access to Page Shield in the Cloudflare dashboard, check if y
27
27
28
28
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
29
29
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**.
31
31
32
32
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/).
0 commit comments