openapi: 3.0.0
info:
title: Webex Admin Address Book HDS API
version: 1.0.0
description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: HDS
paths:
/hds/organizations/{organizationId}:
get:
responses:
'200':
description: Ok
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/orgDetailsResponse'
example:
items:
- orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ
orgName: HDS_Demo
orgType: Single Tenant
orgMode: Production
clusters:
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI
clusterName: cluster-1
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NJJ
clusterName: cluster-2
'400':
description: 'Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request was understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type, or with a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.'
'428':
description: 'Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given period 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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.'
summary: Get organization details
operationId: getHDSOrganizationDetails
description: 'Retrieve details for an HDS organization, such as the organization name, type of organization, and clusters in the organization.
To obtain the Organization ID needed for this API, use the [Organizations API](</docs/api/v1/organizations/list-organizations>)'
tags:
- HDS
parameters:
- name: organizationId
in: path
description: Unique ID of the HDS organization.
required: true
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ
schema:
type: string
/hds/clusters/{clusterId}:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/clusterDetailsResponse'
example:
items:
- orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ
clusters:
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI
clusterName: E2E Framework Integration Test
nodes:
- nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk
host: hds-node-1.example.com
- nodeId: Y2lzY43pmHYyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJ3
host: hds-node-2.example.com
releaseChannel: latest
upgradeSchedule:
scheduleDays:
- monday
scheduleTime: '11:00'
scheduleTimeZone: Asia/Kolkata
nextUpgradeTime: '2024-04-01 05:30:00.000'
clusterStatus: ''
'400':
description: 'Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request was understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type, or with a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.'
'428':
description: 'Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given period 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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.'
summary: Get cluster details
operationId: getHDSClusterDetails
description: 'Retrieve details for a specific HDS cluster, such as the cluster name, cluster status, upgrade schedule, and HDS nodes in the cluster.
To obtain the Cluster ID needed for this API, use the [Get organization details API](</docs/api/v1/hds/get-organization-details>)'
tags:
- HDS
parameters:
- name: clusterId
in: path
description: Unique ID of the HDS cluster.
required: true
example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI
schema:
type: string
/hds/nodes/{nodeId}:
get:
responses:
'200':
description: Ok
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/nodeDetailsResponse'
example:
items:
- orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG
clusters:
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI
clusterName: Cluster Name ABC
nodes:
- nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjNzI
host: xyz.abc.com
availabilityDetails:
nodeAvailability: Online
hdsHealthStatus: Healthy / Unhealthy
hdsUnhealthyReasons:
- KMS unhealthy
- Avalon unhealthy
releaseVersion: 2025.07.16.7042
proxyType: Explicit
proxyStatus: Enabled
maintenanceMode: 'On'
ntpSync: Active
ovaDeploymentType: Large
ovaBuildType: Dev
'400':
description: 'Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request was understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type, or with a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.'
'428':
description: 'Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given period 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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.'
summary: Get node details
operationId: getHDSNodeDetails
description: 'Retrieve details for a specific HDS node, such as host name, release version, proxy details, deployment and build type, availability details, etc.
To obtain the Node ID needed for this API, use the [Get cluster details API](</docs/api/v1/hds/get-cluster-details>)'
tags:
- HDS
parameters:
- name: nodeId
in: path
description: Unique ID of the HDS node
required: true
example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk
schema:
type: string
/hds/organizations/{organizationId}/database:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/databaseDetailsResponse'
example:
context:
orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG
databaseType: PostgreSQL
databaseVersion: PostgreSQL 16.9 (Ubuntu 16.9-1.pgdg24.04+1) on x86_64-pc-linux-gnu, compiled by gcc (Ubuntu 13.3.0-6ubuntu2~24.04) 13.3.0, 64-bit
'400':
description: 'Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request was understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type, or with a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.'
'428':
description: 'Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given period 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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.'
summary: Get database details for the HDS organization
operationId: getHDSOrganizationDatabaseDetails
description: 'Retrieve details of database information for an HDS organization, such as database type and version used.
To obtain the Organization ID needed for this API, use the [Organizations API](</docs/api/v1/organizations/list-organizations>)'
tags:
- HDS
parameters:
- name: organizationId
in: path
description: Unique ID of the HDS organization
required: true
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ
schema:
type: string
/hds/organizations/{organizationId}/tenants:
get:
responses:
'200':
description: Ok
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/multiTenantHDSOrgDetailsResponse'
example:
context:
partnerOrgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG
tenants:
- tenantOrgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFCGCGCGH
tenantOrgName: Tenant Org A
cmkState: CMK Managed
tenantOrgState: Setup complete
- tenantOrgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTVHHHFJYJYJKT
tenantOrgName: Tenant Org B
cmkState: CMK Management pending
tenantOrgState: Setup incomplete
'400':
description: 'Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request was understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type, or with a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.'
'428':
description: 'Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given period 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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.'
summary: Get Multi-Tenant HDS organization details
operationId: getHDSMultiTenantOrganizationDetails
description: 'Retrieve details of Multi-Tenant HDS organization such as Organization Name and ID, CMK state and state of Tenants Organizations.
To obtain the Organization ID needed for this API, use the [Organizations API](</docs/api/v1/organizations/list-organizations>)'
tags:
- HDS
parameters:
- name: organizationId
in: path
description: Unique ID of the HDS organization.
required: true
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ
schema:
type: string
/hds/testResults/nodes/{nodeId}/networkTest:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/networkTestsResultsResponse'
example:
orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ
items:
- clusters:
clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI
clusterName: HDS Cluster 1
nodes:
- nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk
hostname: hds-node-1.example.com
hostIp: 165.49.25.1
testResults:
- triggerType: Periodic
results:
- timestamp: '2024-01-15T10:15:30Z'
type: HTTPConnectivityTest
results:
- serviceType: WebexCloud
services:
- serviceName: hercules
testResult: Success
- serviceName: identity
testResult: Success
- serviceName: idBroker
testResult: Success
- serviceType: ThirdPartyCloud
services:
- serviceName: ecr
testResult: Success
- timestamp: '2024-01-15T10:15:30Z'
type: BandwidthTest
results:
- serviceType: ThirdPartyCloud
services:
- serviceName: ecr
testResult: Success
- timestamp: '2024-01-15T10:15:30Z'
type: DNSResolutionTest
results:
- serviceType: WebexCloud
services:
- serviceName: identity
testResult: Success
- serviceName: hercules
testResult: Success
- serviceName: idBroker
testResult: Success
- serviceType: ThirdPartyCloud
services:
- serviceName: ecr
testResult: Success
'400':
description: 'Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request was understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type, or with a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.'
'428':
description: 'Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given period 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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond in time. If your query uses the max parameter, please try reducing its value.'
summary: Get test results for HDS node
operationId: getNetworkTestResultsForHDSNode
description: "Get the latest results of the network tests triggered for a single HDS node. The test results are generated as part of the Network Test execution on the node. The network tests include the Bandwidth Test, DNS Resolution Test, and HTTPS Connectivity Test.\n The results from the latest test run are provided, covering up to the past 90 days if available.\nTo obtain the Node ID needed for this API, use the [Get cluster details API](</docs/api/v1/hds/get-cluster-details>)"
tags:
- HDS
parameters:
- name: nodeId
in: path
description: Unique ID of the HDS node.
required: true
example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk
schema:
type: string
- name: triggerType
in: query
description: Trigger type.
required: false
example: All
schema:
type: string
enum:
- OnDemand
- Periodic
- All
/hds/clusters/{clusterId}/availability:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/clustersAvailabilityDetailsResponse'
example:
items:
- orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ
clusters:
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI
clusterName: HDS Cluster 1
availabilitySegments:
- segmentStartTime: '2025-06-15T15:53:00Z'
segmentEndTime: '2025-06-16T16:53:00Z'
onlineNodeCount: 1
offlineNodeCount: 1
totalNodeCount: 2
- segmentStartTime: '2025-06-16T16:53:00Z'
segmentEndTime: '2025-06-17T17:53:00Z'
onlineNodeCount: 2
offlineNodeCount: 0
totalNodeCount: 2
from: '2026-01-01T00:00:00Z'
to: '2026-01-02T00:00:00Z'
'400':
description: 'Bad Request: The request was invalid or could not be otherwise processed. An accompanying error message will provide more details.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request was understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The requested URI is invalid, or the resource requested (such as a user) does not exist. This response is also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP method that is not supported.'
'409':
description: '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':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type, or with a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present to indicate how many seconds you should wait before attempting the request again.'
'428':
description: 'Precondition Required: The file(s) cannot be scanned for malware and must be force-downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given period 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':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, please contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-hds-api-openapi.yml