Skip to content

Commit 9b8838d

Browse files
committed
[API Shield] Update links in Get started
1 parent 65748bd commit 9b8838d

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

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

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,14 @@ pcx_content_type: get-started
44
sidebar:
55
order: 2
66
label: Get started
7-
87
---
98

10-
import { GlossaryTooltip, Render, Steps } from "~/components"
11-
9+
import { GlossaryTooltip, Render, Steps } from "~/components";
1210

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

1513
:::note
16-
17-
Enabling API Shield features will have no impact on your traffic until you choose to move a setting from `log` to `block` mode.
14+
Enabling API Shield features will have no impact on your traffic until you choose to move a setting from `log` to `block` mode.
1815
:::
1916

2017
## Session identifiers
@@ -34,19 +31,17 @@ Schema validation protects your APIs by ensuring only requests matching your <Gl
3431
While not strictly required, uploading a pre-existing schema will offer the chance to automatically add endpoints to Endpoint Management. If you already have a schema, you can upload it to [Schema validation](/api-shield/security/schema-validation/).
3532

3633
:::note
37-
38-
It is recommended to start with Schema validation rules set to `log` to review logged requests in **Security** > **Events**. When you are confident that only the correct requests are logged, you should switch the rule to `block`.
34+
It is recommended to start with Schema validation rules set to `log` to review logged requests in [Security Events](/waf/analytics/security-events/). When you are confident that only the correct requests are logged, you should switch the rule to `block`.
3935
:::
4036

4137
If you do not have a schema to upload, continue reading this guide to learn how to generate a schema with API Shield.
4238

4339
## Enable the Sensitive Data Detection ruleset and accompanying rules
4440

45-
API Shield works with Cloudflare WAF’s [Sensitive Data Detection](/api-shield/management-and-monitoring/#sensitive-data-detection) ruleset to identify <GlossaryTooltip term="API endpoint">API endpoints</GlossaryTooltip> that return sensitive data such as social security or credit card numbers in their HTTP responses. Monitoring these endpoints can be critical to ensuring sensitive data is returned only when expected.
41+
API Shield works with Cloudflare WAF’s [Sensitive Data Detection](/api-shield/management-and-monitoring/endpoint-management/#sensitive-data-detection) ruleset to identify <GlossaryTooltip term="API endpoint">API endpoints</GlossaryTooltip> that return sensitive data such as social security or credit card numbers in their HTTP responses. Monitoring these endpoints can be critical to ensuring sensitive data is returned only when expected.
4642

4743
:::note
48-
49-
A subscription is required for Sensitive Data Detection. Contact your account team if you are not entitled for Sensitive Data Detection.
44+
A subscription is required for Sensitive Data Detection. Contact your account team if you are not entitled for Sensitive Data Detection.
5045
:::
5146

5247
You can identify endpoints returning sensitive data by selecting the icon next to the path in a row. Expand the endpoint to see details on which rules were triggered and view more information by exploring events in **Firewall Events**.
@@ -56,15 +51,14 @@ You can identify endpoints returning sensitive data by selecting the icon next t
5651
Cloudflare’s machine learning models have already inspected your existing traffic for the presence of API endpoints. By adding endpoints from API Discovery to Endpoint Management, you can unlock further security, visibility, and management features of the platform. Endpoint Management monitors the health of your API endpoints by saving, updating, and monitoring performance metrics.
5752

5853
:::note
59-
60-
Schema validation, schema learning, JWT validation, Sequence Analytics, sequence mitigation, and rate limit recommendations only run on endpoints saved to Endpoint Management.
54+
Schema validation, schema learning, JWT validation, Sequence Analytics, sequence mitigation, and rate limit recommendations only run on endpoints saved to Endpoint Management.
6155
:::
6256

63-
You can save your endpoints directly from [API Discovery](/api-shield/management-and-monitoring/#add-endpoints-from-api-discovery), [Schema validation](/api-shield/management-and-monitoring/#add-endpoints-from-schema-validation), or [manually](/api-shield/management-and-monitoring/#add-endpoints-manually) by method, path, and host.
57+
You can save your endpoints directly from [API Discovery](/api-shield/management-and-monitoring/endpoint-management/#add-endpoints-from-api-discovery), [Schema validation](/api-shield/management-and-monitoring/endpoint-management/#add-endpoints-from-schema-validation), or [manually](/api-shield/management-and-monitoring/endpoint-management/#add-endpoints-manually) by method, path, and host.
6458

6559
This will add the specified endpoints to your list of managed endpoints. You can view your list of saved endpoints in the **Endpoint Management** page.
6660

67-
Cloudflare will aggregate [performance data](/api-shield/management-and-monitoring/#endpoint-analysis) and security data on your endpoint once it is saved.
61+
Cloudflare will aggregate [performance data](/api-shield/management-and-monitoring/endpoint-management/#endpoint-analysis) and security data on your endpoint once it is saved.
6862

6963
### Allow the system to learn your traffic patterns
7064

@@ -92,9 +86,9 @@ You can import the learned schema of an entire hostname using the [Cloudflare da
9286

9387
## Export a learned schema from Endpoint Management
9488

95-
Learned schemas will always include the listed hostname in the servers section, all endpoints by host, method, and path, and detected path variables. They can also potentially include detected query parameters and their format. You can optionally include API Shields rate limit threshold recommendations.
89+
Learned schemas will always include the listed hostname in the servers section, all endpoints by host, method, and path, and detected path variables. They can also potentially include detected query parameters and their format. You can optionally include API Shield's rate limit threshold recommendations.
9690

97-
You can export your learned schemas in the [Cloudflare dashboard](/api-shield/management-and-monitoring/#export-a-schema) or via the [API](/api/resources/api_gateway/subresources/schemas/methods/list/).
91+
You can export your learned schemas in the [Cloudflare dashboard](/api-shield/management-and-monitoring/endpoint-management/schema-learning/#export-a-schema) or via the [API](/api/resources/api_gateway/subresources/schemas/methods/list/).
9892

9993
## View and configure Sequence Analytics
10094

0 commit comments

Comments
 (0)