Appearance
Query an alert
About 140 wordsLess than 1 minute
apiAlert
2025-03-13
MethodGET
Request URL
/plugin/datafor/api/alert/detail
Authorization
Use of this API requires authentication. For details about the authentication method, see
Authorization.
Preconditions
- The current user must have read privileges for the alert.
Content Type
No request body is typically sent with a GET request.
Request 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 |