Skip to content

[API Shield] New dash #23433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jul 9, 2025
Merged

[API Shield] New dash #23433

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
e7979db
session identifiers
patriciasantaana Jul 3, 2025
f55848b
labels
patriciasantaana Jul 3, 2025
fe5d617
routing
patriciasantaana Jul 3, 2025
aa54d46
dev portals
patriciasantaana Jul 3, 2025
7be827d
schema learning
patriciasantaana Jul 3, 2025
341e423
jwt validation
patriciasantaana Jul 3, 2025
83dd909
authentication posture
patriciasantaana Jul 3, 2025
e08c324
endpoint mgmt
patriciasantaana Jul 3, 2025
a632999
Merge branch 'production' into patricia/pcx17420-17612
patriciasantaana Jul 7, 2025
6099445
schema validation
patriciasantaana Jul 7, 2025
6167af9
schema validation edits
patriciasantaana Jul 7, 2025
4824ee7
volumetric abuse detection
patriciasantaana Jul 7, 2025
c969d2a
Merge branch 'production' into patricia/pcx17420-17612
patriciasantaana Jul 9, 2025
000db9d
feedback
patriciasantaana Jul 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 2 additions & 14 deletions src/content/docs/api-shield/management-and-monitoring/api-routing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,11 @@ Once your Source Endpoints are added to Endpoint Management, use the following s

### Create a route

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

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

### Edit a route

<Render file="routing" params={{ one: "Edit", two: "routing" }} />

### Remove a route

<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Select **Security** > **API Shield**.
3. In **Endpoint Management**, select an existing endpoint and expand its details.
4. Under **Routing**, select **Edit routing**.
5. Select **Delete route**.
</Steps>
You can also edit or delete a route by selecting **Edit route** on an existing route.

### Test a route

Expand Down
53 changes: 37 additions & 16 deletions src/content/docs/api-shield/management-and-monitoring/developer-portal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,47 @@ sidebar:

---

import { GlossaryTooltip, Steps } from "~/components"
import { GlossaryTooltip, Tabs, TabItem, Steps } from "~/components"

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.
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.

To create a developer portal:

<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Security** > **API Shield** > **Settings**.
3. Under **Create a developer portal**, select **Create site**.
4. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
:::note
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.

Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
:::
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.
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.
7. Select **Deploy site**.
</Steps>
<Tabs syncKey="dashNewNav">
<TabItem label="Old dashboard">
<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Security** > **API Shield** > **Settings**.
3. Under **Create a developer portal**, select **Create site**.
4. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
:::note
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.

Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
:::
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.
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.
7. Select **Deploy site**.
</Steps>
</TabItem>
<TabItem label="New dashboard" icon="rocket">
<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Security** > **Settings**
3. Filter by **API abuse**.
4. On **Create a developer portal**, select **Create site**.
4. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
:::note
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.

Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
:::
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.
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.
7. Select **Deploy site**.
</Steps>
</TabItem>
</Tabs>

### Custom domains

Expand Down
128 changes: 91 additions & 37 deletions src/content/docs/api-shield/management-and-monitoring/endpoint-labels.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar:
label: Labeling service
---

import { Render, Steps } from "~/components";
import { Render, Steps, Tabs, TabItem } from "~/components";

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.

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

## Create a label

<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Security** > **Settings** > **Labels**.
3. Under **Security labels**, select **Create label**.
4. Name the label and add an optional label description.
5. Apply the label to your selected endpoints.
6. Select **Create label**.
</Steps>

Alternatively, you can create a user-defined label via Endpoint Management in API Shield:

<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Security** > **Settings** > **Labels**.
3. Choose the endpoint that you want to label.
4. Select **Edit labels**.
5. Under **User**, select **Create user label**.
6. Enter the label name.
7. Select **Create**.
</Steps>
<Tabs syncKey="dashNewNav">
<TabItem label="Old dashboard">
<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Security** > **Settings** > **Labels**.
3. Under **Security labels**, select **Create label**.
4. Name the label and add an optional label description.
5. Apply the label to your selected endpoints.
6. Select **Create label**.
</Steps>

Alternatively, you can create a user-defined label via Endpoint Management in API Shield:

<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Security** > **Settings** > **Labels**.
3. Choose the endpoint that you want to label.
4. Select **Edit labels**.
5. Under **User**, select **Create user label**.
6. Enter the label name.
7. Select **Create**.
</Steps>
</TabItem>
<TabItem label="New dashboard" icon="rocket">
<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Security** > **Settings**.
3. Filter by **API abuse**.
4. Under **Endpoint labels**, select **Manage label**.
5. Name the label and add an optional label description.
6. Apply the label to your selected endpoints.
7. Select Create label.
</Steps>
Alternatively, you can create a user-defined label via **Security** > **Web Assets**.
<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Security** > **Web assets** > **Endpoints**.
3. Choose the endpoint that you want to label.
4. Select **Edit endpoint labels**.
5. Under **User**, select **Create user label**.
6. Enter the label name.
7. Select **Create**.
</Steps>
</TabItem>
</Tabs>

## Apply a label to an individual endpoint

<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Security** > **API Shield** > **Endpoint Management**.
3. Choose the endpoint that you want to label.
4. Select **Edit labels**.
5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels.
6. Select **Save labels**.
</Steps>
<Tabs syncKey="dashNewNav">
<TabItem label="Old dashboard">
<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Security** > **API Shield** > **Endpoint Management**.
3. Choose the endpoint that you want to label.
4. Select **Edit labels**.
5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels.
6. Select **Save labels**.
</Steps>
</TabItem>
<TabItem label="New dashboard" icon="rocket">
<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Security** > **Web assets** > **Endpoints**.
3. Choose the endpoint that you want to label.
4. Select **Edit endpoint labels**.
5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels.
6. Select **Save labels**.
</Steps>
</TabItem>
</Tabs>

## Bulk apply labels to multiple endpoints

<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Security** > **Settings** > **Labels**.
3. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**.
4. Choose the endpoints that you want to label by selecting its checkbox.
5. Select **Save label**.
</Steps>
<Tabs syncKey="dashNewNav">
<TabItem label="Old dashboard">
<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Security** > **Settings** > **Labels**.
3. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**.
4. Choose the endpoints that you want to label by selecting its checkbox.
5. Select **Save label**.
</Steps>
</TabItem>
<TabItem label="New dashboard" icon="rocket">
<Steps>
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Security** > **Settings**.
3. Filter by **API abuse**.
4. On **Endpoint labels**, select **Manage labels**.
5. On the existing label that you want to apply to multiple endpoints, select Bulk apply.
6. Choose the endpoints that you want to label by selecting its checkbox.
7. Select **Apply label**.
</Steps>
</TabItem>
</Tabs>

## Availability

Endpoint Management's labeling service is available to all customers.
Endpoint labeling is available to all customers.
Loading
Loading