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/index.mdx
+8-1Lines changed: 8 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,14 @@ Identify and address your API vulnerabilities.
21
21
22
22
## Why care about API security?
23
23
24
-
<Renderfile="why-care"product="api-shield" />
24
+
APIs have become the [backbone of popular web services](https://blog.postman.com/intro-to-apis-history-of-apis/), helping the Internet become more accessible and useful.
25
+
26
+
As APIs have become more prevalent, however, so have their problems:
27
+
28
+
* Many companies have [thousands of APIs](/api-shield/security/api-discovery/), including ones they do not even know about.
29
+
* To support a large base of users, many APIs are protected by a negative security model that makes them vulnerable to credential-stuffing attacks and automated scanning tools.
30
+
* With so many endpoints and users, it’s difficult to recognize brute-force attacks against [specific endpoints](/api-shield/security/volumetric-abuse-detection/).
31
+
* Sophisticated attacks are even harder to recognize, often because even development teams are unaware of common and uncommon [usage patterns](/api-shield/security/sequence-analytics/).
25
32
26
33
Refer to the [Get started](/api-shield/get-started/) guide to set up API Shield.
API Shield Routing enables customers to create a unified external-facing API that routes requests to different back-end services that may have different paths and hosts than the existing zone and DNS configuration.
13
13
@@ -18,15 +18,62 @@ The term **Source Endpoint** refers to the endpoint managed by API Shield in End
18
18
19
19
## Process
20
20
21
-
<Renderfile="source-endpoints" />
21
+
22
+
You must add Source Endpoints to Endpoint Management through established methods, including [uploading a schema](/api-shield/security/schema-validation/#add-validation-by-uploading-a-schema), via [API Discovery](/api-shield/security/api-discovery/), or by [adding manually](/api-shield/management-and-monitoring/#add-endpoints-manually), before creating a route.
23
+
24
+
To create a route, you will need the operation ID of the Source Endpoint. To find the operation ID in the dashboard:
25
+
26
+
<TabssyncKey="dashNewNav">
27
+
<TabItemlabel="Old dashboard">
28
+
<Steps>
29
+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
30
+
2. Select **Security** > **API Shield**.
31
+
3. Filter the endpoints to find your **Source Endpoint**.
32
+
4. Expand the row for your Source Endpoint and note the **operation ID** field.
33
+
5. Select the copy icon to copy the operation ID to your clipboard.
34
+
</Steps>
35
+
</TabItem>
36
+
<TabItemlabel="New dashboard"icon="rocket">
37
+
<Steps>
38
+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
39
+
2. Select **Security** > **Web assets**.
40
+
3. Filter the endpoints to find your **Source Endpoint**.
41
+
4. Expand the row for your Source Endpoint and note the **operation ID** field.
42
+
5. Select the copy icon to copy the operation ID to your clipboard.
43
+
</Steps>
44
+
</TabItem>
45
+
</Tabs>
22
46
23
47
Once your Source Endpoints are added to Endpoint Management, use the following steps to create and verify routes on any given operation ID:
24
48
25
49
### Create a route
26
50
27
-
<Renderfile="routing" />
51
+
<TabssyncKey="dashNewNav">
52
+
<TabItemlabel="Old dashboard">
53
+
<Steps>
54
+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
55
+
2. Go to **Security** > **API Shield**.
56
+
3. In **Endpoint Management**, select an existing endpoint and expand its details.
57
+
4. Under **Routing**, select **Create route**.
58
+
5. Enter the target URL or IP address to route your endpoint to.
59
+
6. Select **Deploy route**.
60
+
</Steps>
61
+
</TabItem>
62
+
<TabItemlabel="New dashboard"icon="rocket">
63
+
<Steps>
64
+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
65
+
2. Go to **Security** > **Web assets**.
66
+
3. In **Endpoints**, select an existing endpoint and expand its details.
67
+
4. Under **Routing**, select **Create route**.
68
+
5. Enter the target URL or IP address to route your endpoint to.
69
+
6. Select **Deploy route**.
70
+
</Steps>
71
+
</TabItem>
72
+
</Tabs>
28
73
29
-
<Renderfile="routing-path-variables" />
74
+
:::note
75
+
You can reorder path variables if they are present. For example, you can route `/api/{var1}/users/{var2}` to `/{var2}/users/{var1}`. Segments of the path that are not variables may be added or omitted entirely.
76
+
:::
30
77
31
78
You can also edit or delete a route by selecting **Edit route** on an existing route.
32
79
@@ -47,4 +94,8 @@ API Shield Routing is currently in an open beta and is only available for Enterp
47
94
48
95
## Limitations
49
96
50
-
<Renderfile="routing-limitations" />
97
+
The Target Endpoint cannot be routed to a Worker if the route is to the same zone.
98
+
99
+
You cannot change the method of a request. For example, a `GET` Source Endpoint will always send a `GET` request to the Target Endpoint.
100
+
101
+
You must use all of the variables in the Target Endpoint that appear in the Source Endpoint. For example, routing `/api/{var1}/users/{var2}` to `/api/users/{var2}` is not allowed and will result in an error since `{var1}` is present in the Source Endpoint but not in the Target Endpoint.
0 commit comments