Get Hybrid Cluster Details

Shows details for a hybrid cluster, by ID.

Only an admin auth token with the spark-admin:hybrid_clusters_read scope can see cluster details.

GET/v1/hybrid/clusters/{hybridClusterId}
URI Parameters
hybridClusterId
stringrequired

The ID of the cluster.

Query Parameters
orgId
string

Find the cluster in this specific organization. If this is not specified, the organization of the caller will be used.

Response Properties
id
string

A unique identifier for the cluster.

orgId
string

The ID of the organization to which this hybrid cluster belongs.

name
string

The name of the cluster.

resourceGroupId
string

The ID of the resource group this cluster belongs to.

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/clusters/{?orgId}
Log in to try the API.
Header
Query Parameters
  • Find the cluster in this specific organization. If this is not specified, the organization of the caller will be used.
https://webexapis.com/v1/hybrid/clusters/Y2lZY76123abbb?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
  "id": "Y2lZY76123abbb",
  "orgId": "Y2lzY29zcGFyazovL3",
  "name": "EMEA Oslo 1",
  "resourceGroupId": "Y2lzY29zcGFyazovL3"
}