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
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/api-gateway.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
@@ -9,7 +9,7 @@ sidebar:
9
9
10
10
API Gateway is a package of features that will do everything for your APIs, including:
11
11
12
-
-**Security**: Protect your API from malicious traffic with [API Discovery](/api-shield/security/api-discovery/), [Schema Validation](/api-shield/security/schema-validation/), [mTLS validation](/api-shield/security/mtls/), and more.
12
+
-**Security**: Protect your API from malicious traffic with [API Discovery](/api-shield/security/api-discovery/), [Schema validation](/api-shield/security/schema-validation/), [mTLS validation](/api-shield/security/mtls/), and more.
13
13
-**Management and monitoring**: Streamline API management with [Endpoint Management](/api-shield/management-and-monitoring/) and [tools](https://blog.cloudflare.com/api-gateway/) like analytics, routing, and authentication.
14
14
-**Logging, quota management, and more**: All of Cloudflare's [established features](https://blog.cloudflare.com/api-gateway/), like caching, load balancing, and log integrations work natively with API Gateway.
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/frequently-asked-questions.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
@@ -59,7 +59,7 @@ Not currently.
59
59
60
60
## What version of OpenAPI specification do you support?
61
61
62
-
The importing ([Schema Validation](/api-shield/security/schema-validation/)) and exporting ([Schema Learning](/api-shield/management-and-monitoring/#endpoint-schema-learning)) of OpenAPI schemas from our product to customers is done using **OpenAPI v3.0**. Any specifications using patched versions (3.0.x) are compatible as well.
62
+
The importing ([Schema validation](/api-shield/security/schema-validation/)) and exporting ([Schema Learning](/api-shield/management-and-monitoring/#endpoint-schema-learning)) of OpenAPI schemas from our product to customers is done using **OpenAPI v3.0**. Any specifications using patched versions (3.0.x) are compatible as well.
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/get-started.mdx
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,15 +26,15 @@ Enabling API Shield features will have no impact on your traffic until you choos
26
26
27
27
<Renderfile="set-up-session-identifiers" />
28
28
29
-
## Upload a schema using Schema Validation (optional)
29
+
## Upload a schema using Schema validation (optional)
30
30
31
-
Schema Validation protects your APIs by ensuring only requests matching your <GlossaryTooltipterm="API schema">API schema</GlossaryTooltip> are allowed to communicate with your origin.
31
+
Schema validation protects your APIs by ensuring only requests matching your <GlossaryTooltipterm="API schema">API schema</GlossaryTooltip> are allowed to communicate with your origin.
32
32
33
-
While not strictly required, uploading a pre-existing schema will offer the chance to automatically add endpoints to Endpoint Management. If you already have a schema, you can upload it to [Schema Validation](/api-shield/security/schema-validation/).
33
+
While not strictly required, uploading a pre-existing schema will offer the chance to automatically add endpoints to Endpoint Management. If you already have a schema, you can upload it to [Schema validation](/api-shield/security/schema-validation/).
34
34
35
35
:::note
36
36
37
-
It is recommended to start with Schema Validation rules set to `log` to review logged requests in **Security** > **Events**. When you are confident that only the correct requests are logged, you should switch the rule to `block`.
37
+
It is recommended to start with Schema validation rules set to `log` to review logged requests in **Security** > **Events**. When you are confident that only the correct requests are logged, you should switch the rule to `block`.
38
38
:::
39
39
40
40
If you do not have a schema to upload, continue reading this guide to learn how to generate a schema with API Shield.
@@ -56,10 +56,10 @@ Cloudflare’s machine learning models have already inspected your existing traf
56
56
57
57
:::note
58
58
59
-
Schema Validation, Schema Learning, JWT Validation, Sequence Analytics, Sequence Mitigation, and rate limit recommendations only run on endpoints saved to Endpoint Management.
59
+
Schema validation, Schema Learning, JWT validation, Sequence Analytics, Sequence Mitigation, and rate limit recommendations only run on endpoints saved to Endpoint Management.
60
60
:::
61
61
62
-
You can save your endpoints directly from [API Discovery](/api-shield/management-and-monitoring/#add-endpoints-from-api-discovery), [Schema Validation](/api-shield/management-and-monitoring/#add-endpoints-from-schema-validation), or [manually](/api-shield/management-and-monitoring/#add-endpoints-manually) by method, path, and host.
62
+
You can save your endpoints directly from [API Discovery](/api-shield/management-and-monitoring/#add-endpoints-from-api-discovery), [Schema validation](/api-shield/management-and-monitoring/#add-endpoints-from-schema-validation), or [manually](/api-shield/management-and-monitoring/#add-endpoints-manually) by method, path, and host.
63
63
64
64
This will add the specified endpoints to your list of managed endpoints. You can view your list of saved endpoints in the **Endpoint Management** page.
65
65
@@ -81,7 +81,7 @@ We recommend proceeding with [additional configurations](/api-shield/get-started
81
81
82
82
You can observe Cloudflare suggested rate limits in Endpoint Management for endpoints using session identifiers. Unlike many security tools, these recommended rate limits are per-endpoint and per-session, not site-wide and not based on IP address. When creating a rule, it will be based on only traffic to that specific endpoint from unique visitors during their session. This feature allows you to be very specific and targeted with your rate limit enforcement, both lowering abusive traffic and false positives due to broadly scoped rules.
83
83
84
-
## Import a learned schema to Schema Validation
84
+
## Import a learned schema to Schema validation
85
85
86
86
Cloudflare learns schema parameters via traffic inspection for all endpoints stored in Endpoint Management. You can export OpenAPI schemas in OpenAPI v3.0.0 format by hostname.
87
87
@@ -103,15 +103,15 @@ You can observe the top sequences in your API traffic that contain endpoints sto
103
103
104
104
[Sequence Mitigation](/api-shield/security/sequence-mitigation/) allows you to enforce request patterns for authenticated clients communicating with your API. Use Sequence Analytics to better understand the request sequences used by your API clients.
105
105
106
-
You should apply all possible API Shield protections (rate limiting suggestions, Schema Validation, JWT Validation, and mTLS) to API endpoints found in high correlation score sequences that make up the critical request flows in your application. You should also check their specific endpoint order with your development team.
106
+
You should apply all possible API Shield protections (rate limiting suggestions, Schema validation, JWT validation, and mTLS) to API endpoints found in high correlation score sequences that make up the critical request flows in your application. You should also check their specific endpoint order with your development team.
107
107
108
108
For more information, refer to [Detecting API abuse automatically using sequence analysis](https://blog.cloudflare.com/api-sequence-analytics) blog post.
109
109
110
110
## Additional configuration
111
111
112
-
### Set up JSON Web Tokens (JWT) Validation
112
+
### Set up JSON Web Tokens (JWT) validation
113
113
114
-
Use the Cloudflare API to configure [JSON Web Tokens Validation](/api-shield/security/jwt-validation/), which validates the integrity and validity of JWTs sent by clients to your API or web application.
114
+
Use the Cloudflare API to configure [JSON Web Tokens validation](/api-shield/security/jwt-validation/), which validates the integrity and validity of JWTs sent by clients to your API or web application.
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/index.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
@@ -40,7 +40,7 @@ A package of features that will do everything for your APIs.
40
40
41
41
Cloudflare API Security products are available to Enterprise customers only, though anyone can set up [Mutual TLS](/api-shield/security/mtls/) with a Cloudflare-managed certificate authority.
42
42
43
-
The full API Shield security suite is available as an Enterprise-only paid add-on, but all customers can access [Endpoint Management](/api-shield/management-and-monitoring/) and [Schema Validation](/api-shield/security/schema-validation/) functionalities.
43
+
The full API Shield security suite is available as an Enterprise-only paid add-on, but all customers can access [Endpoint Management](/api-shield/management-and-monitoring/) and [Schema validation](/api-shield/security/schema-validation/) functionalities.
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/management-and-monitoring/developer-portal.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
@@ -22,7 +22,7 @@ Once <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> are saved
22
22
23
23
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.
24
24
25
-
Only <GlossaryTooltipterm="API schema">API schemas</GlossaryTooltip> uploaded to Schema Validation 2.0 are available when selecting existing schemas
25
+
Only <GlossaryTooltipterm="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
26
26
:::
27
27
28
28
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.
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/management-and-monitoring/index.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
@@ -29,7 +29,7 @@ When an endpoint is using [Cloudflare Workers](/workers/), the metrics data will
29
29
30
30
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
31
31
2. Select **Security** > **API Shield**.
32
-
3. Add your endpoints [manually](#add-endpoints-manually), from [Schema Validation](#add-endpoints-from-schema-validation), or from [API Discovery](#add-endpoints-from-api-discovery).
32
+
3. Add your endpoints [manually](#add-endpoints-manually), from [Schema validation](#add-endpoints-from-schema-validation), or from [API Discovery](#add-endpoints-from-api-discovery).
33
33
34
34
## Add endpoints from API Discovery
35
35
@@ -47,9 +47,9 @@ There are two ways to add API endpoints from Discovery.
47
47
2. Select the discovered endpoints you would like to add.
48
48
3. Select **Save selected endpoints**.
49
49
50
-
## Add endpoints from Schema Validation
50
+
## Add endpoints from Schema validation
51
51
52
-
1. Add a schema by [configuring Schema Validation](/api-shield/security/schema-validation/).
52
+
1. Add a schema by [configuring Schema validation](/api-shield/security/schema-validation/).
53
53
2. On **Review schema endpoints**, save new endpoints to endpoint management by checking the box.
54
54
3. Select **Save as draft** or **Save and Deploy**. Endpoints will be saved regardless of whether the Schema is saved as a draft or published.
55
55
@@ -106,7 +106,7 @@ You can delete endpoints one at a time or in bulk.
106
106
107
107
Cloudflare learns schema parameters via traffic inspection. For all endpoints saved to Endpoint Management, you can export OpenAPI schemas in `v3.0.0` format by hostname. You can also include learned schema parameters.
108
108
109
-
To protect your API with a learned schema, refer to [Schema Validation](/api-shield/security/schema-validation/#add-validation-by-applying-a-learned-schema-to-an-entire-hostname).
109
+
To protect your API with a learned schema, refer to [Schema validation](/api-shield/security/schema-validation/#add-validation-by-applying-a-learned-schema-to-an-entire-hostname).
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/plans.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
@@ -7,11 +7,11 @@ sidebar:
7
7
8
8
---
9
9
10
-
Free, Pro, Business, and Enterprise customers without an API Gateway subcription can access [Endpoint Management](/api-shield/management-and-monitoring/) and [Schema Validation](/api-shield/security/schema-validation/), but no other [API Gateway](/api-shield/api-gateway/) features.
10
+
Free, Pro, Business, and Enterprise customers without an API Gateway subscription can access [Endpoint Management](/api-shield/management-and-monitoring/) and [Schema validation](/api-shield/security/schema-validation/), but no other [API Gateway](/api-shield/api-gateway/) features.
11
11
12
12
To subscribe to API Gateway, upgrade to an Enterprise plan and contact your account team.
13
13
14
-
Limits to endpoints apply to Endpoint Management and Schema Validation. Refer to the table below for limits based on your zone plan.
14
+
Limits to endpoints apply to Endpoint Management and Schema validation. Refer to the table below for limits based on your zone plan.
15
15
16
16
| Plan type | Saved endpoints | Uploaded schemas | Total uploaded schema size | Rule action |
Upload all new schemas to [Schema Validation 2.0](/api-shield/security/schema-validation/).
21
+
Upload all new schemas to [Schema validation 2.0](/api-shield/security/schema-validation/).
22
22
:::
23
23
24
-
Use the **API Shield** interface to configure [API Schema Validation](/api-shield/security/schema-validation/), which validates requests according to the <GlossaryTooltipterm="API schema">API schema</GlossaryTooltip> you provide.
24
+
Use the **API Shield** interface to configure [API Schema validation](/api-shield/security/schema-validation/), which validates requests according to the <GlossaryTooltipterm="API schema">API schema</GlossaryTooltip> you provide.
25
25
26
-
Before you can configure Schema Validation for an API, you must obtain an API Schema file matching our [specifications](/api-shield/security/schema-validation/#specifications).
26
+
Before you can configure Schema validation for an API, you must obtain an API Schema file matching our [specifications](/api-shield/security/schema-validation/#specifications).
27
27
28
-
If you are in the Schema Validation 2.0, you can make changes to your settings but you cannot add any new Classic Schema Validation schemas.
28
+
If you are in the Schema validation 2.0, you can make changes to your settings but you cannot add any new Classic Schema validation schemas.
29
29
30
30
:::note
31
31
32
32
This feature is only available for customers on an Enterprise plan. Contact your Cloudflare Customer Success Manager to get access.
33
33
:::
34
34
35
-
## Create an API Shield with Schema Validation
35
+
## Create an API Shield with Schema validation
36
36
37
-
To configure Schema Validation in the Cloudflare dashboard:
37
+
To configure Schema validation in the Cloudflare dashboard:
38
38
39
39
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account and domain.
40
40
2. Select **Security** > **API Shield**.
41
-
3. Go to **Schema Validation** and select **Add schema**.
42
-
4. Enter a descriptive name for your policy and optionally edit the expression to trigger Schema Validation. For example, if your API is available at `http://api.example.com/v1`, include a check for the *Hostname* field — equal to `api.example.com` — and a check for the *URI Path* field using a regular expression — matching the regex `^/v1`.
41
+
3. Go to **Schema validation** and select **Add schema**.
42
+
4. Enter a descriptive name for your policy and optionally edit the expression to trigger Schema validation. For example, if your API is available at `http://api.example.com/v1`, include a check for the *Hostname* field — equal to `api.example.com` — and a check for the *URI Path* field using a regular expression — matching the regex `^/v1`.
43
43
:::caution[Important]
44
44
45
45
To validate the hostname, you must include the *Hostname* field explicitly in the rule, even if the hostname value is in the schema file. Any hostname value present in the schema file will be ignored.
46
46
:::
47
47
5. Select **Next**.
48
48
6. Upload your schema file.
49
-
7. Select **Save** to validate the content of the schema file and deploy the Schema Validation rule. If you get a validation error, ensure that you are using one of the [supported file formats](/api-shield/security/schema-validation/#specifications) and that each endpoint and method pair has a unique operation ID.
49
+
7. Select **Save** to validate the content of the schema file and deploy the Schema validation rule. If you get a validation error, ensure that you are using one of the [supported file formats](/api-shield/security/schema-validation/#specifications) and that each endpoint and method pair has a unique operation ID.
50
50
51
51
After deploying your API Shield rule, Cloudflare displays a summary of all <GlossaryTooltipterm="API endpoint">API endpoints</GlossaryTooltip> organized by their protection level and actions that will occur for non-compliant and unprotected requests.
52
52
53
-
1. In the **Endpoint action** dropdown, select an action for every request that targets a protected endpoint and fails Schema Validation.
53
+
1. In the **Endpoint action** dropdown, select an action for every request that targets a protected endpoint and fails Schema validation.
54
54
2. In the **Fallthrough action** dropdown, select an action for every request that targets an unprotected endpoint.
55
55
3. Optionally, you can save the endpoints to Endpoint Management at the same time the Schema is saved by selecting **Save new endpoints to [endpoint management](/api-shield/management-and-monitoring/)**. Endpoints will be saved regardless of whether the Schema is saved as a draft or published live.
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/reference/terraform.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,11 +18,11 @@ The following resources are available to configure through Terraform:
18
18
19
19
-[`api_shield_operation`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_operation) for configuring <GlossaryTooltipterm="API endpoint">endpoints</GlossaryTooltip> in Endpoint Management.
20
20
21
-
**Schema Validation 2.0**
21
+
**Schema validation 2.0**
22
22
23
-
-[`api_shield_schema`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_schema) for configuring a schema in [Schema Validation 2.0](/api-shield/security/schema-validation/).
24
-
-[`api_shield_schema_validation_settings`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_schema_validation_settings) for configuring zone-level Schema Validation 2.0 settings.
25
-
-[`api_shield_operation_schema_validation_settings`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_operation_schema_validation_settings) for configuring operation-level Schema Validation 2.0 settings.
23
+
-[`api_shield_schema`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_schema) for configuring a schema in [Schema validation 2.0](/api-shield/security/schema-validation/).
24
+
-[`api_shield_schema_validation_settings`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_schema_validation_settings) for configuring zone-level Schema validation 2.0 settings.
25
+
-[`api_shield_operation_schema_validation_settings`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_operation_schema_validation_settings) for configuring operation-level Schema validation 2.0 settings.
0 commit comments