• HTTP document
    Show / Hide Table of Contents
    • Login Interface
      • Explanation of terms
      • Login
      • Refresh Login
    • Write Data Process
      • Add FGate Group
      • Add FGate
      • Add Monitoring Group
      • Add Monitoring Point
      • Get FGate List
      • FGate Monitoring List
      • Write Monitoring Value
      • Get Monitoring Value
    • Information Access
      • Get Single FGate
      • Get Monitoring Group
      • Get Some monitoring Points
      • Get Monitoring Point by Group
      • Get Iccid、Imei
      • Get Location of FGate
    • Remote Download
      • Get FGate Drive List
      • Download FGate Drive
      • Get Register Type of Device
      • Get Server Drive List
    • Modification Interface
      • Modify FGate Group
      • Modify FGate Name
      • Modify Monitoring
      • Modify Refresh Interval
    • Delete Interface
      • Delete FGate Group
      • Delete FGate
      • Delete Monitoring Group
      • Delete Monitoring Point
    • Alarm Interface
      • Alarm Group
        • Get Alarm Group List
        • Add Alarm Group
        • Modify Alarm Group
        • Delete Alarm Group
      • Alarm Contact
        • Get Alarm Contact List
        • Get Single Alarm Contact
        • Add Alarm contact
        • Modify Alarm Contact
        • Delete Alarm Contact
      • Alarm Record
        • Get Alarm Entry List
        • Get Alarm Entry
        • Add Alarm Entry
        • Modify Alarm Entry
        • Delete Alarm Entry
        • Get Historical Alarm
        • Get Alarm Entry Status
        • Confirm Alarm
    • Historical Data
      • Get Historical Data List
      • Get Historical Data Entry
      • Add Historical Record
      • Update Historical Record
      • Delete Historical Data
      • Get Historical Data
    • Push Monitoring Data
      • Enable Monitoring Group
      • Disable Monitoring Group
      • Enable Monitoring Group List
      • Disable Monitoring Group List
      • Enable All Monitoring Points
      • Disable All Monitoring Points
      • Enable One Monitoring Point
      • Disable One Monitoring Point
      • Enable Some Monitoring Points
      • Disable Some Monitoring Points
      • Enable Some Monitoring Points
      • Enable One Monitoring Group
      • Enable Some Monitoring Groups
    • Data Push(SignalR)
      • Real-time Data Push(signalR)
      • Status Change Push
      • Real-time Data Push
      • Alarm Trigger
      • Alarm Restore
    • Write in Batch
      • Get Bacth Write Group
      • Write Value in Batch
    • Appendix
      • Appendix One
      • Appendix Two
      • Appendix Three
      • 429 Status Code

    Add Alarm Group

    • Description

      This interface is used for users to add alarm groups.

    • Request URL

      URL:[Host Server]/api/v2/alarm/group

    • Query Parameters

      Field Type Description
      Host Server string See Explanation of terms
    • Method

      PUT

    • Headers

      Field Type Description
      Authorization string "Bearer " + Access Token obtained from the login interface
    • Body

      Field Type Description
      boxId string FGate id
      name string "Alarm Group Name," within 20 characters.
      memo string "Alarm Group Remarks"
      cuids list "Collection of Alarm Contact IDs (if no alarm contacts, pass an empty array)."
    • Response Success

      NULL

    • Response Codes

      Field Description
      401 Access Token Expired
      404 This name has already existed.
      409 Alarm Contact Does Not Exist
      400 Error message in the HTTP header[X-FBox-Code], see Appendix Three for details.
      500 "Invalid Parameters"
    • Postman example is as follows:

    Login Interface

    • Please see the example in the following image.

    Login Interface

    Back to top Generated by DocFX