Webex · Schema

nodeDetails

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
nodeId string Unique ID of the connector/node.
host string Host Name or Host IP of the HDS node
availabilityDetails object
releaseVersion string The release version of the HDS node
proxyType string Proxy type used by the HDS node
proxyStatus string Current proxy status of the HDS node
maintenanceMode string On indicates that the node is in maintenance mode, and Off indicates that the node is not in maintenance mode
ntpSync string NTP sync status of the HDS node
ovaDeploymentType string Deployment type of the HDS node
ovaBuildType string Build type of the HDS node
View JSON Schema on GitHub

JSON Schema

webex-nodedetails-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/nodeDetails",
  "title": "nodeDetails",
  "type": "object",
  "properties": {
    "nodeId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk",
      "description": "Unique ID of the connector/node."
    },
    "host": {
      "type": "string",
      "example": "hds-node-1.example.com",
      "description": "Host Name or Host IP of the HDS node"
    },
    "availabilityDetails": {
      "type": "object",
      "properties": {
        "nodeAvailability": {
          "type": "string",
          "example": "Online",
          "description": "Current availability of the HDS node"
        },
        "hdsHealthStatus": {
          "type": "string",
          "example": "Healthy / Unhealthy",
          "description": "Health status of the HDS node"
        },
        "hdsUnhealthyReasons": {
          "type": "array",
          "items": {
            "type": "string",
            "example": "[\"KMS unhealthy\", \"Avalon unhealthy\"]"
          },
          "description": "List of reasons for unhealthy status of the HDS node"
        }
      }
    },
    "releaseVersion": {
      "type": "string",
      "example": "2025.07.16.7042",
      "description": "The release version of the HDS node"
    },
    "proxyType": {
      "type": "string",
      "example": "Explicit",
      "description": "Proxy type used by the HDS node"
    },
    "proxyStatus": {
      "type": "string",
      "example": "Enabled",
      "description": "Current proxy status of the HDS node"
    },
    "maintenanceMode": {
      "type": "string",
      "example": "Off",
      "description": "On indicates that the node is in maintenance mode, and Off indicates that the node is not in maintenance mode"
    },
    "ntpSync": {
      "type": "string",
      "example": "Active",
      "description": "NTP sync status of the HDS node"
    },
    "ovaDeploymentType": {
      "type": "string",
      "example": "Large",
      "description": "Deployment type of the HDS node"
    },
    "ovaBuildType": {
      "type": "string",
      "example": "Dev",
      "description": "Build type of the HDS node"
    }
  }
}