Webex · Schema

Connector

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the connector.
orgId string The ID of the organization to which this hybrid connector belongs.
hybridClusterId string The ID of the cluster this connector belongs to.
hostname string The hostname of the system the connector is running on.
status object The status of the connector: - `operational` indicates that the connector is working as it should. - `impaired` indicates that the connector has problems with one or more dependent components. - `outa
created string The date and time the connector was created.
type object The type of connector.
version string The version of the software installed.
alarms array A list of alarms raised on the connector.
View JSON Schema on GitHub

JSON Schema

webex-connector-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Connector",
  "title": "Connector",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lZY76123",
      "description": "A unique identifier for the connector."
    },
    "orgId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3",
      "description": "The ID of the organization to which this hybrid connector belongs."
    },
    "hybridClusterId": {
      "type": "string",
      "example": "Y2lZY76123abbb",
      "description": "The ID of the cluster this connector belongs to."
    },
    "hostname": {
      "type": "string",
      "example": "foo.example.org",
      "description": "The hostname of the system the connector is running on."
    },
    "status": {
      "$ref": "#/components/schemas/ConnectorStatus",
      "description": "The status of the connector:\n\n- `operational` indicates that the connector is working as it should.\n\n- `impaired` indicates that the connector has problems with one or more dependent components.\n\n- `outage` indicates that the connector is completely non-functional.\n\n- `maintenanceMode` reports the current maintenance mode state of the connector."
    },
    "created": {
      "type": "string",
      "example": "2017-09-15T15:53:00Z",
      "description": "The date and time the connector was created."
    },
    "type": {
      "$ref": "#/components/schemas/ConnectorType",
      "description": "The type of connector."
    },
    "version": {
      "type": "string",
      "example": "1.9_foo_zz",
      "description": "The version of the software installed."
    },
    "alarms": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Alarm"
      },
      "description": "A list of alarms raised on the connector."
    }
  }
}