List Hybrid Clusters

List hybrid clusters 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_clusters_read scope can list clusters.

GET/v1/hybrid/clusters
Query Parameters
orgId
string

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

Response Properties
items
array

An array of hybrid cluster objects.

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.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
GET
/v1/hybrid/clusters{?orgId}
Log in to try the API.
Header
Query Parameters
  • List hybrid clusters in this organization. If an organization is not specified, the organization of the caller will be used.
https://api.ciscospark.com/v1/hybrid/clusters?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
  "items": [
    {
      "id": "Y2lZY76123abbb",
      "orgId": "Y2lzY29zcGFyazovL3",
      "name": "EMEA Oslo 1",
      "resourceGroupId": "Y2lzY29zcGFyazovL3"
    }
  ]
}