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/management-and-monitoring/api-routing/configure.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
@@ -12,7 +12,7 @@ API Shield Routing enables customers to create a unified external-facing API tha
12
12
13
13
:::note
14
14
15
-
The term **Source Endpoint** refers to the endpoint managed by API Shield in Endpoint Management. The term **Target Endpoint** refers to the ultimate destination the request is sent to by the Routing feature.
15
+
The term **Source Endpoint** refers to the endpoint managed by API Shield in Endpoint Management. The term **Target Endpoint** refers to the ultimate destination the request is sent to by the Routing feature.
16
16
:::
17
17
18
18
## Process
@@ -84,7 +84,7 @@ If API Shield returns unexpected results, check your Source Endpoint host, metho
84
84
85
85
:::note
86
86
87
-
You may need to wait up to five minutes for route changes to synchronize across the Cloudflare network.
87
+
You may need to wait up to five minutes for route changes to synchronize across the Cloudflare network.
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/management-and-monitoring/api-routing/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
@@ -13,7 +13,7 @@ API Shield Routing enables customers to create a unified external-facing API tha
13
13
14
14
:::note
15
15
16
-
The term **Source Endpoint** refers to the endpoint managed by API Shield in Endpoint Management. The term **Target Endpoint** refers to the ultimate destination the request is sent to by the Routing feature.
16
+
The term **Source Endpoint** refers to the endpoint managed by API Shield in Endpoint Management. The term **Target Endpoint** refers to the ultimate destination the request is sent to by the Routing feature.
17
17
:::
18
18
19
19
## Process
@@ -48,7 +48,7 @@ If API Shield returns unexpected results, check your Source Endpoint host, metho
48
48
49
49
:::note
50
50
51
-
You may need to wait up to five minutes for Route changes to synchronize across the Cloudflare network.
51
+
You may need to wait up to five minutes for Route changes to synchronize across the Cloudflare network.
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/endpoint-labels.mdx
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Today, managed labels are useful for organizing endpoints by use case. In a futu
16
16
17
17
User-defined labels can also be added to endpoints in API Shield by creating a label and adding it to an individual endpoint or multiple endpoints. User-defined labels will be useful for organizing your endpoints by owner, version, or type.
18
18
19
-
You can filter your endpoints based on the labels.
19
+
You can filter your endpoints based on the labels.
20
20
21
21
## Managed labels
22
22
@@ -32,7 +32,7 @@ You can filter your endpoints based on the labels.
32
32
33
33
`cf-add-cart`: Add this label to endpoints that add items to a user's shopping cart or verify item availability.
34
34
35
-
`cf-add-payment`: Add this label to endpoints that accept credit card or bank account details where fraudsters may iterate through account numbers to guess valid combinations of payment information.
35
+
`cf-add-payment`: Add this label to endpoints that accept credit card or bank account details where fraudsters may iterate through account numbers to guess valid combinations of payment information.
36
36
37
37
`cf-check-value`: Add this label to endpoints that check the balance of rewards points, in-game currency, or other stored value products that can be earned, transferred, and redeemed for cash or physical goods.
38
38
@@ -44,7 +44,7 @@ You can filter your endpoints based on the labels.
44
44
45
45
`cf-risk-missing-auth`: Automatically added when all successful requests lack a session identifier. Refer to the table below for more information.
46
46
47
-
`cf-risk-mixed-auth`: Automatically added when some successful requests contain a session identifier and some successful requests lack a session identifier. Refer to the table below for more information.
47
+
`cf-risk-mixed-auth`: Automatically added when some successful requests contain a session identifier and some successful requests lack a session identifier. Refer to the table below for more information.
48
48
49
49
`cf-risk-sensitive`: Cloudflare will automatically add this label to endpoints when HTTP responses match the WAF's [Sensitive Data Detection](/api-shield/management-and-monitoring/#sensitive-data-detection) ruleset.
50
50
@@ -56,39 +56,39 @@ Cloudflare will only add authentication labels to endpoints with successful resp
56
56
57
57
## Create a label
58
58
59
-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
59
+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
60
60
2. Go to **Security** > **Settings** > **Labels**.
61
61
3. Under **Security labels**, select **Create label**.
62
-
4. Name the label and add an optional label description.
63
-
5. Apply the label to your selected endpoints.
64
-
6. Select **Create label**.
62
+
4. Name the label and add an optional label description.
63
+
5. Apply the label to your selected endpoints.
64
+
6. Select **Create label**.
65
65
66
-
Alternatively, you can create a user-defined label via Endpoint Management in API Shield.
66
+
Alternatively, you can create a user-defined label via Endpoint Management in API Shield.
67
67
68
-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
68
+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
69
69
2. Go to **Security** > **Settings** > **Labels**.
70
-
3. Choose the endpoint that you want to label.
70
+
3. Choose the endpoint that you want to label.
71
71
4. Select **Edit labels**.
72
-
5. Under **User**, select **Create user label**.
73
-
6. Enter the label name.
74
-
7. Select **Create**.
72
+
5. Under **User**, select **Create user label**.
73
+
6. Enter the label name.
74
+
7. Select **Create**.
75
75
76
76
## Apply a label to an individual endpoint
77
77
78
-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
78
+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
79
79
2. Go to **Security** > **API Shield** > **Endpoint Management**.
80
-
3. Choose the endpoint that you want to label.
80
+
3. Choose the endpoint that you want to label.
81
81
4. Select **Edit labels**.
82
-
5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels.
83
-
6. Select **Save labels**.
82
+
5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels.
83
+
6. Select **Save labels**.
84
84
85
85
## Bulk apply labels to multiple endpoints
86
86
87
-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
87
+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
88
88
2. Go to **Security** > **Settings** > **Labels**.
89
-
3. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**.
90
-
4. Choose the endpoints that you want to label by selecting its checkbox.
91
-
5. Select **Save label**.
89
+
3. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**.
90
+
4. Choose the endpoints that you want to label by selecting its checkbox.
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/management-and-monitoring/index.mdx
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Cloudflare will start collecting [performance data](/api-shield/management-and-m
22
22
23
23
:::note
24
24
25
-
When an endpoint is using [Cloudflare Workers](/workers/), the metrics data will not be populated.
25
+
When an endpoint is using [Cloudflare Workers](/workers/), the metrics data will not be populated.
26
26
:::
27
27
28
28
## Access
@@ -57,7 +57,7 @@ API Shield will look for duplicate endpoints that have the same host, method, an
57
57
58
58
:::note
59
59
60
-
If you deselect **Save new endpoints to endpoint management**, the endpoints will not be added.
60
+
If you deselect **Save new endpoints to endpoint management**, the endpoints will not be added.
61
61
:::
62
62
63
63
## Add endpoints manually
@@ -68,10 +68,10 @@ If you deselect **Save new endpoints to endpoint management**, the endpoints wil
68
68
69
69
:::note
70
70
71
-
By selecting multiple checkboxes, you can add several endpoints from Discovery at once instead of individually.
71
+
By selecting multiple checkboxes, you can add several endpoints from Discovery at once instead of individually.
72
72
:::
73
73
74
-
When adding an endpoint manually, you can specify variable fields in the path or host by enclosing them in braces, `/api/user/{var1}/details` or `{hostVar1}.example.com`.
74
+
When adding an endpoint manually, you can specify variable fields in the path or host by enclosing them in braces, `/api/user/{var1}/details` or `{hostVar1}.example.com`.
75
75
76
76
Cloudflare supports hostname variables in the following formats:
77
77
@@ -84,9 +84,9 @@ foo.{hostVar1}.example.com
84
84
{hostVar2}.{hostVar1}.example.com
85
85
```
86
86
87
-
Hostname variables must comprise the entire domain field and must not be used with other text in the field.
87
+
Hostname variables must comprise the entire domain field and must not be used with other text in the field.
88
88
89
-
The following format is not supported:
89
+
The following format is not supported:
90
90
91
91
```txt
92
92
@@ -119,7 +119,7 @@ To protect your API with a learned schema, refer to [Schema Validation](/api-shi
119
119
120
120
:::note
121
121
122
-
The schema is saved as a JSON file in OpenAPI `v3.0.0` format.
122
+
The schema is saved as a JSON file in OpenAPI `v3.0.0` format.
123
123
:::
124
124
125
125
#### Learned schemas will always include:
@@ -148,7 +148,7 @@ For each saved endpoint, customers can view:
148
148
149
149
:::note
150
150
151
-
Customers viewing analytics have the ability to toggle detailed metrics view between the last 24 hours and 7 days.
151
+
Customers viewing analytics have the ability to toggle detailed metrics view between the last 24 hours and 7 days.
0 commit comments