Flashcat API (English)
API referenceDocs中文
API referenceDocs中文
  1. Incident 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
        POST
      • Enable rule
        POST
      • Disable rule
        POST
      • Delete rule
        POST
      • Rule list
        POST
      • See creation interface for filters explanation
        POST
      • Create rule
        POST
      • Rule description
        POST
      • Update rule
        POST
      • Channel
        POST
      • Match conditions
        POST
      • Match conditions
        POST
      • Update rule
        POST
      • Channel
        POST
      • Rule ID
        POST
      • Inner conditions
        POST
      • Enable rule
        POST
      • Rule list
        POST
      • Rule details
        POST
      • Rule name
        POST
      • Rule description
        POST
      • Match conditions
        POST
      • Rule description
        POST
      • See creation interface for filters explanation
        POST
      • Disable rule
        POST
      • Rule description
        POST
    • Alert Management
      • Group View
        • Required when updating
        • Rule name
        • Inner conditions
        • Disable rule
      • Alert Info
      • Close Alert
      • Alert List By Card
      • Alert List
      • Alert List By ID
      • Event List
      • Feed
      • Merge Incident
    • 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. Incident Management

Rule description

POST
/incident/create

Request

Header Params
Content-Type
string 
required
Example:
application/json
Body Params application/json
title
string 
Inner conditions
required
description
string 
Match conditions
optional
incident_severity
string 
Name
required
channel_id
integer 
Enable rule
optional
Disable rule
assigned_to
object (Assignment) 
optional
person_ids
array[integer]
Match conditions
optional
Name
escalate_rule_id
string 
Update rule
optional
Channel
escalate_rule_name
string 
Rule ID
optional
layer_idx
integer 
Required when updating
optional
Rule name
layer_person_reset
object 
Inner conditions
optional
Match conditions
type
enum<string> 
Name
optional
Allowed values:
assignreassignescalatereopen
Example
{
    "title": "string",
    "description": "string",
    "incident_severity": "string",
    "channel_id": 0,
    "assigned_to": {
        "person_ids": [
            0
        ],
        "escalate_rule_id": "string",
        "escalate_rule_name": "string",
        "layer_idx": 0,
        "layer_person_reset": {
            "0": {
                "team_ids": [
                    0
                ],
                "person_ids": [
                    0
                ],
                "schedule_to_role_ids": {
                    "{schedule_id}": [
                        0
                    ]
                }
            }
        },
        "type": "assign"
    }
}

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/incident/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "string",
    "description": "string",
    "incident_severity": "string",
    "channel_id": 0,
    "assigned_to": {
        "person_ids": [
            0
        ],
        "escalate_rule_id": "string",
        "escalate_rule_name": "string",
        "layer_idx": 0,
        "layer_person_reset": {
            "0": {
                "team_ids": [
                    0
                ],
                "person_ids": [
                    0
                ],
                "schedule_to_role_ids": {
                    "{schedule_id}": [
                        0
                    ]
                }
            }
        },
        "type": "assign"
    }
}'

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
incident_id
string 
Delete rule
required
title
string 
Rule list
required
Example
{
    "error": {
        "code": "InvalidParameter",
        "message": "string"
    },
    "data": {
        "incident_id": "string",
        "title": "string"
    }
}
Modified at 2025-01-22 10:14:38
Previous
Match conditions
Next
See creation interface for filters explanation
Built with