Skip to content

Commit 3423eae

Browse files
Merge pull request #233860 from rayne-wiselman/rayne-defenderapi
first draft of Defender for APIs docs
2 parents c37a5e0 + 97f46ae commit 3423eae

27 files changed

+455
-76
lines changed

articles/defender-for-cloud/TOC.yml

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@
9595
- name: Defender for Cloud support matrices
9696
displayName: coverage, supported platforms, cloud services, roles, permissions
9797
href: support-matrix-defender-for-cloud.md
98+
- name: Defender for Cloud cloud support
99+
href: support-matrix-cloud-environment.md
98100
- name: Defender for Servers support matrices
99101
displayName: coverage, machines, windows, linux, multicloud, supported features, endpoint protections
100102
href: support-matrix-defender-for-servers.md
@@ -160,6 +162,9 @@
160162
- name: External attack surface management (EASM)
161163
displayName: EASM, attack surface management
162164
href: concept-easm.md
165+
- name: Agentless scanning
166+
displayName: agentless, scanning, virtual, machines, freshness, snapshot, snapshots
167+
href: concept-agentless-data-collection.md
163168
- name: Improve your data security posture
164169
items:
165170
- name: About data-aware security posture
@@ -182,6 +187,14 @@
182187
- name: Reference list of attack paths and cloud security graph components
183188
displayName: attack, paths, security, graph, components
184189
href: attack-path-reference.md
190+
- name: Security alerts
191+
items:
192+
- name: About security alerts and incidents
193+
displayName: security, alerts, classification, incident, threat, detection, analytics,
194+
href: alerts-overview.md
195+
- name: Security alerts reference list
196+
displayName: alerts, mitre
197+
href: alerts-reference.md
185198
- name: Plan Defender for Servers deployment
186199
items:
187200
- name: Get started
@@ -195,22 +208,13 @@
195208
href: plan-defender-for-servers-select-plan.md
196209
- name: Review agents and extensions
197210
href: plan-defender-for-servers-agents.md
211+
- name: Agentless scanning
212+
displayName: agentless, scanning, virtual, machines, freshness, snapshot, snapshots
213+
href: concept-agentless-data-collection.md
198214
- name: Scale a Defender for Servers deployment
199215
href: plan-defender-for-servers-scale.md
200216
- name: Common questions
201217
href: faq-defender-for-servers.yml
202-
- name: Protect cloud workloads
203-
items:
204-
- name: Agentless scanning
205-
displayName: agentless, scanning, virtual, machines, freshness, snapshot, snapshots
206-
href: concept-agentless-data-collection.md
207-
- name: Security alerts and incidents
208-
displayName: security, alerts, classification, incident, threat, detection, analytics,
209-
href: alerts-overview.md
210-
- name: Reference list of alerts
211-
displayName: alets, mitre
212-
href: alerts-reference.md
213-
214218
- name: How-to guides
215219
items:
216220
- name: Cloud security posture
@@ -368,6 +372,18 @@
368372
- name: Working with the Log Analytics agent
369373
displayName: log analytics, agent
370374
href: working-with-log-analytics-agent.md
375+
- name: Defender for APIs
376+
items:
377+
- name: About Defender for APIs
378+
href: defender-for-apis-introduction.md
379+
- name: Support and prerequisites
380+
href: defender-for-apis-prepare.md
381+
- name: Onboard Defender for APIs
382+
href: defender-for-apis-deploy.md
383+
- name: Investigate findings, recommendations, alerts
384+
href: defender-for-apis-posture.md
385+
- name: Manage Defender for APIs
386+
href: defender-for-apis-manage.md
371387
- name: Defender for Servers
372388
displayName: hybrid, arc, Defender for Servers
373389
items:

articles/defender-for-cloud/alerts-reference.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -739,8 +739,26 @@ VM_ThreatIntelCommandLineSuspectDomain | A possible connection to malicious loca
739739
VM_ThreatIntelSuspectLogon | A logon from a malicious IP has been detected | High
740740
VM_VbScriptHttpObjectAllocation| VBScript HTTP object allocation detected | High
741741

742+
## Alerts for Defender for APIs
743+
744+
**Alert (alert type)** | **Description** | **MITRE tactics** | **Severity**
745+
--- | --- | --- | ---
746+
**(Preview) Suspicious population-level spike in API traffic to an API endpoint**<br/> (API_PopulationSpikeInAPITraffic) | A suspicious spike in API traffic was detected at one of the API endpoints. The detection system used historical traffic patterns to establish a baseline for routine API traffic volume between all IPs and the endpoint, with the baseline being specific to API traffic for each status code (such as 200 Success). The detection system flagged an unusual deviation from this baseline leading to the detection of suspicious activity. | Impact | Medium
747+
**(Preview) Suspicious spike in API traffic from a single IP address to an API endpoint**<br/> (API_SpikeInAPITraffic) | A suspicious spike in API traffic was detected from a client IP to the API endpoint. The detection system used historical traffic patterns to establish a baseline for routine API traffic volume to the endpoint coming from a specific IP to the endpoint. The detection system flagged an unusual deviation from this baseline leading to the detection of suspicious activity. | Impact | Medium
748+
**(Preview) Unusually large response payload transmitted between a single IP address and an API endpoint**<br/> (API_SpikeInPayload) | A suspicious spike in API response payload size was observed for traffic between a single IP and one of the API endpoints. Based on historical traffic patterns from the last 30 days, Defender for APIs learns a baseline that represents the typical API response payload size between a specific IP and API endpoint. The learned baseline is specific to API traffic for each status code (e.g., 200 Success). The alert was triggered because an API response payload size deviated significantly from the historical baseline. | Initial access | Medium
749+
**(Preview) Unusually large request body transmitted between a single IP address and an API endpoint**<br/> (API_SpikeInPayload) | A suspicious spike in API request body size was observed for traffic between a single IP and one of the API endpoints. Based on historical traffic patterns from the last 30 days, Defender for APIs learns a baseline that represents the typical API request body size between a specific IP and API endpoint. The learned baseline is specific to API traffic for each status code (e.g., 200 Success). The alert was triggered because an API request size deviated significantly from the historical baseline. | Initial access | Medium
750+
**(Preview) Suspicious spike in latency for traffic between a single IP address and an API endpoint**<br/> (API_SpikeInLatency) | A suspicious spike in latency was observed for traffic between a single IP and one of the API endpoints. Based on historical traffic patterns from the last 30 days, Defender for APIs learns a baseline that represents the routine API traffic latency between a specific IP and API endpoint. The learned baseline is specific to API traffic for each status code (e.g., 200 Success). The alert was triggered because an API call latency deviated significantly from the historical baseline. | Initial access | Medium
751+
**(Preview) API requests spray from a single IP address to an unusually large number of distinct API endpoints**<br/>(API_SprayInRequests) | A single IP was observed making API calls to an unusually large number of distinct endpoints. Based on historical traffic patterns from the last 30 days, Defenders for APIs learns a baseline that represents the typical number of distinct endpoints called by a single IP across 20-minute windows. The alert was triggered because a single IP's behavior deviated significantly from the historical baseline. | Discovery | Medium
752+
**(Preview) Parameter enumeration on an API endpoint**<br/> (API_ParameterEnumeration) | A single IP was observed enumerating parameters when accessing one of the API endpoints. Based on historical traffic patterns from the last 30 days, Defender for APIs learns a baseline that represents the typical number of distinct parameter values used by a single IP when accessing this endpoint across 20-minute windows. The alert was triggered because a single client IP recently accessed an endpoint using an unusually large number of distinct parameter values. | Initial access | Medium
753+
**(Preview) Distributed parameter enumeration on an API endpoint**<br/> (API_DistributedParameterEnumeration) | The aggregate user population (all IPs) was observed enumerating parameters when accessing one of the API endpoints. Based on historical traffic patterns from the last 30 days, Defender for APIs learns a baseline that represents the typical number of distinct parameter values used by the user population (all IPs) when accessing an endpoint across 20-minute windows. The alert was triggered because the user population recently accessed an endpoint using an unusually large number of distinct parameter values. | Initial access | Medium
754+
**(Preview) Parameter value(s) with anomalous data types in an API call**<br/> (API_UnseenParamType) | A single IP was observed accessing one of your API endpoints and using parameter values of a low probability data type (e.g., string, integer, etc.). Based on historical traffic patterns from the last 30 days, Defender for APIs learns the expected data types for each API parameter. The alert was triggered because an IP recently accessed an endpoint using a previously low probability data type as a parameter input. | Impact | Medium
755+
**(Preview) Previously unseen parameter used in an API call**<br/> (API_UnseenParam) | A single IP was observed accessing one of the API endpoints using a previously unseen or out-of-bounds parameter in the request. Based on historical traffic patterns from the last 30 days, Defender for APIs learns a set of expected parameters associated with calls to an endpoint. The alert was triggered because an IP recently accessed an endpoint using a previously unseen parameter. | Impact | Medium
756+
**(Preview) Access from a Tor exit node to an API endpoint**<br/> (API_AccessFromTorExitNode) | An IP address from the Tor network accessed one of your API endpoints. Tor is a network that allows people to access the Internet while keeping their real IP hidden. Though there are legitimate uses, it is frequently used by attackers to hide their identity when they target people's systems online. | Pre-attack | Medium
757+
**(Preview) API Endpoint access from suspicious IP**<br/> (API_AccessFromSuspiciousIP) | An IP address accessing one of your API endpoints was identified by Microsoft Threat Intelligence as having a high probability of being a threat. While observing malicious Internet traffic, this IP came up as involved in attacking other online targets. | Pre-attack | High
758+
**(Preview) Suspicious User Agent detected**<br/> (API_AccessFromSuspiciousUserAgent) |
759+
The user agent of a request accessing one of your API endpoints contained anomalous values indicative of an attempt at remote code execution. This does not mean that any of your API endpoints have been breached, but it does suggest that an attempted attack is underway. | Execution | Medium
760+
742761
## Next steps
743-
To learn more about Microsoft Defender for Cloud security alerts, see the following:
744762

745763
- [Security alerts in Microsoft Defender for Cloud](alerts-overview.md)
746764
- [Manage and respond to security alerts in Microsoft Defender for Cloud](managing-and-responding-alerts.md)

articles/defender-for-cloud/concept-cloud-security-posture-management.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Defender for Cloud continually assesses your resources, subscriptions and organi
1717
- **Foundational CSPM capabilities** - None
1818
- **Defender Cloud Security Posture Management (CSPM)** - Agentless scanning requires the **Subscription Owner** to enable the plan. Anyone with a lower level of authorization can enable the Defender CSPM plan but the agentless scanner won't be enabled by default due to lack of permissions. Attack path analysis and security explorer won't be populated with vulnerabilities because the agentless scanner is disabled.
1919

20-
For commercial and national cloud coverage, see the [features supported in different Azure cloud environments](support-matrix-defender-for-cloud.md#features-supported-in-different-azure-cloud-environments).
20+
For commercial and national cloud coverage, review [features supported in different Azure cloud environments](support-matrix-cloud-environment.md).
21+
2122

2223
## Defender CSPM plan options
2324

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Enable Defender for APIs in Defender for Cloud
3+
description: Learn about deploying the Defender for APIs plan in Defender for Cloud
4+
author: elazark
5+
ms.author: elkrieger
6+
ms.service: defender-for-cloud
7+
ms.topic: conceptual
8+
ms.date: 03/23/2023
9+
---
10+
# Onboard Defender for APIs
11+
12+
This article describes how to deploy the [Microsoft Defender for APIs](defender-for-apis-introduction.md) plan in the Microsoft Defender for Cloud portal. Defender for APIs is currently in preview.
13+
14+
## Before you start
15+
16+
- Review [Defender for APIs support, permissions, and requirements](defender-for-apis-introduction.md) before you begin deployment.
17+
- Make sure that Defender for Cloud is enabled in your Azure subscription. You enable Defender for APIs at the subscription level.
18+
- Ensure that APIs you want to secure are published in [Azure API management](/azure/api-management/api-management-key-concepts). Follow [these instructions](/azure/api-management/get-started-create-service-instance) to set up Azure API Management.
19+
20+
> [!NOTE]
21+
> This article describes how to enable and onboard the Defender for APIs plan in the Defender for Cloud portal. Alternately, you can [enable Defender for APIs within an API Management instance](../api-management/protect-with-defender-for-apis.md) in the Azure portal.
22+
23+
## Enable the plan
24+
25+
1. Sign into the [portal](https://portal.azure.com/), and in Defender for Cloud, select **Environment settings**.
26+
1. Select the subscription that contains the managed APIs that you want to protect.
27+
1. In the **APIs** plan, select **On**. Then select **Save**.
28+
29+
:::image type="content" source="media/defender-for-apis-deploy/enable-plan.png" alt-text="Screenshot that shows how to turn on the Defender for APIs plan in the portal." lightbox="media/defender-for-apis-deploy/enable-plan.png":::
30+
31+
> [!NOTE]
32+
> After enabling Defender for APIs, onboarded APIs take up to 50 minutes to appear in the **Recommendations** tab. Security insights are available in the **Workload protections** > **API security** dashboard within 40 minutes of onboarding.
33+
34+
## Onboard APIs
35+
36+
1. In the Defender for Cloud portal, select **Recommendations**.
37+
1. Search for *Defender for APIs*.
38+
1. Under **Enable enhanced security features**, select the security recommendation **Azure API Management APIs should be onboarded to Defender for APIs**.
39+
40+
:::image type="content" source="media/defender-for-apis-deploy/api-recommendations.png" alt-text="Screenshot that shows how to turn on the Defender for APIs plan from the recommendation." lightbox="media/defender-for-apis-deploy/api-recommendations.png":::
41+
42+
43+
1. In the recommendation page, you can review the recommendation severity, update interval, description, and remediation steps.
44+
1. Review the resources in scope for the recommendations:
45+
- **Unhealthy resources**: Resources that aren't onboarded to Defender for APIs.
46+
- **Healthy resources**: API resources that are onboarded to Defender for APIs.
47+
- **Not applicable resources**: API resources that aren't applicable for protection.
48+
49+
1. In **Unhealthy resources**, select the APIs that you want to protect with Defender for APIs.
50+
1. Select **Fix**.
51+
52+
:::image type="content" source="media/defender-for-apis-deploy/api-recommendation-details.png" alt-text="Screenshot that shows the recommendation details for turning on the plan." lightbox="media/defender-for-apis-deploy/api-recommendation-details.png":::
53+
54+
1. In **Fixing resources**, review the selected APIs, and select **Fix resources**.
55+
56+
:::image type="content" source="media/defender-for-apis-deploy/fix-resources.png" alt-text="Screenshot that shows how to fix unhealthy resources." lightbox="media/defender-for-apis-deploy/fix-resources.png":::
57+
58+
1. Verify that remediation was successful.
59+
60+
:::image type="content" source="media/defender-for-apis-deploy/fix-resources-confirm.png" alt-text="Screenshot that confirms that remediation was successful." lightbox="media/defender-for-apis-deploy/fix-resources-confirm.png":::
61+
62+
## Track onboarded API resources
63+
64+
After onboarding the API resources, you can track their status in the Defender for Cloud portal > **Workload protections** > **API security**.
65+
66+
:::image type="content" source="media/defender-for-apis-deploy/track-resources.png" alt-text="Screenshot that shows how to track onboarded API resources." lightbox="media/defender-for-apis-deploy/track-resources.png":::
67+
68+
69+
## Next steps
70+
71+
[Review](defender-for-apis-posture.md) API threats and security posture.
72+

0 commit comments

Comments
 (0)