You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/security/api-discovery.mdx
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,26 +46,24 @@ Cloudflare consolidates these to `{hostVar1}.example.com/api/v1/users/{var1}`.
46
46
47
47
For more technical details, refer to the [blog post](https://blog.cloudflare.com/ml-api-discovery-and-schema-learning/).
48
48
49
-
### Inbox view
49
+
### Discovered operations
50
50
51
-
API Shield first catalogs your discovered API endpoints in an inbox-style view. From API Discovery, you can save endpoints to [Endpoint Management](/api-shield/management-and-monitoring/) or ignore endpoints to remove them from view.
51
+
Web Assets adds discovered API endpoints to the operation inventory as candidate operations. Candidate operations provide context for matching, logging, detections, and rules before you manually review them.
52
52
53
-
Save all discovered API endpoints to Endpoint Management. Ignore any false positives by selecting **Save** or **Ignore** on each line, or use bulk selection.
53
+
You do not need to promote every discovered operation. Promote an operation to move it to the `full` state and start profile learning. Full operations support persisted API profiles, risk findings, and protections that require a known API endpoint.
54
54
55
-
To get started, search for `var1` in the search box to find all endpoints with path variables and save them first. You can examine endpoints without path variables later.
55
+
To promote a discovered operation:
56
56
57
-
Adding endpoints to Endpoint Management unlocks additional [security](/api-shield/security/), [visibility](/api-shield/management-and-monitoring/#endpoint-analysis), and [management](/api-shield/management-and-monitoring/) features.
58
-
59
-
To restore any errantly ignored endpoints, you can filter by **Ignored** and select **Restore**.
60
-
61
-
API Discovery is an ongoing process. Check back regularly for new results — a badge in the dashboard shows how many endpoints need review.
62
-
63
-
The **Needs Review** and **Ignored** counts may change over time as your API or traffic patterns change. Discovery results that are not saved can disappear.
57
+
<Steps>
58
+
1. In the Cloudflare dashboard, go to the **Web Assets** page.
3. Open the row actions for a candidate or shadow operation.
63
+
4. Select **Learn profile**.
64
+
</Steps>
66
65
67
-
Cloudflare will use your feedback on ignored endpoints to improve the API Discovery machine learning model in a future release.
68
-
:::
66
+
Cloudflare moves the operation to the `full` state. The row action then changes to **Profile learned**. For more information, refer to [Promote an operation](/security/web-assets/manage-operations/#promote-an-operation).
0 commit comments