Skip to content

Commit 8776ca7

Browse files
patriciasantaanasdnts
patriciasantaana
authored and
sdnts
committed
[API Shield] New dash (cloudflare#23433)
* session identifiers * labels * routing * dev portals * schema learning * jwt validation * authentication posture * endpoint mgmt * schema validation * schema validation edits * volumetric abuse detection * feedback
1 parent be5d63f commit 8776ca7

File tree

13 files changed

+654
-279
lines changed

13 files changed

+654
-279
lines changed

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

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,11 @@ Once your Source Endpoints are added to Endpoint Management, use the following s
2424

2525
### Create a route
2626

27-
<Render file="routing" params={{ one: "Create", two: "route" }} />
27+
<Render file="routing" />
2828

2929
<Render file="routing-path-variables" />
3030

31-
### Edit a route
32-
33-
<Render file="routing" params={{ one: "Edit", two: "routing" }} />
34-
35-
### Remove a route
36-
37-
<Steps>
38-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
39-
2. Select **Security** > **API Shield**.
40-
3. In **Endpoint Management**, select an existing endpoint and expand its details.
41-
4. Under **Routing**, select **Edit routing**.
42-
5. Select **Delete route**.
43-
</Steps>
31+
You can also edit or delete a route by selecting **Edit route** on an existing route.
4432

4533
### Test a route
4634

‎src/content/docs/api-shield/management-and-monitoring/developer-portal.mdx‎

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,47 @@ sidebar:
77

88
---
99

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

12-
Once <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> are saved into Endpoint Management, API Shield doubles as an API catalog. API Shield can build an interactive documentation portal with the knowledge it has of your APIs, or you can upload a new OpenAPI schema file to build a documentation portal ad-hoc.
12+
Once your <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> are saved, API Shield doubles as an API catalog. API Shield can build an interactive documentation portal with the knowledge it has of your APIs, or you can upload a new OpenAPI schema file to build a documentation portal ad-hoc.
1313

1414
To create a developer portal:
1515

16-
<Steps>
17-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
18-
2. Go to **Security** > **API Shield** > **Settings**.
19-
3. Under **Create a developer portal**, select **Create site**.
20-
4. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
21-
:::note
22-
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.
23-
24-
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
25-
:::
26-
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.
27-
6. Select **Create pages project** to begin project creation. A new Pages project will be automatically created and your API schema will be automatically uploaded to the project along with other supporting static content.
28-
7. Select **Deploy site**.
29-
</Steps>
16+
<Tabs syncKey="dashNewNav">
17+
<TabItem label="Old dashboard">
18+
<Steps>
19+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
20+
2. Go to **Security** > **API Shield** > **Settings**.
21+
3. Under **Create a developer portal**, select **Create site**.
22+
4. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
23+
:::note
24+
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.
25+
26+
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas.
27+
:::
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.
29+
6. Select **Create pages project** to begin project creation. A new Pages project will be automatically created and your API schema will be automatically uploaded to the project along with other supporting static content.
30+
7. Select **Deploy site**.
31+
</Steps>
32+
</TabItem>
33+
<TabItem label="New dashboard" icon="rocket">
34+
<Steps>
35+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
36+
2. Go to **Security** > **Settings**
37+
3. Filter by **API abuse**.
38+
4. On **Create a developer portal**, select **Create site**.
39+
4. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
40+
:::note
41+
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.
42+
43+
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas.
44+
:::
45+
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.
46+
6. Select **Create pages project** to begin project creation. A new Pages project will be automatically created and your API schema will be automatically uploaded to the project along with other supporting static content.
47+
7. Select **Deploy site**.
48+
</Steps>
49+
</TabItem>
50+
</Tabs>
3051

3152
### Custom domains
3253

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

Lines changed: 91 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77
label: Labeling service
88
---
99

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

1212
API Shield's labeling service will help you organize your endpoints and address vulnerabilities in your API. The labeling service comes with managed and user-defined labels.
1313

@@ -81,48 +81,102 @@ Cloudflare will only add authentication labels to endpoints with successful resp
8181

8282
## Create a label
8383

84-
<Steps>
85-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
86-
2. Go to **Security** > **Settings** > **Labels**.
87-
3. Under **Security labels**, select **Create label**.
88-
4. Name the label and add an optional label description.
89-
5. Apply the label to your selected endpoints.
90-
6. Select **Create label**.
91-
</Steps>
92-
93-
Alternatively, you can create a user-defined label via Endpoint Management in API Shield:
94-
95-
<Steps>
96-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
97-
2. Go to **Security** > **Settings** > **Labels**.
98-
3. Choose the endpoint that you want to label.
99-
4. Select **Edit labels**.
100-
5. Under **User**, select **Create user label**.
101-
6. Enter the label name.
102-
7. Select **Create**.
103-
</Steps>
84+
<Tabs syncKey="dashNewNav">
85+
<TabItem label="Old dashboard">
86+
<Steps>
87+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
88+
2. Go to **Security** > **Settings** > **Labels**.
89+
3. Under **Security labels**, select **Create label**.
90+
4. Name the label and add an optional label description.
91+
5. Apply the label to your selected endpoints.
92+
6. Select **Create label**.
93+
</Steps>
94+
95+
Alternatively, you can create a user-defined label via Endpoint Management in API Shield:
96+
97+
<Steps>
98+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
99+
2. Go to **Security** > **Settings** > **Labels**.
100+
3. Choose the endpoint that you want to label.
101+
4. Select **Edit labels**.
102+
5. Under **User**, select **Create user label**.
103+
6. Enter the label name.
104+
7. Select **Create**.
105+
</Steps>
106+
</TabItem>
107+
<TabItem label="New dashboard" icon="rocket">
108+
<Steps>
109+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
110+
2. Go to **Security** > **Settings**.
111+
3. Filter by **API abuse**.
112+
4. Under **Endpoint labels**, select **Manage label**.
113+
5. Name the label and add an optional label description.
114+
6. Apply the label to your selected endpoints.
115+
7. Select **Create label**.
116+
</Steps>
117+
Alternatively, you can create a user-defined label via **Security** > **Web Assets**.
118+
<Steps>
119+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
120+
2. Go to **Security** > **Web assets** > **Endpoints**.
121+
3. Choose the endpoint that you want to label.
122+
4. Select **Edit endpoint labels**.
123+
5. Under **User**, select **Create user label**.
124+
6. Enter the label name.
125+
7. Select **Create**.
126+
</Steps>
127+
</TabItem>
128+
</Tabs>
104129

105130
## Apply a label to an individual endpoint
106131

107-
<Steps>
108-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
109-
2. Go to **Security** > **API Shield** > **Endpoint Management**.
110-
3. Choose the endpoint that you want to label.
111-
4. Select **Edit labels**.
112-
5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels.
113-
6. Select **Save labels**.
114-
</Steps>
132+
<Tabs syncKey="dashNewNav">
133+
<TabItem label="Old dashboard">
134+
<Steps>
135+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
136+
2. Go to **Security** > **API Shield** > **Endpoint Management**.
137+
3. Choose the endpoint that you want to label.
138+
4. Select **Edit labels**.
139+
5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels.
140+
6. Select **Save labels**.
141+
</Steps>
142+
</TabItem>
143+
<TabItem label="New dashboard" icon="rocket">
144+
<Steps>
145+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
146+
2. Go to **Security** > **Web assets** > **Endpoints**.
147+
3. Choose the endpoint that you want to label.
148+
4. Select **Edit endpoint labels**.
149+
5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels.
150+
6. Select **Save labels**.
151+
</Steps>
152+
</TabItem>
153+
</Tabs>
115154

116155
## Bulk apply labels to multiple endpoints
117156

118-
<Steps>
119-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
120-
2. Go to **Security** > **Settings** > **Labels**.
121-
3. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**.
122-
4. Choose the endpoints that you want to label by selecting its checkbox.
123-
5. Select **Save label**.
124-
</Steps>
157+
<Tabs syncKey="dashNewNav">
158+
<TabItem label="Old dashboard">
159+
<Steps>
160+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
161+
2. Go to **Security** > **Settings** > **Labels**.
162+
3. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**.
163+
4. Choose the endpoints that you want to label by selecting its checkbox.
164+
5. Select **Save label**.
165+
</Steps>
166+
</TabItem>
167+
<TabItem label="New dashboard" icon="rocket">
168+
<Steps>
169+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
170+
2. Go to **Security** > **Settings**.
171+
3. Filter by **API abuse**.
172+
4. On **Endpoint labels**, select **Manage labels**.
173+
5. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**.
174+
6. Choose the endpoints that you want to label by selecting its checkbox.
175+
7. Select **Apply label**.
176+
</Steps>
177+
</TabItem>
178+
</Tabs>
125179

126180
## Availability
127181

128-
Endpoint Management's labeling service is available to all customers.
182+
Endpoint labeling is available to all customers.

0 commit comments

Comments
 (0)