Resolve a Security Alert

PUT 
/pub/v4.0/alert/update

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

Request

Query Parameters

id stringrequired

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

customerid stringrequired

The customer ID to which the API call is directed

application/json

Body

required

reason stringrequired

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

reason_type arrayrequired

Possible values: [Issue Mitigated, No Action Needed, VPN protected connections, Trusted remote destination, Normal behavior for this device, Normal behavior for all devices in the same IoT profile, Other]

This is the type of reason for resolving the alert.

resolved stringrequired

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

Responses

200

Successful Response

application/json

Schema

Schema

api string

The API path

ver string

API version

Example (from schema)

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

resolveSecurityAlertResponseExample

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

4XX

Client Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

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

Bad Request

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

Forbidden access

{
  "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."
}

Too many requests

{
  "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."
}

5XX

Server Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

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

resolveSecurityAlertResponseExample

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

Loading...