Add, update, or delete a scan definition

Article
04/30/2024

Applies to:

Want to experience Microsoft Defender for Endpoint? Sign up for a free trial.

Want to experience Microsoft Defender Vulnerability Management? Learn more about how you can sign up to the Microsoft Defender Vulnerability Management public preview trial.

Important

Some information in this article relates to a prereleased product which may be substantially modified before it's commercially released. Microsoft makes no warranties, expressed or implied, with respect to the information provided here.

Note

If you are a US Government customer, please use the URIs listed in Microsoft Defender for Endpoint for US Government customers.

Tip

For better performance, you can use server closer to your geo location:

us.api.security.microsoft.com
eu.api.security.microsoft.com
uk.api.security.microsoft.com
au.api.security.microsoft.com
swa.api.security.microsoft.com

API description

API to add, update, or delete an authenticated scan.

Limitations

Rate limitations for this API are 100 calls per minute and 1,500 calls per hour.

You can post on machines last seen according to your configured retention period.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Use Defender for Endpoint APIs.

Permission type	Permission	Permission display name
Application	Machine.ReadWrite.All	Read and write all scan information.
Delegated (work or school account)	Machine.Read.Write	Read and write all scan information.

Note

When obtaining a token using user credentials:

To view data the user needs to have at least the following role permission: ViewData or TvmViewData (See Create and manage roles for more information)
To edit data the user needs to have at least the following role permission: ManageSecurity (See Create and manage roles for more information)

HTTP request

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions

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
scanType	Enum	The type of scan. Possible values are: "Windows", "Network". Required.
scanName	String	Name of the scan. Required.
isActive	Boolean	Status of whether the scan actively running. Required.
target	String	A comma separated list of targets to scan, either IP addresses or hostnames. Required.
intervalInHours	Int	The interval at which the scan runs. Required.
targetType	String	The target type in the target field. Possible types are "IP Address" or "Hostname". Default value is IP Address. Required.
scannerAgent	Object	machine Id. Required.
scanAuthenticationParams	Object	An object representing the authentication parameters, see Authentication parameters object properties for expected fields. This property is mandatory when creating a new scan and is optional when updating a scan.

Response

If successful, this method returns 200 - Ok response code and the new or updated scan definition in the response body.

Example request to add a new scan

Here's an example of a request that adds a new scan.

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions

 {
"scanType": "Windows", 
"scanName": "Test Windows scan", 
"isActive": true, 
"target": "127.0.0.1", 
"intervalInHours": 1, 
"targetType": "Ip",
"scannerAgent": {
    "machineId": "eb663a27ae9d032f61bc268a79eedf14c4b90f77",
},
"scanAuthenticationParams": { 
    "@odata.type": "#microsoft.windowsDefenderATP.api.WindowsAuthParams", 
    "type": "Kerberos", 
    "username": "username", 
    "domain": "password",
    "isGmsaUser": true
    }
}

Example response

Here's an example of the response.

 {
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#DeviceAuthenticatedScanDefinitions/$entity",
    "id": "289224fb-1686-472c-9751-5555960854ca",
    "scanType": "Windows",
    "scanName": "Test Windows scan",
    "isActive": true,
    "target": "127.0.0.1",
    "orgId": "0335a792-18d2-424b-aeed-559567054570",
    "intervalInHours": 1,
    "createdBy": "username@test.com",
    "targetType": "Ip",
    "scanAuthenticationParams": null,
    "scannerAgent": {
        "id": "0335a792-18d2-424b-aeed-559567054570_ eb663a27ae9d032f61bc268a79eedf14c4b90f77",
        "machineId": "eb663a27ae9d032f61bc268a79eedf14c4b90f77",
        "machineName": "DESKTOP-TEST",
        "lastSeen": "2023-01-04T09:40:03.2787058Z",
        "assignedApplicationId": "ae4a5cde-b4a1-4b76-8635-458b2cf15752",
        "scannerSoftwareVersion": "7.6.0.0",
        "lastCommandExecutionTimestamp": "2023-01-04T09:33:16Z",
        "mdeClientVersion": "10.8295.22621.1010"
    },
    "latestScan": {
        "status": null,
        "failureReason": null,
        "executionDateTime": null
    }

}

Example request to update a scan

Here's an example of a request that updates a scan.

PATCH  https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/289224fb-1686-472c-9751-5555960854ca

{
"scanName": "Test Update Windows scan", 
"isActive": false, 
"target": "127.0.0.2,127.0.0.3", 
"intervalInHours": 1, 
"targetType": "Ip",
"scanAuthenticationParams": { 
    "@odata.type": "#microsoft.windowsDefenderATP.api.WindowsAuthParams", 
    "type": "Kerberos", 
    "username": "username", 
    "domain": "password",
    "isGmsaUser": true
    }
 }

Response example