Appearance
Query an alert
About 134 wordsLess than 1 minute
apiAlert
MethodGET
Request URL
/plugin/datafor/api/alert/detailAuthorization
Use of this API requires authentication. For details about the authentication method, see
Authorization(Open in new window).
Preconditions
- The current user must have read privileges for the alert.
Content Type
No request body is typically sent with a GET request.
Parameters Schema
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| name | query | string | No | Alert name to be queried |
(Although an empty body {} is shown, this endpoint primarily uses the name query parameter.)
Response Examples
{
"msg": "success",
"success": true
}HTTP Responses
| HTTP Status Code | Meaning | Description | Data schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Data Schema (HTTP 200)
| Name | Type | Required | Description |
|---|---|---|---|
msg | string | No | Message string |
success | boolean | Yes | Request status |