Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex HDS API

The HDS API from Webex — 7 operation(s) for hds.

Webex HDS API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include HDS. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 25 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

7 operations 7 paths 25 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex HDS API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

HDS 7
GET
/hds/organizations/{organizationId}
Get organization details
getHDSOrganizationDetails 1 param → 200400401403404405409410
GET
/hds/clusters/{clusterId}
Get cluster details
getHDSClusterDetails 1 param → 200400401403404405409410
GET
/hds/nodes/{nodeId}
Get node details
getHDSNodeDetails 1 param → 200400401403404405409410
GET
/hds/organizations/{organizationId}/database
Get database details for the HDS organization
getHDSOrganizationDatabaseDetails 1 param → 200400401403404405409410
GET
/hds/organizations/{organizationId}/tenants
Get Multi-Tenant HDS organization details
getHDSMultiTenantOrganizationDetails 1 param → 200400401403404405409410
GET
/hds/testResults/nodes/{nodeId}/networkTest
Get test results for HDS node
getNetworkTestResultsForHDSNode 2 params → 200400401403404405409410
GET
/hds/clusters/{clusterId}/availability
Get availability details for HDS cluster
getHDSClusterAvailabilityDetails 3 params → 200400401403404405409410

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are nodeDetails (10 properties), clusterDetails (6 properties), orgDetailsItems (5 properties), availabilitySegment (5 properties). Each schema is shown below with its type and property counts.

nodeDetailsCluster
object
3 properties
orgDetailsResponse
object
1 property
multiTenantHDSOrgDetailsResponse
object
2 properties
networkTestResultsForNode
object
4 properties
networkTestsResultsResponse
object
2 properties
clustersAvailabilityDetailsItems
object
2 properties
clustersAvailabilityDetailsResponse
object
1 property
singleServiceTestResult
object
2 properties
orgDetailsItems
object
5 properties
tenantDetails
object
4 properties
clusterDetails
object
6 properties
nodeDetails
object
10 properties
nodeDetailsItems
object
2 properties
networkTestResults
object
2 properties
clusterDetailsResponseOrgLevel
object
2 properties
availabilitySegment
object
5 properties
clusterSummary
object
2 properties
clusterNodeDetails
object
2 properties
singleNetworkTestResult
object
3 properties
clusterDetailsWithAvailabilitySegments
object
3 properties
networkTestResultsForCluster
object
1 property
databaseDetailsResponse
object
3 properties
nodeDetailsResponse
object
1 property
clusterDetailsResponse
object
1 property
serviceTestResults
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-hds-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API