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]()' 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]()' 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]()' 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]()' 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]()' 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]()" 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 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 availability details for HDS cluster operationId: getHDSClusterAvailabilityDetails description: 'Get the availability details for an HDS cluster, where each segment specifies the start and end times, as well as the number of online, offline, and total nodes within that segment. To obtain the Cluster ID needed for this API, use the [Get organization details API]()' tags: - HDS parameters: - name: clusterId in: path description: Unique ID of the HDS cluster. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI schema: type: string - name: from in: query description: The start date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. The 'from' value cannot be later than the 'to' value, and it cannot be more than 1 day older than the current date and time. required: true example: '2021-09-15T15:53:00Z' schema: type: string - name: to in: query description: The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. required: true example: '2021-09-15T17:53:00Z' schema: type: string components: schemas: nodeDetailsCluster: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI description: Unique ID of the cluster. clusterName: type: string example: Cluster Name ABC description: Name of the cluster. nodes: type: array items: $ref: '#/components/schemas/nodeDetails' description: List of nodes in the cluster. orgDetailsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/orgDetailsItems' description: Response for organization details API multiTenantHDSOrgDetailsResponse: type: object properties: context: type: object properties: partnerOrgId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI description: Unique ID of the partner organization. description: Metadata information about the response payload. tenants: type: array items: $ref: '#/components/schemas/tenantDetails' description: List of tenant organizations under the partner organization. networkTestResultsForNode: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the connector/node. hostname: type: string example: hds-node-1.example.com description: Hostname of the node. hostIp: type: string example: 165.49.25.1 description: IP address of the node. testResults: type: array items: $ref: '#/components/schemas/networkTestResults' description: List of network test results. networkTestsResultsResponse: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. items: type: array items: $ref: '#/components/schemas/networkTestResultsForCluster' description: List of network test results for clusters. clustersAvailabilityDetailsItems: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. clusters: type: array items: $ref: '#/components/schemas/clusterDetailsWithAvailabilitySegments' description: List of clusters with their availability details. clustersAvailabilityDetailsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/clustersAvailabilityDetailsItems' description: Response for clusters availability details API singleServiceTestResult: type: object properties: serviceName: type: string example: hercules description: Name of the service. testResult: type: string example: Success description: Result of the test for the service. orgDetailsItems: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. orgName: type: string example: HDS_Demo description: Name of the organization. orgType: type: string example: Single Tenant description: Type of the organization. orgMode: type: string example: Production description: Mode of the organization. clusters: type: array items: $ref: '#/components/schemas/clusterSummary' description: List of clusters in the organization. tenantDetails: type: object properties: tenantOrgId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFCGCGCGH description: Unique ID of the tenant organization. tenantName: type: string example: abcd description: Name of the tenant organization. cmkState: type: string example: CMK Managed description: Customer Managed Key (CMK) state of the tenant organization. tenantOrgState: type: string example: Setup complete description: Current state of the tenant organization. clusterDetails: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI description: Unique ID of the cluster. clusterName: type: string example: E2E Framework Integration Test description: Name of the cluster. nodes: type: array items: $ref: '#/components/schemas/clusterNodeDetails' description: List of nodes in the cluster. releaseChannel: type: string example: latest description: Release channel of the cluster. upgradeSchedule: type: object properties: scheduleDays: type: array items: type: string example: monday description: Days of the week when upgrades are scheduled. scheduleTime: type: string example: '11:00' description: Time of the day when upgrades are scheduled. scheduleTimeZone: type: string example: Asia/Kolkata description: Time zone for the scheduled upgrade time. nextUpgradeTime: type: string example: '2024-04-01 05:30:00.000' description: Next scheduled upgrade time. description: Upgrade schedule details of the cluster. clusterStatus: type: string example: Healthy description: Current status of the cluster. nodeDetails: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the connector/node. host: type: string example: hds-node-1.example.com description: Host Name or Host IP of the HDS node availabilityDetails: type: object properties: nodeAvailability: type: string example: Online description: Current availability of the HDS node hdsHealthStatus: type: string example: Healthy / Unhealthy description: Health status of the HDS node hdsUnhealthyReasons: type: array items: type: string example: '["KMS unhealthy", "Avalon unhealthy"]' description: List of reasons for unhealthy status of the HDS node releaseVersion: type: string example: 2025.07.16.7042 description: The release version of the HDS node proxyType: type: string example: Explicit description: Proxy type used by the HDS node proxyStatus: type: string example: Enabled description: Current proxy status of the HDS node maintenanceMode: type: string example: 'Off' description: On indicates that the node is in maintenance mode, and Off indicates that the node is not in maintenance mode ntpSync: type: string example: Active description: NTP sync status of the HDS node ovaDeploymentType: type: string example: Large description: Deployment type of the HDS node ovaBuildType: type: string example: Dev description: Build type of the HDS node nodeDetailsItems: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. clusters: type: array items: $ref: '#/components/schemas/nodeDetailsCluster' description: List of clusters in the organization. networkTestResults: type: object properties: triggerType: type: string example: Periodic description: Type of trigger for the test. results: type: array items: $ref: '#/components/schemas/singleNetworkTestResult' description: List of individual network test results. clusterDetailsResponseOrgLevel: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. clusters: type: array items: $ref: '#/components/schemas/clusterDetails' description: List of clusters in the organization. availabilitySegment: type: object properties: segmentStartTime: type: string format: date-time example: '2026-01-01T00:00:00Z' description: Start time of the availability segment. segmentEndTime: type: string format: date-time example: '2026-01-02T00:00:00Z' description: End time of the availability segment. onlineNodeCount: type: integer example: 2 description: Number of online nodes in the cluster in the segment. offlineNodeCount: type: integer example: 0 description: Number of offline nodes in the cluster in the segment. totalNodeCount: type: integer example: 2 description: Total number of nodes in the cluster in the segment. clusterSummary: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI description: Unique ID of the cluster. clusterName: type: string example: cluster-1 description: Name of the cluster. clusterNodeDetails: type: object properties: nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the connector/node. host: type: string example: hds-node-1.example.com description: Host Name or Host IP of the HDS node singleNetworkTestResult: type: object properties: timestamp: type: string format: date-time example: '2024-01-15T10:15:30Z' description: Timestamp when the test was triggered type: type: string example: HTTPConnectivityTest description: Type of network test. results: type: array items: $ref: '#/components/schemas/serviceTestResults' description: List of service test results. clusterDetailsWithAvailabilitySegments: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI description: Unique ID of the cluster. clusterName: type: string example: HDS Cluster 1 description: Name of the cluster. availabilitySegments: type: array items: $ref: '#/components/schemas/availabilitySegment' description: List of availability segments for the cluster. networkTestResultsForCluster: type: object properties: clusters: type: object properties: clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI description: Unique ID of the cluster. clusterName: type: string example: HDS Cluster 1 description: Name of the cluster. nodes: type: array items: $ref: '#/components/schemas/networkTestResultsForNode' description: List of nodes with network test results. description: Cluster details with network test results. databaseDetailsResponse: type: object properties: context: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. description: Context for the response payload. databaseType: type: string example: PostgreSQL description: Type of the database. databaseVersion: type: string example: 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 description: Version of the database. nodeDetailsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/nodeDetailsItems' description: Response for node details API clusterDetailsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/clusterDetailsResponseOrgLevel' description: Response for cluster details API serviceTestResults: type: object properties: serviceType: type: string example: WebexCloud description: Type of service. services: type: array items: $ref: '#/components/schemas/singleServiceTestResult' description: List of individual service test results. securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps