Resolve a Security Alert

Resolve a security alert.
Rate limiting: 60 times per minute

Query Parameters

• id string required

  The alert ID being resolved. To retrieve a list of security alerts, including their IDs, use Get Security Alerts

• customerid string required

  The customer ID to which the API call is directed

application/json

Request Body required

• reason string required

  The reason for resolving the alert. The following string cannot contain any special characters.

• reason_type string required

  The reason for resolving the alert. It must be one of the following four text strings (excluding numbers): 1. No Action Needed 2. Issue Mitigated 3. Normal behavior for this device 4. Normal behavior for all devices in the same IoT profile

• resolved string required

  Declaration that the alert is resolved. The following string must be “yes”.

Responses

• 200
• 4XX
• 5XX

---

Successful Response

application/json

• Schema
• Example (from schema)
• resolveSecurityAlertResponseExample

---

Schema

• api string

  The API path

• ver string

  API version

{
  "api": "string",
  "ver": "string"
}

{
  "api": "/pub/v4.0/alert/update",
  "ver": "v4.0"
}

Client Error Response

application/json

• Schema
• Example (from schema)
• Bad Request
• Forbidden access
• Too many requests

---

Schema

• code string

  STATUS_CODE

• msg string

  GENERAL_MESSAGE

{
  "code": "string",
  "msg": "string"
}

{
  "code": 400,
  "msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}

{
  "code": 403,
  "msg": "Forbidden access. Either the provided API key is invalid or it does not have the required RBAC permissions to run this API."
}

{
  "code": 429,
  "msg": "Too many requests. The number of requests for device details for a single device exceeded the rate limit of 180 queries per minute per tenant."
}

Server Error Response

application/json

• Schema
• Example (from schema)
• resolveSecurityAlertResponseExample

---

Schema

• code string

  STATUS_CODE

• msg string

  GENERAL_MESSAGE

{
  "code": "string",
  "msg": "string"
}

{
  "code": 500,
  "msg": "Internal server error. A unified status for API communication type errors."
}

Loading...