Node

• OpenAPI Version: 3.1.0
• API Version: 1.0.0

Zoom Node is a central hub for hosting Zoom workloads — or modules — that provide Zoom functionalities, such as meetings or calling. It’s optimized to help address customer requirements in the areas of compliance, security, survivability and bandwidth optimization.

Operations

POST node.rc_stat

• Method: POST
• Path: node.rc_stat
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the recording statistics.

  • object (required)

    object

    • rc_stats (required)

      array

      Items:

      • rc_service_id (required)

        string — The RC's Zoom Node service ID.

      • rc_service_name (required)

        string — The RC's Zoom Node service name.

      • recording_zone (required)

        string — The RC's recording zone.

      • current_recording_count

        number — The number of concurrent recordings on the RC.

      • current_transcoding_count

        number — The number of concurrent transcodings on the RC.

      • timestamp

        string — The timestamp of the data being collected.

      • transcoding_queue_depth

        number — The number of recordings waiting to be transcoded on the RC.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "rc_stats": [
        {
          "rc_service_id": "",
          "rc_service_name": "",
          "recording_zone": "",
          "current_recording_count": 1,
          "current_transcoding_count": 1,
          "transcoding_queue_depth": 1,
          "timestamp": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the recording statistics.

  • object (required)

    object

    • rc_stats (required)

      array

      Items:

      • rc_service_id (required)

        string — The RC's Zoom Node service ID.

      • rc_service_name (required)

        string — The RC's Zoom Node service name.

      • recording_zone (required)

        string — The RC's recording zone.

      • current_recording_count

        number — The number of concurrent recordings on the RC.

      • current_transcoding_count

        number — The number of concurrent transcodings on the RC.

      • timestamp

        string — The timestamp of the data being collected.

      • transcoding_queue_depth

        number — The number of recordings waiting to be transcoded on the RC.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "rc_stats": [
        {
          "rc_service_id": "",
          "rc_service_name": "",
          "recording_zone": "",
          "current_recording_count": 1,
          "current_transcoding_count": 1,
          "transcoding_queue_depth": 1,
          "timestamp": ""
        }
      ]
    }
  }
}

POST node.server_cpu_alert

• Method: POST
• Path: node.server_cpu_alert
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "used_percent" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "node_cpu" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "metric": "node_cpu",
      "field": "used_percent",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "used_percent" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "node_cpu" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "metric": "node_cpu",
      "field": "used_percent",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

POST node.server_registered

• Method: POST
• Path: node.server_registered
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      }
    }
  }
}

POST node.server_update_failed

• Method: POST
• Path: node.server_update_failed
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The group name to which the server belongs.

  • operator

    string — The email of the user who updated the server.

  • operator_id

    string — The user ID of the user who updated the server.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The group name to which the server belongs.

  • operator

    string — The email of the user who updated the server.

  • operator_id

    string — The user ID of the user who updated the server.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      }
    }
  }
}

POST node.zone_added

• Method: POST
• Path: node.zone_added
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user who added the zone.

  • object (required)

    object — Information about the server.

    • module (required)

      string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — Zoom Node business module.

    • type (required)

      string, possible values: "meeting_zone", "recording_zone" — Zone type.

    • zone (required)

      string — Zone name.

  • operator (required)

    string — The email of the user who added the zone.

  • operator_id (required)

    string — The user ID of the user who added the zone.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "zone": "",
      "module": "hybrid",
      "type": "meeting_zone"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user who added the zone.

  • object (required)

    object — Information about the server.

    • module (required)

      string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — Zoom Node business module.

    • type (required)

      string, possible values: "meeting_zone", "recording_zone" — Zone type.

    • zone (required)

      string — Zone name.

  • operator (required)

    string — The email of the user who added the zone.

  • operator_id (required)

    string — The user ID of the user who added the zone.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "zone": "",
      "module": "hybrid",
      "type": "meeting_zone"
    }
  }
}

POST node.service_started

• Method: POST
• Path: node.service_started
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

  • operator

    string — The email of the user who started the service.

  • operator_id

    string — The user ID of the user who started the service.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

  • operator

    string — The email of the user who started the service.

  • operator_id

    string — The user ID of the user who started the service.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      }
    }
  }
}

POST node.zhm_stat

• Method: POST
• Path: node.zhm_stat
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the meeting statistics.

  • object (required)

    object — Information about the meeting statistics.

    • mmr_stats (required)

      array

      Items:

      • meeting_zone (required)

        string — The MMR's meeting zone.

      • mmr_service_id (required)

        string — The MMR's Zoom Node service ID.

      • mmr_service_name (required)

        string — The MMR's Zoom Node service name.

      • private_mode_meeting_count

        integer — The number of onging private meetings on the MMR.

      • private_mode_participant_count

        integer — The number of participants in private meetings on the MMR.

      • sfu_mode_meeting_count

        integer — The number of onging SFU meetings on the MMR.

      • sfu_mode_participant_count

        integer — The number of participants in SFU meetings on the MMR.

      • timestamp

        string — The timestamp of the data being collected.

      • total_meeting_count

        integer — The total number of onging meetings on the MMR.

      • total_participant_count

        integer — The total number of participants in all types of meetings on the MMR.

    • zc_stats (required)

      array

      Items:

      • meeting_zone (required)

        string — The meeting zone's name.

      • zc_service_id (required)

        string — The zone controller's Zoom Node service ID.

      • zc_service_name (required)

        string — The zone controller's Zoom Node service name.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "mmr_stats": [
        {
          "mmr_service_id": "",
          "mmr_service_name": "",
          "meeting_zone": "",
          "sfu_mode_participant_count": 1,
          "private_mode_participant_count": 1,
          "total_participant_count": 1,
          "sfu_mode_meeting_count": 1,
          "private_mode_meeting_count": 1,
          "total_meeting_count": 1,
          "timestamp": ""
        }
      ],
      "zc_stats": [
        {
          "zc_service_id": "",
          "zc_service_name": "",
          "meeting_zone": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the meeting statistics.

  • object (required)

    object — Information about the meeting statistics.

    • mmr_stats (required)

      array

      Items:

      • meeting_zone (required)

        string — The MMR's meeting zone.

      • mmr_service_id (required)

        string — The MMR's Zoom Node service ID.

      • mmr_service_name (required)

        string — The MMR's Zoom Node service name.

      • private_mode_meeting_count

        integer — The number of onging private meetings on the MMR.

      • private_mode_participant_count

        integer — The number of participants in private meetings on the MMR.

      • sfu_mode_meeting_count

        integer — The number of onging SFU meetings on the MMR.

      • sfu_mode_participant_count

        integer — The number of participants in SFU meetings on the MMR.

      • timestamp

        string — The timestamp of the data being collected.

      • total_meeting_count

        integer — The total number of onging meetings on the MMR.

      • total_participant_count

        integer — The total number of participants in all types of meetings on the MMR.

    • zc_stats (required)

      array

      Items:

      • meeting_zone (required)

        string — The meeting zone's name.

      • zc_service_id (required)

        string — The zone controller's Zoom Node service ID.

      • zc_service_name (required)

        string — The zone controller's Zoom Node service name.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "mmr_stats": [
        {
          "mmr_service_id": "",
          "mmr_service_name": "",
          "meeting_zone": "",
          "sfu_mode_participant_count": 1,
          "private_mode_participant_count": 1,
          "total_participant_count": 1,
          "sfu_mode_meeting_count": 1,
          "private_mode_meeting_count": 1,
          "total_meeting_count": 1,
          "timestamp": ""
        }
      ],
      "zc_stats": [
        {
          "zc_service_id": "",
          "zc_service_name": "",
          "meeting_zone": ""
        }
      ]
    }
  }
}

POST node.server_confirmed

• Method: POST
• Path: node.server_confirmed
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user who confirmed the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "offline" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

  • operator (required)

    string — The email of the user who confirmed the server.

  • operator_id (required)

    string — The user ID of the user who confirmed the server.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "os_image": "Ubuntu22-2024042323",
        "status": "offline",
        "module": "hybrid"
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user who confirmed the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "offline" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

  • operator (required)

    string — The email of the user who confirmed the server.

  • operator_id (required)

    string — The user ID of the user who confirmed the server.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "os_image": "Ubuntu22-2024042323",
        "status": "offline",
        "module": "hybrid"
      }
    }
  }
}

POST node.service_memory_alert

• Method: POST
• Path: node.service_memory_alert
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "used" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "process", "docker_memory", "podman" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

    • container

      string — The container that triggered the alert.

    • service

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "metric": "process",
      "field": "used",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn",
      "container": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "used" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "process", "docker_memory", "podman" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

    • container

      string — The container that triggered the alert.

    • service

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "metric": "process",
      "field": "used",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn",
      "container": ""
    }
  }
}

POST node.service_update_success

• Method: POST
• Path: node.service_update_success
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • target_version (required)

      string — Target update version

  • operator

    string — The email of the user who updated the service.

  • operator_id

    string — The user ID of the user who updated the service.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "target_version": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • target_version (required)

      string — Target update version

  • operator

    string — The email of the user who updated the service.

  • operator_id

    string — The user ID of the user who updated the service.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "target_version": ""
    }
  }
}

POST node.service_cpu_alert

• Method: POST
• Path: node.service_cpu_alert
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "used_percent" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "process", "docker_cpu", "podman" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

    • service

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "metric": "process",
      "field": "used_percent",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "used_percent" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "process", "docker_cpu", "podman" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

    • service

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "metric": "process",
      "field": "used_percent",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

POST node.server_stat

• Method: POST
• Path: node.server_stat
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event's name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the recording statistics.

  • object (required)

    object — Information about the recording statistics.

    • stats (required)

      array

      Items:

      • server (required)

        object — Information about the server.

        • id (required)

          string — The server ID.

        • location (required)

          string — The server's geo-location.

        • module (required)

          string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

        • name (required)

          string — The server name.

        • status (required)

          string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

        • udid (required)

          string — The server's universally unique identifier (UUID). Each server generates a UUID.

        • group

          string — The server's group.

        • os_image

          string — The server's OS image version.

      • cpu_used_percent

        number — The server's CPU usage in percent. The figure is accurate to two decimal places.

      • cpu_used_percent_ts

        string — The timestamp when the metric was collected.

      • disk_total

        number — The server's total disk size in KB. The figure is accurate to two decimal places.

      • disk_total_ts

        string — The timestamp when the metric was collected.

      • disk_used

        number — The server's disk usage in KB. The figure is accurate to two decimal places.

      • disk_used_ts

        string — The timestamp when the metric was collected.

      • memory_used

        number — The server's memory usage in KB.

      • memory_used_ts

        string — The timestamp when the metric was collected.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "stats": [
        {
          "server": {
            "id": "444AAAiAAAAAiAiAiiAii==",
            "udid": "AAAiAiAixdflsdfdfhk",
            "name": "hybrid-meeting-server1",
            "location": "san jose",
            "group": "test-group1",
            "os_image": "Ubuntu22-2024042323",
            "status": "unconfirmed",
            "module": "hybrid"
          },
          "cpu_used_percent": 1,
          "memory_used": 1,
          "disk_used": 1,
          "disk_total": 1,
          "cpu_used_percent_ts": "",
          "memory_used_ts": "",
          "disk_used_ts": "",
          "disk_total_ts": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event's name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the recording statistics.

  • object (required)

    object — Information about the recording statistics.

    • stats (required)

      array

      Items:

      • server (required)

        object — Information about the server.

        • id (required)

          string — The server ID.

        • location (required)

          string — The server's geo-location.

        • module (required)

          string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

        • name (required)

          string — The server name.

        • status (required)

          string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

        • udid (required)

          string — The server's universally unique identifier (UUID). Each server generates a UUID.

        • group

          string — The server's group.

        • os_image

          string — The server's OS image version.

      • cpu_used_percent

        number — The server's CPU usage in percent. The figure is accurate to two decimal places.

      • cpu_used_percent_ts

        string — The timestamp when the metric was collected.

      • disk_total

        number — The server's total disk size in KB. The figure is accurate to two decimal places.

      • disk_total_ts

        string — The timestamp when the metric was collected.

      • disk_used

        number — The server's disk usage in KB. The figure is accurate to two decimal places.

      • disk_used_ts

        string — The timestamp when the metric was collected.

      • memory_used

        number — The server's memory usage in KB.

      • memory_used_ts

        string — The timestamp when the metric was collected.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "stats": [
        {
          "server": {
            "id": "444AAAiAAAAAiAiAiiAii==",
            "udid": "AAAiAiAixdflsdfdfhk",
            "name": "hybrid-meeting-server1",
            "location": "san jose",
            "group": "test-group1",
            "os_image": "Ubuntu22-2024042323",
            "status": "unconfirmed",
            "module": "hybrid"
          },
          "cpu_used_percent": 1,
          "memory_used": 1,
          "disk_used": 1,
          "disk_total": 1,
          "cpu_used_percent_ts": "",
          "memory_used_ts": "",
          "disk_used_ts": "",
          "disk_total_ts": ""
        }
      ]
    }
  }
}

POST node.server_deleted

• Method: POST
• Path: node.server_deleted
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user who deleted the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

  • operator (required)

    string — The email of the user who deleted the server.

  • operator_id (required)

    string — The user ID of the user who deleted the server.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user who deleted the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

  • operator (required)

    string — The email of the user who deleted the server.

  • operator_id (required)

    string — The user ID of the user who deleted the server.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      }
    }
  }
}

POST node.service_update_failed

• Method: POST
• Path: node.service_update_failed
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • error (required)

      string — Update error message.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • target_version (required)

      string — Target update version.

  • operator

    string — The email of the user who updated the service.

  • operator_id

    string — The user ID of the user who updated the service.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "target_version": "",
      "error": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • error (required)

      string — Update error message.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • target_version (required)

      string — Target update version.

  • operator

    string — The email of the user who updated the service.

  • operator_id

    string — The user ID of the user who updated the service.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "target_version": "",
      "error": ""
    }
  }
}

POST node.server_update_success

• Method: POST
• Path: node.server_update_success
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The server's account.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

  • operator

    string — The email of the user who updated the server.

  • operator_id

    string — The user ID of the user who updated the server.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The server's account.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

  • operator

    string — The email of the user who updated the server.

  • operator_id

    string — The user ID of the user who updated the server.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      }
    }
  }
}

POST node.server_update_available

• Method: POST
• Path: node.server_update_available
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • severity (required)

      string, possible values: "Low", "Medium", "High", "Mandatory" — Severity of the os update

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "severity": "Low"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • severity (required)

      string, possible values: "Low", "Medium", "High", "Mandatory" — Severity of the os update

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "severity": "Low"
    }
  }
}

POST node.mc_stat

• Method: POST
• Path: node.mc_stat
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID associated to the meeting statistics.

  • object (required)

    object — Information about the meeting statistics.

    • mmr_stats (required)

      array

      Items:

      • meeting_zone (required)

        string — The MMR's meeting zone.

      • mmr_service_id (required)

        string — The MMR's Zoom Node service ID.

      • mmr_service_name (required)

        string — The MMR's Zoom Node service name.

      • timestamp

        string — The timestamp of the data being collected.

      • total_meeting_count

        integer — The total number of onging meetings on the MMR.

      • total_participant_count

        integer — The total number of meeting participants on the MMR.

    • zc_stats (required)

      array

      Items:

      • meeting_zone (required)

        string — The meeting zone's name.

      • zc_service_id (required)

        string — The zone controller's Zoom Node service ID.

      • zc_service_name (required)

        string — The zone controller's Zoom Node service name.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "mmr_stats": [
        {
          "mmr_service_id": "",
          "mmr_service_name": "",
          "meeting_zone": "",
          "total_participant_count": 1,
          "total_meeting_count": 1,
          "timestamp": ""
        }
      ],
      "zc_stats": [
        {
          "zc_service_id": "",
          "zc_service_name": "",
          "meeting_zone": ""
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID associated to the meeting statistics.

  • object (required)

    object — Information about the meeting statistics.

    • mmr_stats (required)

      array

      Items:

      • meeting_zone (required)

        string — The MMR's meeting zone.

      • mmr_service_id (required)

        string — The MMR's Zoom Node service ID.

      • mmr_service_name (required)

        string — The MMR's Zoom Node service name.

      • timestamp

        string — The timestamp of the data being collected.

      • total_meeting_count

        integer — The total number of onging meetings on the MMR.

      • total_participant_count

        integer — The total number of meeting participants on the MMR.

    • zc_stats (required)

      array

      Items:

      • meeting_zone (required)

        string — The meeting zone's name.

      • zc_service_id (required)

        string — The zone controller's Zoom Node service ID.

      • zc_service_name (required)

        string — The zone controller's Zoom Node service name.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "mmr_stats": [
        {
          "mmr_service_id": "",
          "mmr_service_name": "",
          "meeting_zone": "",
          "total_participant_count": 1,
          "total_meeting_count": 1,
          "timestamp": ""
        }
      ],
      "zc_stats": [
        {
          "zc_service_id": "",
          "zc_service_name": "",
          "meeting_zone": ""
        }
      ]
    }
  }
}

POST node.server_online

• Method: POST
• Path: node.server_online
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "online" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "online",
        "module": "hybrid"
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "online" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "online",
        "module": "hybrid"
      }
    }
  }
}

POST node.server_memory_alert

• Method: POST
• Path: node.server_memory_alert
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "used" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "node_memory" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "metric": "node_memory",
      "field": "used",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "used" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "node_memory" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "metric": "node_memory",
      "field": "used",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

POST node.service_stopped

• Method: POST
• Path: node.service_stopped
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

  • operator

    string — The email of the user who stopped the service.

  • operator_id

    string — The user ID of the user who stopped the service.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

  • operator

    string — The email of the user who stopped the service.

  • operator_id

    string — The user ID of the user who stopped the service.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      }
    }
  }
}

POST node.mc_stat_alert

• Method: POST
• Path: node.mc_stat_alert
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "meeting_count", "p2p_meeting_count", "client_count", "p2p_client_count" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "meeting_stat_per_mmr" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "metric": "meeting_stat_per_mmr",
      "field": "meeting_count",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "meeting_count", "p2p_meeting_count", "client_count", "p2p_client_count" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "meeting_stat_per_mmr" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "metric": "meeting_stat_per_mmr",
      "field": "meeting_count",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

POST node.service_update_available

• Method: POST
• Path: node.service_update_available
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • available_version (required)

      string — Available update version

    • deadline (required)

      string — Deadline of the service update. The service will be disabled if it fails to be updated before this time.

    • publish_time (required)

      string — The date and time when the update became available.

    • release_note (required)

      string — Release note of the update.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • severity (required)

      string, possible values: "Low", "Medium", "High", "Mandatory" — Severity of the service update

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "available_version": "",
      "severity": "Low",
      "deadline": "",
      "publish_time": "",
      "release_note": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of server.

  • object (required)

    object — Information about the server.

    • available_version (required)

      string — Available update version

    • deadline (required)

      string — Deadline of the service update. The service will be disabled if it fails to be updated before this time.

    • publish_time (required)

      string — The date and time when the update became available.

    • release_note (required)

      string — Release note of the update.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • severity (required)

      string, possible values: "Low", "Medium", "High", "Mandatory" — Severity of the service update

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "available_version": "",
      "severity": "Low",
      "deadline": "",
      "publish_time": "",
      "release_note": ""
    }
  }
}

POST node.server_rebooted

• Method: POST
• Path: node.server_rebooted
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user who rebooted the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

  • operator (required)

    string — The email of the user who rebooted the server.

  • operator_id (required)

    string — The user ID of the user who rebooted the server.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the user who rebooted the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

  • operator (required)

    string — The email of the user who rebooted the server.

  • operator_id (required)

    string — The user ID of the user who rebooted the server.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "operator": "",
    "operator_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      }
    }
  }
}

POST node.server_offline

• Method: POST
• Path: node.server_offline
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "offline" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "offline",
        "module": "hybrid"
      }
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID of the server.

  • object (required)

    object — Information about the server.

    • server (required)

      object — The server object.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "offline" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "offline",
        "module": "hybrid"
      }
    }
  }
}

POST node.zhm_stat_alert

• Method: POST
• Path: node.zhm_stat_alert
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "meeting_count", "p2p_meeting_count", "client_count", "p2p_client_count", "sfu_meeting_count", "private_meeting_count", "sfu_client_count", "private_client_count", "meeting_utilization" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "meeting_stat_per_mmr" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "metric": "meeting_stat_per_mmr",
      "field": "meeting_count",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "meeting_count", "p2p_meeting_count", "client_count", "p2p_client_count", "sfu_meeting_count", "private_meeting_count", "sfu_client_count", "private_client_count", "meeting_utilization" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "meeting_stat_per_mmr" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "service": {
        "id": "",
        "name": "",
        "version": "",
        "type": "NODE_AGENT",
        "zone": "",
        "status": "downloading"
      },
      "metric": "meeting_stat_per_mmr",
      "field": "meeting_count",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

POST node.nfs_alert

• Method: POST
• Path: node.nfs_alert
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "used_percent", "status" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "nfs" — The alert metric name.

    • nfs (required)

      object — Information about the NFS.

      • host (required)

        string — The NFS host address.

      • path (required)

        string — The NFS path.

      • status (required)

        string, possible values: "online", "unknown" — The NFS status.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=", "!=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "nfs": {
        "host": "",
        "path": "",
        "status": "online"
      },
      "metric": "nfs",
      "field": "used_percent",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "used_percent", "status" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "nfs" — The alert metric name.

    • nfs (required)

      object — Information about the NFS.

      • host (required)

        string — The NFS host address.

      • path (required)

        string — The NFS path.

      • status (required)

        string, possible values: "online", "unknown" — The NFS status.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=", "!=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "server": {
        "id": "444AAAiAAAAAiAiAiiAii==",
        "udid": "AAAiAiAixdflsdfdfhk",
        "name": "hybrid-meeting-server1",
        "location": "san jose",
        "group": "test-group1",
        "os_image": "Ubuntu22-2024042323",
        "status": "unconfirmed",
        "module": "hybrid"
      },
      "nfs": {
        "host": "",
        "path": "",
        "status": "online"
      },
      "metric": "nfs",
      "field": "used_percent",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn"
    }
  }
}

POST node.zhm_zone_stat_alert

• Method: POST
• Path: node.zhm_zone_stat_alert
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "meeting_count", "p2p_meeting_count", "client_count", "p2p_client_count", "sfu_meeting_count", "private_meeting_count", "sfu_client_count", "private_client_count", "meeting_utilization" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "meeting_stat_per_zone" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

    • zone (required)

      string — Meeting zone name.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "metric": "meeting_stat_per_zone",
      "field": "meeting_count",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn",
      "zone": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "meeting_count", "p2p_meeting_count", "client_count", "p2p_client_count", "sfu_meeting_count", "private_meeting_count", "sfu_client_count", "private_client_count", "meeting_utilization" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "meeting_stat_per_zone" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

    • zone (required)

      string — Meeting zone name.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "metric": "meeting_stat_per_zone",
      "field": "meeting_count",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn",
      "zone": ""
    }
  }
}

POST node.mc_zone_stat_alert

• Method: POST
• Path: node.mc_zone_stat_alert
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "meeting_count", "attendees_count", "mmr_count" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "meeting_stat_per_zone" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

    • zone (required)

      string — Meeting zone name.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "metric": "meeting_stat_per_zone",
      "field": "meeting_count",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn",
      "zone": ""
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "meeting_count", "attendees_count", "mmr_count" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "meeting_stat_per_zone" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.

    • zone (required)

      string — Meeting zone name.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "metric": "meeting_stat_per_zone",
      "field": "meeting_count",
      "value": 1,
      "threshold": 1,
      "operator": "<",
      "level": "warn",
      "zone": ""
    }
  }
}

POST node.service_stat

• Method: POST
• Path: node.service_stat
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The event's name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the Zoom Node service statistics.

  • object (required)

    object — Information about the Zoom Node service statistics.

    • stats (required)

      array

      Items:

      • server (required)

        object

        • id (required)

          string — The server ID.

        • location (required)

          string — The server's geo location.

        • module (required)

          string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

        • name (required)

          string — The server name.

        • os_image (required)

          string — The server's VM image version.

        • status (required)

          string, possible values: "online", "offline", "unconfirmed", "disabled" — The server's status.

        • udid (required)

          string — The server's universally unique identifier (UUID). Each server generates a UUID.

        • group

          string — The server's group.

      • service (required)

        object — Information about the service.

        • id (required)

          string — The service's ID.

        • name (required)

          string — The service name.

        • status (required)

          string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

        • type (required)

          string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

        • version (required)

          string — The service's version.

        • zone

          string — The service's meeting zone or recording zone.

      • cpu_used_percent

        number — The service's CPU usage in percent. The figure is accurate to two decimal places. This field is valid if and only if the service doesn't run on top of Docker.

      • memory_used

        number — The service's memory usage in percent. The figure is accurate to two decimal places. This field is valid if and only if the service doesn't run on top of Docker.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "stats": [
        {
          "server": {
            "id": "",
            "udid": "",
            "name": "",
            "location": "",
            "os_image": "",
            "module": "hybrid",
            "status": "online",
            "group": "test-group1"
          },
          "service": {
            "id": "",
            "name": "",
            "version": "",
            "type": "NODE_AGENT",
            "zone": "",
            "status": "downloading"
          },
          "cpu_used_percent": 1,
          "memory_used": 1
        }
      ]
    }
  }
}

Responses

Status: 200

Content-Type: application/json

• event (required)

  string — The event's name.

• event_ts (required)

  integer — A timestamp for when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the Zoom Node service statistics.

  • object (required)

    object — Information about the Zoom Node service statistics.

    • stats (required)

      array

      Items:

      • server (required)

        object

        • id (required)

          string — The server ID.

        • location (required)

          string — The server's geo location.

        • module (required)

          string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

        • name (required)

          string — The server name.

        • os_image (required)

          string — The server's VM image version.

        • status (required)

          string, possible values: "online", "offline", "unconfirmed", "disabled" — The server's status.

        • udid (required)

          string — The server's universally unique identifier (UUID). Each server generates a UUID.

        • group

          string — The server's group.

      • service (required)

        object — Information about the service.

        • id (required)

          string — The service's ID.

        • name (required)

          string — The service name.

        • status (required)

          string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

        • type (required)

          string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

        • version (required)

          string — The service's version.

        • zone

          string — The service's meeting zone or recording zone.

      • cpu_used_percent

        number — The service's CPU usage in percent. The figure is accurate to two decimal places. This field is valid if and only if the service doesn't run on top of Docker.

      • memory_used

        number — The service's memory usage in percent. The figure is accurate to two decimal places. This field is valid if and only if the service doesn't run on top of Docker.

Example:

{
  "event": "",
  "event_ts": 1,
  "payload": {
    "account_id": "",
    "object": {
      "stats": [
        {
          "server": {
            "id": "",
            "udid": "",
            "name": "",
            "location": "",
            "os_image": "",
            "module": "hybrid",
            "status": "online",
            "group": "test-group1"
          },
          "service": {
            "id": "",
            "name": "",
            "version": "",
            "type": "NODE_AGENT",
            "zone": "",
            "status": "downloading"
          },
          "cpu_used_percent": 1,
          "memory_used": 1
        }
      ]
    }
  }
}

POST node.rc_stat_alert

• Method: POST
• Path: node.rc_stat_alert
• Tags: node

Request Body

Content-Type: application/json

• event (required)

  string — The name of the event.

• event_ts (required)

  integer — A timestamp when the event occurred.

• payload (required)

  object

  • account_id (required)

    string — The account ID for the alert.

  • object (required)

    object — Information about the alert.

    • field (required)

      string, possible values: "current_recording_count", "current_transcoding_count", "transcoding_queue_depth" — The alert field name.

    • level (required)

      string, possible values: "warn", "error", "fatal" — The alert level.

    • metric (required)

      string, possible values: "rc_recording_stat", "rc_transcoding_stat" — The alert metric name.

    • operator (required)

      string, possible values: "<", ">", "<=", ">=" — The operator between the alert field's value and its threshold.

    • server (required)

      object — Information about the server.

      • id (required)

        string — The server ID.

      • location (required)

        string — The server's geo-location.

      • module (required)

        string, possible values: "hybrid", "phone", "chat", "mc", "zurm", "lss" — The server's module.

      • name (required)

        string — The server name.

      • os_image (required)

        string — The server's OS image version.

      • status (required)

        string, possible values: "unconfirmed", "online", "offline", "disabled" — The server's status message.

      • udid (required)

        string — The server's universally unique identifier (UUID). Each server generates a UUID.

      • group

        string — The server's group.

    • service (required)

      object — Information about the service.

      • id (required)

        string — The service's ID.

      • name (required)

        string — The service name.

      • status (required)

        string, possible values: "downloading", "installed", "install_failed", "pending", "stopped", "running", "suspend" — The service status.

      • type (required)

        string, possible values: "NODE_AGENT", "HYBRID_MMR", "ZPROXY", "HYBRID_FS", "MONGO_PROXY", "ES_PROXY", "LOAD_BALANCER", "ZONE_CONTROLLER", "MC_MMR", "RCONNECTOR", "MONITOR_AGENT", "SNMP_AGENT", "API_CONNECTOR", "HYBRID_LSS", "BDM", "HYBRID_RECORDING", "VRC_LB", "VRC", "HYBRID_TRANSFER" — The service type.

      • version (required)

        string — The service's version.

      • zone

        string — The service's meeting zone or recording zone.

    • threshold (required)

      number — The alert field's threshold.

    • value (required)

      number — The alert field's value.