Skip to content

Commit e6e6da0

Browse files
[Various] DashButton (#25461)
* bots * bots - styling and fixes * bots - partials * missing import * challenges * ddos * api shield * api shield - partials * missing import
1 parent a7e666e commit e6e6da0

File tree

30 files changed

+410
-329
lines changed

30 files changed

+410
-329
lines changed

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

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

88
---
99

10-
import { Markdown, Render, Steps, Tabs, TabItem } from "~/components"
10+
import { Markdown, Render, Steps, Tabs, TabItem, DashButton } 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

@@ -35,11 +35,12 @@ To create a route, you will need the operation ID of the Source Endpoint. To fin
3535
</TabItem>
3636
<TabItem label="New dashboard" icon="rocket">
3737
<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.
38+
1. In the Cloudflare dashboard, go to the **Web Assets** page.
39+
40+
<DashButton url="/?to=/:account/:zone/security/web-assets" />
41+
2. Filter the endpoints to find your **Source Endpoint**.
42+
3. Expand the row for your Source Endpoint and note the **operation ID** field.
43+
4. Select the copy icon to copy the operation ID to your clipboard.
4344
</Steps>
4445
</TabItem>
4546
</Tabs>
@@ -61,12 +62,13 @@ Once your Source Endpoints are added to Endpoint Management, use the following s
6162
</TabItem>
6263
<TabItem label="New dashboard" icon="rocket">
6364
<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**.
65+
1. In the Cloudflare dashboard, go to the **Web Assets** page.
66+
67+
<DashButton url="/?to=/:account/:zone/security/web-assets" />
68+
2. In **Endpoints**, select an existing endpoint and expand its details.
69+
3. Under **Routing**, select **Create route**.
70+
4. Enter the target URL or IP address to route your endpoint to.
71+
5. Select **Deploy route**.
7072
</Steps>
7173
</TabItem>
7274
</Tabs>

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar:
66
order: 5
77
---
88

9-
import { GlossaryTooltip, Tabs, TabItem, Steps } from "~/components";
9+
import { GlossaryTooltip, Tabs, TabItem, Steps, DashButton } from "~/components";
1010

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

@@ -28,23 +28,23 @@ To create a developer portal:
2828
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.
2929
7. Select **Deploy site**.
3030
</Steps>
31-
3231
</TabItem>
3332
<TabItem label="New dashboard" icon="rocket">
3433
<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-
5. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
34+
1. In the Cloudflare dashboard, go to the **Security Settings** page.
35+
36+
<DashButton url="/?to=/:account/:zone/security/settings" />
37+
2. Filter by **API abuse**.
38+
3. 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.
4040
:::note
4141
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.
4242

4343
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas.
4444
:::
45-
6. 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-
7. 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-
8. Select **Deploy site**.
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**.
4848
</Steps>
4949

5050
</TabItem>

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

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

10-
import { Render, Steps, Tabs, TabItem } from "~/components";
10+
import { Render, Steps, Tabs, TabItem, DashButton } 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

@@ -110,18 +110,21 @@ Cloudflare will only add authentication labels to endpoints with successful resp
110110
</TabItem>
111111
<TabItem label="New dashboard" icon="rocket">
112112
<Steps>
113-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
114-
2. Go to **Security** > **Settings**.
115-
3. Filter by **API abuse**.
116-
4. Under **Endpoint labels**, select **Manage labels**.
117-
5. Name the label and add an optional label description.
118-
6. Apply the label to your selected endpoints.
119-
7. Select **Create label**.
113+
1. In the Cloudflare dashboard, go to the **Security Settings** page.
114+
115+
<DashButton url="/?to=/:account/:zone/security/settings" />
116+
2. Filter by **API abuse**.
117+
3. Under **Endpoint labels**, select **Manage labels**.
118+
4. Name the label and add an optional label description.
119+
5. Apply the label to your selected endpoints.
120+
6. Select **Create label**.
120121
</Steps>
121122
Alternatively, you can create a user-defined label via **Security** > **Web Assets**.
122123
<Steps>
123-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
124-
2. Go to **Security** > **Web assets** > **Endpoints**.
124+
1. In the Cloudflare dashboard, go to the **Web Assets** page.
125+
126+
<DashButton url="/?to=/:account/:zone/security/web-assets" />
127+
2. Go to the **Endpoints** tab.
125128
3. Choose the endpoint that you want to label.
126129
4. Select **Edit endpoint labels**.
127130
5. Under **User**, select **Create user label**.
@@ -146,8 +149,10 @@ Cloudflare will only add authentication labels to endpoints with successful resp
146149
</TabItem>
147150
<TabItem label="New dashboard" icon="rocket">
148151
<Steps>
149-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
150-
2. Go to **Security** > **Web assets** > **Endpoints**.
152+
1. In the Cloudflare dashboard, go to the **Web Assets** page.
153+
154+
<DashButton url="/?to=/:account/:zone/security/web-assets" />
155+
2. Go to the **Endpoints** tab.
151156
3. Choose the endpoint that you want to label.
152157
4. Select **Edit endpoint labels**.
153158
5. Add the label(s) that you want to use for the endpoint from the list of managed and user-defined labels.
@@ -170,13 +175,14 @@ Cloudflare will only add authentication labels to endpoints with successful resp
170175
</TabItem>
171176
<TabItem label="New dashboard" icon="rocket">
172177
<Steps>
173-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
174-
2. Go to **Security** > **Settings**.
175-
3. Filter by **API abuse**.
176-
4. On **Endpoint labels**, select **Manage labels**.
177-
5. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**.
178-
6. Choose the endpoints that you want to label by selecting its checkbox.
179-
7. Select **Apply label**.
178+
1. In the Cloudflare dashboard, go to the **Security Settings** page.
179+
180+
<DashButton url="/?to=/:account/:zone/security/settings" />
181+
2. Filter by **API abuse**.
182+
3. On **Endpoint labels**, select **Manage labels**.
183+
4. On the existing label that you want to apply to multiple endpoints, select **Bulk apply**.
184+
5. Choose the endpoints that you want to label by selecting its checkbox.
185+
6. Select **Apply label**.
180186
</Steps>
181187
</TabItem>
182188
</Tabs>

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

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

88
---
99

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

1212
<Plan type="all" />
1313

@@ -36,8 +36,10 @@ When an endpoint is using [Cloudflare Workers](/workers/), the metrics data will
3636
</TabItem>
3737
<TabItem label="New dashboard" icon="rocket">
3838
<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**.
39+
1. In the Cloudflare dashboard, go to the **Web Assets** page.
40+
41+
<DashButton url="/?to=/:account/:zone/security/web-assets" />
42+
2. Go to the **Endpoints** tab.
4143
3. Select **Add endpoints**.
4244
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).
4345
</Steps>

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar:
66
order: 2
77
---
88

9-
import { Steps, Tabs, TabItem } from "~/components"
9+
import { Steps, Tabs, TabItem, DashButton } from "~/components"
1010

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

@@ -26,8 +26,10 @@ To protect your API with a learned schema, refer to [Schema validation](/api-shi
2626
</TabItem>
2727
<TabItem label="New dashboard" icon="rocket">
2828
<Steps>
29-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
30-
2. Go to **Security** > **Web assets** > **Endpoints**.
29+
1. In the Cloudflare dashboard, go to the **Web Assets** page.
30+
31+
<DashButton url="/?to=/:account/:zone/security/web-assets" />
32+
2. Go to the **Endpoints** tab.
3133
3. Select **Export schema** and choose a hostname to export.
3234
4. Select whether to include learned parameters and rate limit recommendations
3335
5. Select **Export schema** and choose a location to save the file.

src/content/docs/api-shield/security/api-discovery.mdx

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

88
---
99

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

1212
Most development teams struggle to keep track of their APIs. Cloudflare API Discovery helps you map out and understand your attack surface area.
1313

@@ -78,8 +78,10 @@ To access Machine Learning-based Discovery:
7878
</TabItem>
7979
<TabItem label="New dashboard" icon="rocket">
8080
<Steps>
81-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
82-
2. Go to **Web assets** > **Discovery**
81+
1. In the Cloudflare dashboard, go to the **Web Assets** page.
82+
83+
<DashButton url="/?to=/:account/:zone/security/web-assets" />
84+
2. Go to the **Discovery** tab.
8385
3. Filter the source results by `Session Identifier` or `Machine Learning` to view results from each Discovery method.
8486
</Steps>
8587
</TabItem>

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

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

88
---
99

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

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

@@ -35,8 +35,10 @@ After configuring [session identifiers](/api-shield/get-started/#session-identif
3535
</TabItem>
3636
<TabItem label="New dashboard" icon="rocket">
3737
<Steps>
38-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
39-
2. Go to **Security** > **Web assets** > **Endpoints**.
38+
1. In the Cloudflare dashboard, go to the **Web Assets** page.
39+
40+
<DashButton url="/?to=/:account/:zone/security/web-assets" />
41+
2. Go to the **Endpoints** tab.
4042
3. Filter your endpoints by the `cf-risk-missing-auth` or `cf-risk-mixed-auth` labels.
4143
4. Select an endpoint to see its authentication posture details on the endpoint details page.
4244
5. Choose between the 24-hour and 7-day view options, and note any authentication changes over time.

src/content/docs/api-shield/security/jwt-validation/index.mdx

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar:
66

77
---
88

9-
import { GlossaryTooltip, Steps, Tabs, TabItem, Render } from "~/components"
9+
import { GlossaryTooltip, Steps, Tabs, TabItem, Render, DashButton } from "~/components"
1010

1111

1212
<GlossaryTooltip term="JSON web token (JWT)">JSON web tokens (JWT)</GlossaryTooltip> are often used as part of an authentication component on many web applications today. Since JWTs are crucial to identifying users and their access, ensuring the token’s integrity is important.
@@ -34,13 +34,14 @@ A JWT validation configuration consists of creating a token validation configura
3434
</TabItem>
3535
<TabItem label="New dashboard" icon="rocket">
3636
<Steps>
37-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
38-
2. Go to **Security** > **Settings**.
39-
3. Filter by **API abuse**.
40-
4. On **Token configurations**, select **Configure tokens**. If you already have one or more tokens, select **&lt;N> out of &lt;M> configurations used** instead.
41-
5. Add a name for your configuration.
42-
6. Choose where Cloudflare can locate the JWT for this configuration on incoming requests, such as a header or cookie and its name.
43-
7. Copy and paste your JWT issuer's public key(s) (JWKS).
37+
1. In the Cloudflare dashboard, go to the **Security Settings** page.
38+
39+
<DashButton url="/?to=/:account/:zone/security/settings" />
40+
2. Filter by **API abuse**.
41+
3. On **Token configurations**, select **Configure tokens**.
42+
4. Add a name for your configuration.
43+
5. Choose where Cloudflare can locate the JWT for this configuration on incoming requests, such as a header or cookie and its name.
44+
6. Copy and paste your JWT issuer's public key(s) (JWKS).
4445
</Steps>
4546
</TabItem>
4647
</Tabs>
@@ -69,18 +70,19 @@ To automatically keep your JWKS up to date when your identity provider refreshes
6970
</TabItem>
7071
<TabItem label="New dashboard" icon="rocket">
7172
<Steps>
72-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
73-
2. Go to **Security** > **Security rules**.
74-
3. On API JWT validation rules, select **Create rule**.
75-
4. Add a name for your rule.
76-
5. Select a hostname to protect requests with saved endpoints using the rule.
77-
6. Deselect any endpoints that you want JWT validation to ignore (for example, an endpoint used to generate a JWT).
78-
7. Select the token validation configuration that corresponds to the incoming requests.
79-
8. Choose whether to strictly enforce token presence on these endpoints.
73+
1. In the Cloudflare dashboard, go to the **Security rules** page.
74+
75+
<DashButton url="/?to=/:account/:zone/security/security-rules" />
76+
2. On API JWT validation rules, select **Create rule**.
77+
3. Add a name for your rule.
78+
4. Select a hostname to protect requests with saved endpoints using the rule.
79+
5. Deselect any endpoints that you want JWT validation to ignore (for example, an endpoint used to generate a JWT).
80+
6. Select the token validation configuration that corresponds to the incoming requests.
81+
7. Choose whether to strictly enforce token presence on these endpoints.
8082
- You may not expect 100% of clients to send in JWTs with their requests. If this is the case, choose *Ignore*. JWT validation will still validate JWTs that are present.
8183
- You may otherwise expect all requests to the selected hostname and endpoints to contain JWTs. If this is the case, choose *Mark as non-compliant*.
82-
9. Choose an action to take for non-compliant requests. For example, JWTs that do not pass validation (expired, tampered with, or bad signature tokens) or requests with missing JWTs when *Mark as non-compliant* is selected in the previous step.
83-
10. Select **Save**.
84+
8. Choose an action to take for non-compliant requests. For example, JWTs that do not pass validation (expired, tampered with, or bad signature tokens) or requests with missing JWTs when *Mark as non-compliant* is selected in the previous step.
85+
9. Select **Save**.
8486
</Steps>
8587
</TabItem>
8688
</Tabs>

src/content/docs/api-shield/security/jwt-validation/transform-rules.mdx

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ head:
99
content: Enhance Transform Rules with JWT claims
1010
---
1111

12-
import { Steps } from "~/components"
12+
import { Steps, DashButton } from "~/components"
1313

1414
You can forward information from a [JSON Web Token (JWT)](/api-shield/security/jwt-validation/) to the origin in a header by creating [Transform Rules](/rules/transform/) using claims that Cloudflare has verified via the JSON Web Token.
1515

@@ -28,13 +28,14 @@ Refer to [Configure JWT validation](/api-shield/security/jwt-validation/api/) fo
2828
As an example, to send the `x-send-jwt-claim-user` request header to the origin, you must create a Transform Rule:
2929

3030
<Steps>
31-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
32-
2. Go to **Rules** > **Overview**.
33-
3. Select **Create rule** > **Request Header Transform Rules**.
34-
4. Enter a rule name and a filter expression, if applicable.
35-
5. Choose **Set dynamic**.
36-
6. Set the header name to `x-send-jwt-claim-user`.
37-
7. Set the value to:
31+
1. In the Cloudflare dashboard, go to the **Rules overview** page.
32+
33+
<DashButton url="/?to=/:account/:zone/rules/overview" />
34+
2. Select **Create rule** > **Request Header Transform Rules**.
35+
3. Enter a rule name and a filter expression, if applicable.
36+
4. Choose **Set dynamic**.
37+
5. Set the header name to `x-send-jwt-claim-user`.
38+
6. Set the value to:
3839
```txt wrap
3940
lookup_json_string(http.request.jwt.claims["<TOKEN_CONFIGURATION_ID>"][0], "claim_name")
4041
```

0 commit comments

Comments
 (0)