Flashcat API (English)
API referenceDocs中文
API referenceDocs中文
  1. Open API
  2. Alert Management
  • Open API
    • Quick Start
    • About Pagination
    • Member Management
      • Invite members
      • Delete member
      • Reset information
      • Member list
    • Team Management
      • Team list
      • Basic information
      • Delete team
      • Team upsert
    • Schedule Management
      • Preview schedule
      • Update schedule
      • Enable schedule
      • Disable schedule
      • Create schedule
      • Delete schedule
      • View schedule details
      • Get schedule information by ID list
      • View schedule list
      • Personal schedule calendar
      • Role information
    • Information Retrieval
      • Channel
      • Member
      • Team
    • Preference Settings
      • View preference settings
      • Modify preference settings
    • Channel
      • Escalation Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Rule details
        • Create rule
        • Update rule
      • Subscription Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Create rule
        • Update rule
      • Drop Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Create rule
        • Update rule
      • Silence Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Rule details
        • Inner conditions
      • Inhibit Rules
        • Disable rule
        • Delete rule
        • Rule list
        • See creation interface for filters explanation
        • Channel ID
        • Rule name
      • Match conditions
      • Delete rule
      • See creation interface for filters explanation
      • Enable rule
      • Update rule
      • Rule ID
      • Rule name
      • Sort
      • Delete rule
      • See creation interface for filters explanation
      • Name by integration
      • Robot list
    • Template Management
      • Name
      • Enable rule
      • Delete rule
      • See creation interface for filters explanation
      • Channel ID
      • Rule name
      • Required when updating
      • Update rule
    • Incident Management
      • Group View
        • Channel
        • Rule name
        • Inner conditions
        • Channel
      • Match conditions
      • Enable rule
      • Disable rule
      • Delete rule
      • Rule list
      • See creation interface for filters explanation
      • Create rule
      • Rule description
      • Update rule
      • Channel
      • Match conditions
      • Match conditions
      • Update rule
      • Channel
      • Rule ID
      • Inner conditions
      • Enable rule
      • Rule list
      • Rule details
      • Rule name
      • Rule description
      • Match conditions
      • Rule description
      • See creation interface for filters explanation
      • Disable rule
      • Rule description
    • Alert Management
      • Group View
        • Required when updating
        • Rule name
        • Inner conditions
        • Disable rule
      • Rule ID
        POST
      • Channel
        POST
      • Rule name
        POST
      • Rule description
        POST
      • Rule ID
        POST
      • Rule name
        POST
      • Inner conditions
        POST
      • Rule list
        POST
    • Change Management
      • Inner conditions
    • Insights (old)
      • Channel
      • Match conditions
      • Rule ID
      • Enable rule
      • Name
      • Disable rule
      • Rule name
      • Name
      • See creation interface for filters explanation
    • Custom Fields
      • Enable rule
      • Disable rule
      • See creation interface for filters explanation
      • Channel ID
      • Channel
    • Service Calendar
      • Match conditions
      • Delete rule
      • Update rule
      • Required when updating
      • Rule details
      • Required when updating
      • Inner conditions
      • Channel
    • Label Enhancement
      • Mapping
        • Rule name
        • Rule list
        • Rule description
        • Match conditions
        • Rule ID
        • Rule description
        • Inner conditions
        • Enable rule
        • Disable rule
        • Rule description
      • Enable rule
      • Delete rule
    • Alert Processing
      • Create rule
      • Rule name
    • Integration Routing
      • Required when updating
      • Rule description
      • Match conditions
    • License Management
      • Create rule
    • Insights
      • Team Metrics
      • Responder Metrics Export
      • Incident List
      • Responder Metrics
      • Account Metrics
      • Channel Metrics Export
      • Team Metrics Export
      • Incident Export
      • Alert Top
      • Cahnnel Metrics
  • Event API
    • Quick Start
    • Alert Event
    • Change Event
  • Webhook
    • Quick Start
    • Custom Actions
    • Alert Webhook
    • Incident Webhook
  1. Open API
  2. Alert Management

Rule description

POST
/alert/list

Request

Body Params application/json
search_after_ctx
string 
Inner conditions
optional
Match conditions
p
integer 
Name
optional
Update rule
Default:
1
limit
integer 
Channel
optional
Rule ID
>= 0<= 100
Default:
20
asc
boolean 
Required when updating
optional
Rule name
orderby
string 
Rule description
optional
Inner conditions
title
string 
Match conditions
optional
Name
progress
string 
Enable rule
optional
Disable rule
alert_severity
string 
Delete rule
optional
Rule list
labels
object (Labels) 
optional
^[a-zA-Z_][a-zA-Z0-9_]*$
string 
(pattern property)
Channel
optional
Rule ID
<= 512 characters
channel_ids
array[integer]
See creation interface for filters explanation
optional
data_source_ids
array[integer]
Rule details
optional
alert_ids
array[string]
Channel ID
required
ever_muted
boolean 
Rule ID
optional
Create rule
start_time
integer 
Channel
required
Rule name
end_time
integer 
Rule description
required
Inner conditions
Example

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/alert/list' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200成功
application/json
Body
error
object (DutyError) 
optional
code
enum<string> 
Rule description
required
Allowed values:
InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist
message
string 
Inner conditions
required
data
object 
optional
items
array[object (Alert) {26}] 
Match conditions
optional
search_after_ctx
string 
optional
Name
total
integer 
optional
Update rule
has_next_page
boolean 
optional
Channel
Example
{
  "error": {
    "code": "InvalidParameter",
    "message": "string"
  },
  "data": {
    "items": [
      {
        "alert_id": "string",
        "channel_id": 0,
        "channel_name": "string",
        "data_source_id": 0,
        "data_source_name": "string",
        "data_source_type": "string",
        "data_source_ref_id": "string",
        "title": "string",
        "title_rule": "string",
        "description": "string",
        "alert_key": "string",
        "alert_severity": "Info",
        "alert_status": "Info",
        "progress": "Triggered",
        "start_time": 0,
        "last_time": 0,
        "end_time": 0,
        "close_time": 0,
        "created_at": 0,
        "updated_at": 0,
        "labels": {},
        "events": [
          {
            "event_id": "string",
            "data_source_id": 0,
            "channel_id": 0,
            "title": "string",
            "title_rule": "string",
            "description": "string",
            "alert_id": "string",
            "event_status": "Info",
            "event_severity": "Info",
            "event_time": 0,
            "labels": {}
          }
        ],
        "responder_id": 0,
        "incident": {
          "incident_id": "string",
          "title": "string"
        },
        "event_cnt": 0,
        "ever_muted": true
      }
    ],
    "search_after_ctx": "string",
    "total": 0,
    "has_next_page": true
  }
}
Modified at 2025-01-22 10:14:38
Previous
Rule name
Next
Rule ID
Built with