Skip to content

Commit e08c324

Browse files
patriciasantaanapatriciasantaana
committed
endpoint mgmt
1 parent 83dd909 commit e08c324

File tree

1 file changed

+109
-38
lines changed
  • src/content/docs/api-shield/management-and-monitoring/endpoint-management

1 file changed

+109
-38
lines changed

‎src/content/docs/api-shield/management-and-monitoring/endpoint-management/index.mdx‎

Lines changed: 109 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77

88
---
99

10-
import { GlossaryTooltip, Plan, Steps } from "~/components"
10+
import { GlossaryTooltip, Plan, Steps, Tabs, TabItem } from "~/components"
1111

1212
<Plan type="all" />
1313

@@ -26,39 +26,85 @@ When an endpoint is using [Cloudflare Workers](/workers/), the metrics data will
2626

2727
## Access
2828

29-
<Steps>
30-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
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).
33-
</Steps>
29+
<Tabs syncKey="dashNewNav">
30+
<TabItem label="Old dashboard">
31+
<Steps>
32+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
33+
2. Select **Security** > **API Shield**.
34+
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).
35+
</Steps>
36+
</TabItem>
37+
<TabItem label="New dashboard" icon="rocket">
38+
<Steps>
39+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
40+
2. Go to **Security** > **Web assets** > **Endpoints**.
41+
3. Select **Add endpoints**.
42+
4. Add your endpoints [manually](#add-endpoints-manually), from [Schema validation](#add-endpoints-from-schema-validation), or from [API Discovery](#add-endpoints-from-api-discovery).
43+
</Steps>
44+
</TabItem>
45+
</Tabs>
3446

3547
### Add endpoints from API Discovery
3648

3749
There are two ways to add API endpoints from Discovery.
3850

39-
#### Add from the Endpoint Management Tab
40-
41-
<Steps>
42-
1. From Endpoint Management, select **Add endpoints** > **Select from Discovery** tab.
43-
2. Select the discovered endpoints you would like to add.
44-
3. Select **Add endpoints**.
45-
</Steps>
46-
47-
#### Add from the Discovery Tab
48-
49-
<Steps>
50-
1. From Endpoint Management, select the **Discovery** tab.
51-
2. Select the discovered endpoints you would like to add.
52-
3. Select **Save selected endpoints**.
53-
</Steps>
54-
55-
### Add endpoints from Schema validation
56-
57-
<Steps>
58-
1. Add a schema by [configuring Schema validation](/api-shield/security/schema-validation/).
59-
2. On **Review schema endpoints**, save new endpoints to endpoint management by checking the box.
60-
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.
61-
</Steps>
51+
#### Add from the Endpoints tab
52+
53+
<Tabs syncKey="dashNewNav">
54+
<TabItem label="Old dashboard">
55+
<Steps>
56+
1. From **Endpoint Management**, select **Add endpoints** > **Select from Discovery** tab.
57+
2. Select the discovered endpoints you would like to add.
58+
3. Select **Add endpoints**.
59+
</Steps>
60+
</TabItem>
61+
<TabItem label="New dashboard" icon="rocket">
62+
<Steps>
63+
1. From **Endpoints**, go to **Add endpoints** > **Select from Discovery** tab.
64+
2. Select the discovered endpoints you would like to add.
65+
3. Select **Add endpoints**.
66+
</Steps>
67+
</TabItem>
68+
</Tabs>
69+
70+
#### Add from the Discovery tab
71+
72+
<Tabs syncKey="dashNewNav">
73+
<TabItem label="Old dashboard">
74+
<Steps>
75+
1. From Endpoint Management, select the **Discovery** tab.
76+
2. Select the discovered endpoints you would like to add.
77+
3. Select **Save selected endpoints**.
78+
</Steps>
79+
</TabItem>
80+
<TabItem label="New dashboard" icon="rocket">
81+
<Steps>
82+
1. From **Web assets**, go to the **Discovery** tab.
83+
2. Select the discovered endpoints you would like to add.
84+
3. Select **Save selected endpoints**.
85+
</Steps>
86+
</TabItem>
87+
</Tabs>
88+
89+
### Add endpoints from Schema Validation
90+
91+
<Tabs syncKey="dashNewNav">
92+
<TabItem label="Old dashboard">
93+
<Steps>
94+
1. Add a schema by [configuring Schema validation](/api-shield/security/schema-validation/).
95+
2. On **Review schema endpoints**, save new endpoints to endpoint management by checking the box.
96+
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.
97+
</Steps>
98+
</TabItem>
99+
<TabItem label="New dashboard" icon="rocket">
100+
<Steps>
101+
1. From **Web assets**, go to the **Endpoints** tab.
102+
2. Select **Add endpoints** > **Upload Schema**.
103+
3. Upload a schema file.
104+
4. Select **Add schema and endpoints**.
105+
</Steps>
106+
</TabItem>
107+
</Tabs>
62108

63109
API Shield will look for duplicate endpoints that have the same host, method, and path. Duplicate endpoints will not be saved to endpoint management.
64110

@@ -68,11 +114,25 @@ If you deselect **Save new endpoints to endpoint management**, the endpoints wil
68114

69115
### Add endpoints manually
70116

71-
<Steps>
72-
1. From Endpoint Management, select **Add endpoints** > **Manually add**.
73-
2. Choose the method from the dropdown menu and add the path and hostname for the endpoint.
74-
3. Select **Add endpoints**.
75-
</Steps>
117+
118+
<Tabs syncKey="dashNewNav">
119+
<TabItem label="Old dashboard">
120+
<Steps>
121+
1. From Endpoint Management, select **Add endpoints** > **Manually add**.
122+
2. Choose the method from the dropdown menu and add the path and hostname for the endpoint.
123+
3. Select **Add endpoints**.
124+
</Steps>
125+
</TabItem>
126+
<TabItem label="New dashboard" icon="rocket">
127+
<Steps>
128+
1. From **Web assets**, go to the **Endpoints** tab.
129+
2. Select **Add endpoints** > **Manually add**.
130+
3. Choose the method from the dropdown menu and add the path and hostname for the endpoint.
131+
4. Select **Add endpoints**.
132+
</Steps>
133+
</TabItem>
134+
</Tabs>
135+
76136

77137
:::note
78138
By selecting multiple checkboxes, you can add several endpoints from Discovery at once instead of individually.
@@ -106,10 +166,21 @@ For more information on how Cloudflare uses variables in API Shield, refer to th
106166

107167
You can delete endpoints one at a time or in bulk.
108168

109-
<Steps>
110-
1. From Endpoint Management, select the checkboxes for the endpoints that you want to delete.
111-
2. Select **Delete endpoints**.
112-
</Steps>
169+
<Tabs syncKey="dashNewNav">
170+
<TabItem label="Old dashboard">
171+
<Steps>
172+
1. From Endpoint Management, select the checkboxes for the endpoints that you want to delete.
173+
2. Select **Delete endpoints**.
174+
</Steps>
175+
</TabItem>
176+
<TabItem label="New dashboard" icon="rocket">
177+
<Steps>
178+
1. From **Web assets**, go to the **Endpoints** tab.
179+
2. Select the checkboxes for the endpoints that you want to delete.
180+
3. Select **Delete endpoints**.
181+
</Steps>
182+
</TabItem>
183+
</Tabs>
113184

114185
## Endpoint Analysis
115186

0 commit comments

Comments
 (0)