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
Schema validation allows you to check if incoming traffic complies with a previously supplied API schema. When you provide an API schema or select from a list of learned schema, API Shield creates rules for incoming traffic from the schema definitions. These rules define which traffic is allowed and which traffic gets logged or blocked.
16
16
17
-
Cloudflare has recently launched Schema validation 2.0. For help configuring the previous version of Schema validation for one or more hosts using the dashboard, refer to [Configure Classic Schema validation](/api-shield/reference/classic-schema-validation/). You can make changes to your Classic Schema validation settings but you cannot add any new schemas.
17
+
Cloudflare has launched Schema validation 2.0. For help configuring the previous version of Schema validation for one or more hosts using the dashboard, refer to [Configure Classic Schema validation](/api-shield/reference/classic-schema-validation/). You can make changes to your Classic Schema validation settings but you cannot add any new schemas.
18
18
19
-
You can migrate to Schema validation 2.0 manually by uploading your schemas to the new system, or you can wait for a future release where we will add an easy migrate option per-schema.
19
+
You can migrate to Schema validation 2.0 manually by uploading your schemas to the new system.
20
20
21
21
## Process
22
22
23
-
<GlossaryTooltipterm="API endpoint">Endpoints</GlossaryTooltip> must be added to [Endpoint Management](/api-shield/management-and-monitoring/) for Schema validation to protect them. Uploading a schema via the Cloudflare dashboard will automatically add endpoints, or you can manually add them from [API Discovery](/api-shield/security/api-discovery/).
23
+
<GlossaryTooltipterm="API endpoint">Endpoints</GlossaryTooltip> must be added to [Endpoint Management](/api-shield/management-and-monitoring/endpoint-management/) for Schema validation to protect them. Uploading a schema via the Cloudflare dashboard will automatically add endpoints, or you can manually add them from [API Discovery](/api-shield/security/api-discovery/).
24
24
25
25
If you are uploading a schema via the API or Terraform, you must parse the schema and add your endpoints manually.
26
26
27
27
<GlossaryDefinitionterm="API endpoint" />
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/endpoint-management/schema-learning/#export-a-schema) in Endpoint Management.
32
32
:::
33
33
34
34
### Add validation by uploading a schema
@@ -118,7 +118,7 @@ If an endpoint is currently protected by a learned schema, the date of the last
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/endpoint-management/).
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
@@ -421,7 +421,6 @@ Refer to the information below for more details on Schema validation's current s
421
421
-`double`
422
422
-`password`
423
423
-`uuid`
424
-
- Soon to be validated formats:
425
424
-`byte`
426
425
-`uint64`
427
426
@@ -456,4 +455,6 @@ Media-ranges can also be configured to enforce a `charset` parameter. For this,
456
455
457
456
## Availability
458
457
459
-
Schema validation is available for all customers. Refer to [Plans](/api-shield/plans/) for more information based on your plan type.
458
+
Schema validation is available for all customers. Refer to [Plans](/api-shield/plans/) for more information based on your plan type.
459
+
460
+
[Schema learning](/api-shield/management-and-monitoring/endpoint-management/schema-learning/) is only available for customers subscribed to API Shield.
0 commit comments