Get Hybrid Connector Details

Shows details for a hybrid connector, by ID.

Only an admin auth token with the spark-admin:hybrid_connectors_read scope can see connector details.

GET/v1/hybrid/connectors/{connectorId}
URI Parameters
connectorId
stringrequired

The ID of the connector.

Response Properties
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
Connector Status

The status of the connector.

created
string

The date and time the connector was created.

type
Connector Type

The type of connector.

version
string

The version of the software installed.

alarms
array

A list of alarms raised on the connector.

id
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.

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.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
  1. | 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/
Log in to try the API.
Header
https://webexapis.com/v1/hybrid/connectors/Y2lZY76123
200 / OK
{
  "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"
    }
  ]
}