Skip to content

Commit e3757e3

Browse files
components + light reorg
1 parent cf74e64 commit e3757e3

File tree

26 files changed

+366
-282
lines changed

26 files changed

+366
-282
lines changed

src/content/docs/api-shield/get-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77

88
---
99

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

1212
This guide will help you set up API Shield to identify and address API security best practices.
1313

src/content/docs/api-shield/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ head:
1212
import { Description, Feature, Plan, RelatedProduct, Render } from "~/components"
1313

1414
<Description>
15-
1615
Identify and address your API vulnerabilities.
1716
</Description>
1817

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

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

88
---
99

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

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

@@ -34,11 +34,13 @@ Once your Source Endpoints are added to Endpoint Management, use the following s
3434

3535
### Remove a route
3636

37-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
37+
<Steps>
38+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
3839
2. Select **Security** > **API Shield**.
3940
3. In **Endpoint Management**, select an existing endpoint and expand its details.
4041
4. Under **Routing**, select **Edit routing**.
4142
5. Select **Delete route**.
43+
</Steps>
4244

4345
### Test a route
4446

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

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,26 @@ sidebar:
77

88
---
99

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

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

14-
## Process
14+
To create a developer portal:
1515

16-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
16+
<Steps>
17+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
1718
2. Go to **Security** > **API Shield** > **Settings**.
1819
3. Under **Create a developer portal**, select **Create site**.
1920
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.
2023

21-
:::note
22-
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-
25-
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
26-
:::
27-
24+
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
25+
:::
2826
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.
2927
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.
3028
7. Select **Deploy site**.
29+
</Steps>
3130

3231
### Custom domains
3332

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

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

10-
import { Render } from "~/components";
10+
import { Render, Steps } 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,39 +81,47 @@ Cloudflare will only add authentication labels to endpoints with successful resp
8181

8282
## Create a label
8383

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

91-
Alternatively, you can create a user-defined label via Endpoint Management in API Shield.
93+
Alternatively, you can create a user-defined label via Endpoint Management in API Shield:
9294

93-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
95+
<Steps>
96+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
9497
2. Go to **Security** > **Settings** > **Labels**.
9598
3. Choose the endpoint that you want to label.
9699
4. Select **Edit labels**.
97100
5. Under **User**, select **Create user label**.
98101
6. Enter the label name.
99102
7. Select **Create**.
103+
</Steps>
100104

101105
## Apply a label to an individual endpoint
102106

103-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
107+
<Steps>
108+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
104109
2. Go to **Security** > **API Shield** > **Endpoint Management**.
105110
3. Choose the endpoint that you want to label.
106111
4. Select **Edit labels**.
107112
5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels.
108113
6. Select **Save labels**.
114+
</Steps>
109115

110116
## Bulk apply labels to multiple endpoints
111117

112-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
118+
<Steps>
119+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
113120
2. Go to **Security** > **Settings** > **Labels**.
114121
3. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**.
115122
4. Choose the endpoints that you want to label by selecting its checkbox.
116123
5. Select **Save label**.
124+
</Steps>
117125

118126
## Availability
119127

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

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

88
---
99

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

1212
<Plan type="all" />
1313

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

2727
## Access
2828

29-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
29+
<Steps>
30+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
3031
2. Select **Security** > **API Shield**.
3132
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>
3234

33-
## Add endpoints from API Discovery
35+
### Add endpoints from API Discovery
3436

3537
There are two ways to add API endpoints from Discovery.
3638

37-
### Add from the Endpoint Management Tab
39+
#### Add from the Endpoint Management Tab
3840

41+
<Steps>
3942
1. From Endpoint Management, select **Add endpoints** > **Select from Discovery** tab.
4043
2. Select the discovered endpoints you would like to add.
4144
3. Select **Add endpoints**.
45+
</Steps>
4246

43-
### Add from the Discovery Tab
47+
#### Add from the Discovery Tab
4448

49+
<Steps>
4550
1. From Endpoint Management, select the **Discovery** tab.
4651
2. Select the discovered endpoints you would like to add.
4752
3. Select **Save selected endpoints**.
53+
</Steps>
4854

49-
## Add endpoints from Schema validation
55+
### Add endpoints from Schema validation
5056

57+
<Steps>
5158
1. Add a schema by [configuring Schema validation](/api-shield/security/schema-validation/).
5259
2. On **Review schema endpoints**, save new endpoints to endpoint management by checking the box.
5360
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>
5462

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

5765
:::note
58-
5966
If you deselect **Save new endpoints to endpoint management**, the endpoints will not be added.
6067
:::
6168

62-
## Add endpoints manually
69+
### Add endpoints manually
6370

71+
<Steps>
6472
1. From Endpoint Management, select **Add endpoints** > **Manually add**.
6573
2. Choose the method from the dropdown menu and add the path and hostname for the endpoint.
6674
3. Select **Add endpoints**.
75+
</Steps>
6776

6877
:::note
69-
7078
By selecting multiple checkboxes, you can add several endpoints from Discovery at once instead of individually.
7179
:::
7280

@@ -94,12 +102,14 @@ foo-{hostVar1}.example.com
94102

95103
For more information on how Cloudflare uses variables in API Shield, refer to the examples from [API Discovery](/api-shield/security/api-discovery/).
96104

97-
## Delete endpoints manually
105+
### Delete endpoints manually
98106

99107
You can delete endpoints one at a time or in bulk.
100108

109+
<Steps>
101110
1. From Endpoint Management, select the checkboxes for the endpoints that you want to delete.
102111
2. Select **Delete endpoints**.
112+
</Steps>
103113

104114
## Endpoint Analysis
105115

src/content/docs/api-shield/management-and-monitoring/endpoint-management/schema-learning.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,22 @@ sidebar:
66
order: 2
77
---
88

9+
import { Steps } from "~/components"
10+
911
Cloudflare learns schema parameters via traffic inspection. For all endpoints saved to Endpoint Management, you can export the learned schema in OpenAPI `v3.0.0` format by hostname.
1012

1113
To protect your API with a learned schema, refer to [Schema validation](/api-shield/security/schema-validation/#add-validation-by-applying-a-learned-schema-to-an-entire-hostname).
1214

1315
## Export a schema
1416

15-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
17+
<Steps>
18+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
1619
2. Select **Security** > **API Shield**.
1720
3. Navigate to **Endpoint Management**.
1821
4. Select **Export schema** and choose a hostname to export.
1922
5. Select whether to include [learned parameters](/api-shield/management-and-monitoring/#learned-schemas-will-always-include) and [rate limit recommendations](/api-shield/security/volumetric-abuse-detection/)
2023
6. Select **Export schema** and choose a location to save the file.
24+
</Steps>
2125

2226
:::note
2327
The schema is saved as a JSON file in OpenAPI `v3.0.0` format.

src/content/docs/api-shield/security/authentication-posture.mdx

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

88
---
99

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

1212
Authentication Posture helps users identify authentication misconfigurations for APIs and alerts of their presence.
1313

@@ -21,21 +21,23 @@ After configuring [session identifiers](/api-shield/get-started/#session-identif
2121

2222
<Render file="label-methodology" />
2323

24-
To examine an endpoint's authentication details in the Cloudflare dashboard:
24+
### Examine an endpoint's authentication details
2525

26-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
26+
<Steps>
27+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2728
2. Go to **Security** > **API Shield** > **Endpoint Management**.
2829
3. Filter Endpoint Management by the `cf-risk-missing-auth` or `cf-risk-mixed-auth` labels.
2930
4. Select an endpoint to see its authentication posture details on the endpoint details page.
3031
5. Choose between the 24-hour and 7-day view options, and note any authentication changes over time.
32+
</Steps>
3133

3234
The main authentication widget displays how many successful requests over the last seven days had session identifiers included with them, and which identifiers were included with the traffic.
3335

3436
The authentication-over-time chart shows a detailed breakdown over time of how clients successfully interacted with your API and which identifiers were used. A large increase in unauthenticated traffic may signal a security incident. Similarly, any successful unauthenticated traffic on an endpoint that is expected to be 100% authenticated can be a cause for concern.
3537

3638
Work with your development team to understand which authentication policies may need to be corrected on your API to stop unauthenticated traffic.
3739

38-
## Stop unauthenticated traffic with Cloudflare
40+
### Stop unauthenticated traffic with Cloudflare
3941

4042
You can use the `cf.api_gateway.auth_id_present` field in [custom rules](/waf/custom-rules/) to trigger when the API Shield configured session identifiers are present or absent on a request. Since this rule would cover your entire zone, Cloudflare recommends adding a host and path match in the rule to pinpoint the protection to exactly what is needed.
4143

src/content/docs/api-shield/security/graphql-protection/configure.mdx renamed to src/content/docs/api-shield/security/graphql-protection/api.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
2-
title: Configure GraphQL malicious query protection
2+
title: Configure GraphQL malicious query protection via the API
33
pcx_content_type: how-to
44
type: overview
5+
sidebar:
6+
order: 2
7+
label: API
58
head:
69
- tag: title
710
content: Configure GraphQL malicious query protection

src/content/docs/api-shield/security/jwt-validation/configure.mdx renamed to src/content/docs/api-shield/security/jwt-validation/api.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
2-
title: Configure JWT validation
2+
title: Configure JWT validation via the API
33
pcx_content_type: how-to
44
type: overview
55
sidebar:
6-
order: 1
6+
order: 2
7+
label: API
78
head:
89
- tag: title
9-
content: Configure JWT validation
10+
content: Configure JWT validation via the API
1011

1112
---
1213

0 commit comments

Comments
 (0)