mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-06-05 00:57:22 +00:00
3.8 KiB
3.8 KiB
title, description, keywords, search.product, ms.prod, ms.mktglfcycl, ms.sitesec, ms.pagetype, ms.author, author, ms.localizationpriority, manager, audience, ms.collection, ms.topic
title | description | keywords | search.product | ms.prod | ms.mktglfcycl | ms.sitesec | ms.pagetype | ms.author | author | ms.localizationpriority | manager | audience | ms.collection | ms.topic |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Submit or Update Indicator API | Use this API to submit or Update Indicator. | apis, graph api, supported apis, submit, ti, indicator, update | eADQiWindows 10XVcnh | w10 | deploy | library | security | macapara | mjcaparas | medium | dansimp | ITPro | M365-security-compliance | article |
Submit or Update Indicator API
Applies to: Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)
- Want to experience Microsoft Defender ATP? Sign up for a free trial.
API description
Submits or Updates new Indicator entity.
CIDR notation for IPs is supported.
Limitations
- Rate limitations for this API are 100 calls per minute and 1500 calls per hour.
- There is a limit of 5,000 active indicators per tenant.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Get started
Permission type | Permission | Permission display name |
---|---|---|
Application | Ti.ReadWrite | 'Read and write Indicators' |
Application | Ti.ReadWrite.All | 'Read and write All Indicators' |
Delegated (work or school account) | Ti.ReadWrite | 'Read and write Indicators' |
HTTP request
POST https://api.securitycenter.windows.com/api/indicators
[!includeImprove request performance]
Request headers
Name | Type | Description |
---|---|---|
Authorization | String | Bearer {token}. Required. |
Content-Type | string | application/json. Required. |
Request body
In the request body, supply a JSON object with the following parameters:
Parameter | Type | Description |
---|---|---|
indicatorValue | String | Identity of the Indicator entity. Required |
indicatorType | Enum | Type of the indicator. Possible values are: "FileSha1", "FileSha256", "IpAddress", "DomainName" and "Url". Required |
action | Enum | The action that will be taken if the indicator will be discovered in the organization. Possible values are: "Alert", "AlertAndBlock", and "Allowed". Required |
application | String | The application associated with the indicator. Optional |
title | String | Indicator alert title. Required |
description | String | Description of the indicator. Required |
expirationTime | DateTimeOffset | The expiration time of the indicator. Optional |
severity | Enum | The severity of the indicator. possible values are: "Informational", "Low", "Medium" and "High". Optional |
recommendedActions | String | TI indicator alert recommended actions. Optional |
rbacGroupNames | String | Comma-separated list of RBAC group names the indicator would be applied to. Optional |
Response
- If successful, this method returns 200 - OK response code and the created / updated Indicator entity in the response body.
- If not successful: this method return 400 - Bad Request. Bad request usually indicates incorrect body.
Example
Request
Here is an example of the request.
POST https://api.securitycenter.windows.com/api/indicators
Content-type: application/json
{
"indicatorValue": "220e7d15b011d7fac48f2bd61114db1022197f7f",
"indicatorType": "FileSha1",
"title": "test",
"application": "demo-test",
"expirationTime": "2020-12-12T00:00:00Z",
"action": "AlertAndBlock",
"severity": "Informational",
"description": "test",
"recommendedActions": "nothing",
"rbacGroupNames": ["group1", "group2"]
}