Flashcat API (English)
API referenceDocs中文
API referenceDocs中文
  1. Open API
  • 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
      • Channel
      • Rule name
      • Rule description
      • Rule ID
      • Rule name
      • Inner conditions
      • Rule list
    • 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

Quick Start

Open API is used to access and operate FlashDuty's entity data, such as viewing and managing configurations. Using the API is essentially the same as performing operations through the FlashDuty Console after logging in.
TIP
If you want to push alerts from your own monitoring system to FlashDuty, please refer to Quick Start.

How to Access#

Request URL#

All APIs only accept HTTPS protocol access, and there is only one Endpoint:

Headers#

Most requests use the POST method and pass parameters using JSON Payload. In this case, don't forget to set the Content-Type header.

Character Encoding#

All APIs use UTF-8 encoding.

Authentication#

All Open APIs use APP Key for authentication. You can obtain an APP Key by following these steps:
1.
Log in to the FlashDuty Console
2.
Go to Account Settings - APP Key page, enter a name, and click the add button to complete creation
CAUTION
Each APP Key represents an independent user and has all operation permissions of that user. Please store it securely and avoid leakage.
Usage Example#
Simply pass the APP Key as a query string parameter. If your APP Key is 5e8fbfcdbf14d00696153, the request URL would be:

Response Structure#

Almost all request responses are in JSON format and follow this structure:
Field NameRequiredTypeDescription
request_idYesstringRequest ID for trace tracking
errorNoErrorError description, returned only when an error occurs
dataNointerface{}Data content, can be any format, refer to API definition for details
Error:
Field NameRequiredTypeDescription
codeYesstringError code, see Code for enumeration values
messageNostringError description
Code:
Error CodeHTTP StatusDescription
InvalidParameter400Parameter error
InvalidContentType400Content-Type not supported
MethodNotAllowed400HTTP Method not supported
Unauthorized401Authentication failed
AccessDenied403Authorization failed
RequestTooFrequently429Request too frequent
RouteNotFound404Request Method+Path not matched
ResourceNotFound400Account hasn't purchased resource, please proceed to billing center
NoLicense400Account has insufficient subscription license, please upgrade or purchase subscription in billing center
InternalError500Internal or unknown error
Modified at 2024-11-21 11:10:31
Next
About Pagination
Built with