2020-02-06 11:41:57 -08:00

3.6 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
Common Microsoft Defender ATP API errors List of common Microsoft Defender ATP API errors with descriptions. apis, mdatp api, errors, troubleshooting eADQiWindows 10XVcnh w10 deploy library security macapara mjcaparas medium dansimp ITPro M365-security-compliance article

Common REST API error codes

  • The error codes listed in the following table may be returned by an operation on any of Microsoft Defender ATP APIs.
  • Note that in addition to the error code, every error response contains an error message which can help resolving the problem.
  • Note that the message is a free text that can be changed.
  • At the bottom of the page you can find response examples.
Error code HTTP status code Message
BadRequest BadRequest (400) General Bad Request error message.
ODataError BadRequest (400) Invalid OData URI query (the specific error is specified).
InvalidInput BadRequest (400) Invalid input {the invalid input}.
InvalidRequestBody BadRequest (400) Invalid request body.
InvalidHashValue BadRequest (400) Hash value {the invalid hash} is invalid.
InvalidDomainName BadRequest (400) Domain name {the invalid domain} is invalid.
InvalidIpAddress BadRequest (400) IP address {the invalid IP} is invalid.
InvalidUrl BadRequest (400) URL {the invalid URL} is invalid.
MaximumBatchSizeExceeded BadRequest (400) Maximum batch size exceeded. Received: {batch size received}, allowed: {batch size allowed}.
MissingRequiredParameter BadRequest (400) Parameter {the missing parameter} is missing.
OsPlatformNotSupported BadRequest (400) OS Platform {the client OS Platform} is not supported for this action.
ClientVersionNotSupported BadRequest (400) {The requested action} is supported on client version {supported client version} and above.
Unauthorized Unauthorized (401) Unauthorized (usually invalid or expired authorization header).
Forbidden Forbidden (403) Forbidden (valid token but insufficient permission for the action).
DisabledFeature Forbidden (403) Tenant feature is not enabled.
DisallowedOperation Forbidden (403) {the disallowed operation and the reason}.
NotFound Not Found (404) General Not Found error message.
ResourceNotFound Not Found (404) Resource {the requested resource} was not found.
InternalServerError Internal Server Error (500) (No error message, try retry the operation or contact us if it does not resolved)

Body parameters are case sensitive

The submitted body parameters are currently case sensitive.
If you experience an InvalidRequestBody or MissingRequiredParameter errors, it might be caused from a wrong parameter capital or lower-case letter.
It is recommended to go to the requested Api documentation page and check that the submitted parameters match the relevant example.

Correlation request ID

Each error response contains a unique ID parameter for tracking.
The property name of this parameter is "target".
When contacting us about an error, attaching this ID will help find the root cause of the problem.

Examples

{
    "error": {
        "code": "ResourceNotFound",
        "message": "Machine 123123123 was not found",
        "target": "43f4cb08-8fac-4b65-9db1-745c2ae65f3a"
    }
}
{
    "error": {
        "code": "InvalidRequestBody",
        "message": "Request body is incorrect",
        "target": "1fa66c0f-18bd-4133-b378-36d76f3a2ba0"
    }
}