Hybrid Connectors - List Hybrid Connectors

List Hybrid Connectors

List hybrid connectors for an organization. If no orgId is specified, the default is the organization of the authenticated user.

Only an admin auth token with the spark-admin:hybrid_connectors_read scope can list connectors.

GET/v1/hybrid/connectors

Query Parameters

orgId

string

List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.

Response Properties

items

array[Connector]

An array of hybrid connector objects.

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

Connector Status

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.
outage indicates that the connector is completely non-functional.
maintenanceMode reports the current maintenance mode state of the connector.

operational

string

impaired

string

outage

string

maintenanceMode

string

created

string

The date and time the connector was created.

type

Connector Type

The type of connector.

expresswayManagement

string

calendar

string

call

string

message

string

expresswayServiceability

string

ecpServiceability

string

videoMesh

string

dataSecurity

string

care

string

careManagement

string

version

string

The version of the software installed.

alarms

array[Alarm]

A list of alarms raised on the connector.

string

A unique identifier for the alarm.

created

string

The date and time the alarm was raised.

severity

Alarm Severity

The severity level of the alarm:

critical
error
warning
alert

critical

string

warning

string

alert

string

error

string

title

string

The title of the alarm.

description

string

A description of the alarm.

hybridConnectorId

string

The ID of the connector the alarm is raised on.

Response Codes

The list below describes the common success and error responses you should expect from the API:

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

GET

/v1/hybrid/connectors{?orgId}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
List hybrid connectors in this organization. If an organization is not specified, the organization of the caller will be used.

https://webexapis.com/v1/hybrid/connectors?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
  "items": [
    {
      "id": "Y2lZY76123",
      "orgId": "Y2lzY29zcGFyazovL3",
      "hybridClusterId": "Y2lZY76123abbb",
      "hostname": "foo.example.org",
      "status": "operational",
      "created": "2017-09-15T15:53:00Z",
      "type": "calendar",
      "version": "1.9_foo_zz",
      "alarms": [
        {
          "id": "Y2lZY76123af234bbYY",
          "created": "2017-09-15T15:53:00Z",
          "severity": "warning",
          "title": "Something is wrong",
          "description": "More detail about something being wrong",
          "hybridConnectorId": "Y2lZY76123af234bb"
        }
      ]
    }
  ]
}