|
6 | 6 |
|
7 | 7 | --- |
8 | 8 |
|
9 | | -import { GlossaryDefinition, GlossaryTooltip } from "~/components" |
| 9 | +import { GlossaryDefinition, GlossaryTooltip, Plan } from "~/components" |
| 10 | + |
| 11 | +<Plan type="all" /> |
10 | 12 |
|
11 | 13 | <GlossaryDefinition term="API schema" /> |
12 | 14 |
|
@@ -69,6 +71,30 @@ At this time, learned schemas will not overwrite customer-uploaded schemas. If a |
69 | 71 | 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. |
70 | 72 | ::: |
71 | 73 |
|
| 74 | +### Add validation by adding a fallthrough rule |
| 75 | + |
| 76 | +A fallthrough rule acts as a catch-all for requests that do not match endpoints in [Endpoint Management](/api-shield/management-and-monitoring/). |
| 77 | + |
| 78 | +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. |
| 79 | + |
| 80 | +To set up a fallthrough action: |
| 81 | + |
| 82 | +1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. |
| 83 | +2. Go to **Security** > **API Shield**. |
| 84 | +3. Under **Settings**, go to **Fallthrough settings**. |
| 85 | +4. Select **Use Template**. |
| 86 | +5. Choose one or more hostnames from the drop down menu. The fallthrough rule will act on all traffic that does not match an existing endpoint in Endpoint Management to the selected hostnames. |
| 87 | +6. Select **Continue to custom rule**. |
| 88 | +7. Name your rule and select your action. |
| 89 | +8. Select **Save as draft** to deploy later, or **Deploy** to deploy now. |
| 90 | + |
| 91 | +Your current fallthrough rules can be viewed in the custom rules list or in API Shield's settings under **Fallthrough settings**. |
| 92 | + |
| 93 | +:::note |
| 94 | + |
| 95 | +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. |
| 96 | +::: |
| 97 | + |
72 | 98 | ### Change the action of an entire schema |
73 | 99 |
|
74 | 100 | 1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain. |
@@ -159,7 +185,9 @@ Schema Validation supports [OpenAPI Version 3.0.x schemas](https://spec.openapis |
159 | 185 |
|
160 | 186 | 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. |
161 | 187 |
|
162 | | -There is a limit of 10,000 total operations for enabled schemas. |
| 188 | +There is a limit of 10,000 total operations for enabled schemas for Enterprise customers subscribed to [API Gateway](/api-shield/api-gateway/). To raise this limit, contact your account team. |
| 189 | + |
| 190 | +For limits on Free, Pro, Business, or Enterprise customers not subscribed to API Gateway, refer to [Plans](/api-shield/plans/). |
163 | 191 |
|
164 | 192 | ### Required fields |
165 | 193 |
|
|
0 commit comments