openapi: 3.2.0 info: title: Webex Messaging Hybrid Data Security API version: 1.0.0 description: The Webex Messaging APIs offer robust programmatic access to messaging features within Webex, including sending and receiving messages, managing spaces, memberships, attachments, and moderating content. These APIs enable integration with bots, workflow automation, notification systems, and custom messaging solutions to enhance team collaboration and productivity. Use cases include building chatbots, integrating with ticketing or alerting platforms, automating onboarding flows, and creating custom collaboration experiences tailored to business needs. x-provenance: method: harvested authored_by: Cisco Webex harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true note: Published by Cisco. Retrieved unmodified except for this x-provenance block. provider_published: true x-evidence: - type: source url: https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-messaging.json - type: raw url: https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-messaging.json tags: - name: Hybrid Data Security paths: /hds/organizations/{organizationId}: get: responses: '200': description: Ok headers: {} content: application/json: schema: $ref: '#/components/schemas/orgDetailsResponse' example: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ orgName: HDS_Demo orgType: Single Tenant orgMode: Production '400': description: 'Bad Request: The request was invalid or could not be 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 Hybrid Data Security organization, such as the organization name, type of organization. To obtain the Organization ID needed for this API, use the [Organizations API]()' tags: - Hybrid Data Security parameters: - name: organizationId in: path description: Unique ID of the Hybrid Data Security organization. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ schema: type: string /hds/organizations/{organizationId}/clusters: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/orgClustersResponse' example: clusters: - context: orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI clusterName: San Jose clusterStatus: Operational releaseChannel: beta upgradeSchedule: scheduleDays: - sunday scheduleTime: 02:00 scheduleTimeZone: Asia/Kolkata nextUpgradeTime: '2025-07-25T20:30:00Z' - context: orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI clusterName: Bangalore clusterStatus: Operational releaseChannel: beta upgradeSchedule: scheduleDays: - sunday scheduleTime: 02:00 scheduleTimeZone: Asia/Kolkata nextUpgradeTime: '2025-07-25T20:30:00Z' '400': description: The request was invalid or could not be 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: List clusters for an Hybrid Data Security organization operationId: listHDSOrganizationClusters description: 'Retrieve a list of all clusters for a specific Hybrid Data Security organization, including cluster status, release channel, and upgrade schedule details. To obtain the Organization ID needed for this API, use the [Organizations API]()' tags: - Hybrid Data Security parameters: - name: organizationId in: path description: Unique ID of the Hybrid Data Security 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: context: orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI clusterName: Bangalore clusterStatus: Operational releaseChannel: beta upgradeSchedule: scheduleDays: - monday scheduleTime: '11:00' scheduleTimeZone: Asia/Kolkata nextUpgradeTime: '2024-04-01 05:30:00.000' '400': description: 'Bad Request: The request was invalid or could not be 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 Hybrid Data Security cluster, such as the cluster name, cluster status, upgrade schedule, and Hybrid Data Security nodes in the cluster. To obtain the Cluster ID needed for this API, use the [Get organization details API]()' tags: - Hybrid Data Security parameters: - name: clusterId in: path description: Unique ID of the Hybrid Data Security cluster. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI schema: type: string /hds/clusters/{clusterId}/nodes: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/clusterNodesResponse' example: nodes: - context: orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI clusterName: San Jose 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 - context: orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI clusterName: Bangalore nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjNzI host: xyz2.abc2.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 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: List nodes for an Hybrid Data Security cluster operationId: listHDSClusterNodes description: 'Retrieve a list of all nodes for a specific Hybrid Data Security cluster, including availability, proxy details, deployment type, and release version. To obtain the Cluster ID needed for this API, use the [List clusters for an Hybrid Data Security organization API]()' tags: - Hybrid Data Security parameters: - name: clusterId in: path description: Unique ID of the Hybrid Data Security 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: context: orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI clusterName: San Jose 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 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 Hybrid Data Security 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: - Hybrid Data Security parameters: - name: nodeId in: path description: Unique ID of the Hybrid Data Security 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 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 Hybrid Data Security organization operationId: getHDSOrganizationDatabaseDetails description: 'Retrieve details of database information for an Hybrid Data Security organization, such as database type and version used. To obtain the Organization ID needed for this API, use the [Organizations API]()' tags: - Hybrid Data Security parameters: - name: organizationId in: path description: Unique ID of the Hybrid Data Security 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 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 Hybrid Data Security organization details operationId: getHDSMultiTenantOrganizationDetails description: 'Retrieve details of Multi-Tenant Hybrid Data Security 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: - Hybrid Data Security parameters: - name: organizationId in: path description: Unique ID of the Hybrid Data Security organization. required: true example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ schema: type: string /hds/nodes/{nodeId}/alarms: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/nodeAlarmsResponse' example: context: orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5xxx clusterName: San Jose nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjyyy host: 10.196.5.82 alarms: - alarmId: AUTH_WARN.expiring-60 alarmName: Hybrid Data Security Machine Accounts Expiring in 60 days alarmSeverity: Warning alarmDetails: Expiration Details possibleRemediation: Refresh Hybrid Data Security Machine Accounts using Hybrid Data Security Setup Tool currentStatus: Active occurrences: total: '4' details: - raisedAt: '2025-06-14T15:53:00Z' clearedAt: '2025-06-15T15:53:00Z' - raisedAt: '2025-06-14T16:53:00Z' clearedAt: '2025-06-15T17:53:00Z' timeRange: from: '2025-06-15T15:53:00Z' to: '2025-06-16T15:53:00Z' '400': description: 'Bad Request: The request was invalid or could not be 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 alarms for an Hybrid Data Security node operationId: getHDSNodeAlarms description: 'Returns the alarm details for a single Hybrid Data Security node for the provided time range (last 24 hours). To obtain the Node ID needed for this API, use the [List nodes for an Hybrid Data Security cluster API]()' tags: - Hybrid Data Security parameters: - name: nodeId in: path description: Unique ID of the Hybrid Data Security node. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk 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. required: true example: '2025-06-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: '2025-06-16T15:53:00Z' schema: type: string /hds/testResults/nodes/{nodeId}/networkTest: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/networkTestsResultsResponse' example: context: orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= clusterName: hds_bangalore nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk hostName: abc.xyz.com hostIP: 10.196.5.82 testResults: - timestamp: '2025-06-15T35:53:00Z' triggerType: OnDemand result: - type: DNSResolutionTest results: - serviceType: WebexCloud services: - serviceName: idBroker testResult: Failed failureDetails: possibleFailureReason: - 'DNS Resolution issue detected in the Hybrid Data Security Node [Error Code: 1302].' possibleRemediation: - Please ensure that the configured DNS Servers are correct and healthy, and verify the network settings are adhering to the Hybrid Data Security Deployment Guide. - serviceName: identity testResult: Success - serviceName: hercules testResult: Success - serviceType: ThirdPartyCloud services: - serviceName: ecr testResult: Success - type: HTTPConnectivityTest results: - serviceType: WebexCloud services: - serviceName: idBroker testResult: Failed failureDetails: possibleFailureReason: - 'Connectivity issue detected between the Hybrid Data Security Node and the Webex Cloud [Error Code: 1106].' possibleRemediation: - One or more Webex cloud services may not be responding. Retry the test after some time. If the issue persists, please contact Cisco Support. - serviceName: identity testResult: Success - serviceName: hercules testResult: Success - serviceType: ThirdPartyCloud testResult: Success - type: BandwidthTest results: - serviceType: ThirdPartyCloud services: - serviceName: ecr testResult: Success '400': description: 'Bad Request: The request was invalid or could not be 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 Hybrid Data Security node operationId: getNetworkTestResultsForHDSNode description: "Get the latest results of the network tests triggered for a single Hybrid Data Security 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: - Hybrid Data Security parameters: - name: nodeId in: path description: Unique ID of the Hybrid Data Security 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/nodes/{nodeId}/resourceUsage: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/nodeResourceUsageResponse' example: context: orgId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI clusterName: cluster-1 nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI host: xyz.abc.com resourceUsage: - startTime: '2025-06-15T15:00:00Z' endTime: '2025-06-15T15:10:00Z' cpuUsage: peakCpuUsagePercent: 30.78 averageCpuUsagePercent: 8.9 memoryUsage: totalMemoryUsageInMB: 7454 peakMemoryUsageInMB: 6075 peakMemoryUsagePercent: 81.5 averageMemoryUsageInMB: 6042 averageMemoryUsagePercent: 81.06 diskUsage: totalDiskSpaceUsageInMB: 37308 peakDiskSpaceUsageInMB: 18874 peakDiskUsagePercent: 50.59 averageDiskUsage: 18874 averageDiskUsagePercent: 50.59 - startTime: '2025-06-15T15:10:00Z' endTime: '2025-06-15T15:20:00Z' cpuUsage: peakCpuUsagePercent: 30.78 averageCpuUsagePercent: 8.9 memoryUsage: totalMemoryUsageInMB: 7454 peakMemoryUsageInMB: 6075 peakMemoryUsagePercent: 81.5 averageMemoryUsageInMB: 6042 averageMemoryUsagePercent: 81.06 diskUsage: totalDiskSpaceUsageInMB: 37308 peakDiskSpaceUsageInMB: 18874 peakDiskUsagePercent: 50.59 averageDiskUsage: 18874 averageDiskUsagePercent: 50.59 timeRange: from: '2025-06-15T15:00:00Z' to: '2025-06-15T15:20:00Z' '400': description: 'Bad Request: The request was invalid or could not be 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 resource usage for an Hybrid Data Security node operationId: getHDSNodeResourceUsage description: 'Retrieve CPU, memory, and disk resource usage details for a specific Hybrid Data Security node over the requested time range. To obtain the Node ID needed for this API, use the [List nodes for an Hybrid Data Security cluster API]()' tags: - Hybrid Data Security parameters: - name: nodeId in: path description: Unique ID of the Hybrid Data Security node. required: true example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjyyy 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. required: true example: '2025-06-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: '2025-06-15T35:53:00Z' schema: type: string /hds/clusters/{clusterId}/availability: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/clustersAvailabilityDetailsResponse' example: context: orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI= clusterName: San Jose availabilitySegments: - segmentStartTime: '2025-06-15T15:53:00Z' segmentEndTime: '2025-06-16T16:53:00Z' noOfOnlineNodes: 1 noOfOfflineNodes: 1 totalNodes: 2 - segmentStartTime: '2025-06-16T16:53:00Z' segmentEndTime: '2025-06-17T17:53:00Z' noOfOnlineNodes: 0 noOfOfflineNodes: 2 totalNodes: 2 timeRange: from: '2025-06-15T15:53:00Z' to: '2025-06-17T15:53:00Z' '400': description: 'Bad Request: The request was invalid or could not be 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 Hybrid Data Security cluster operationId: getHDSClusterAvailabilityDetails description: 'Get the availability details for an Hybrid Data Security 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: - Hybrid Data Security parameters: - name: clusterId in: path description: Unique ID of the Hybrid Data Security 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: singleServiceTestResult: type: object properties: serviceName: type: string example: idBroker description: Name of the service. testResult: type: string example: Success description: Result of the test for the service. failureDetails: $ref: '#/components/schemas/networkTestFailureDetails' nodeResourceUsageSegment: type: object properties: startTime: type: string format: date-time example: '2025-06-15T15:00:00Z' description: Start time of the resource usage segment. endTime: type: string format: date-time example: '2025-06-15T15:10:00Z' description: End time of the resource usage segment. cpuUsage: type: object properties: peakCpuUsagePercent: type: number example: 30.78 description: Peak CPU usage percentage in the segment. averageCpuUsagePercent: type: number example: 8.9 description: Average CPU usage percentage in the segment. description: CPU usage details for the segment. memoryUsage: type: object properties: totalMemoryUsageInMB: type: number example: 7454 description: Total memory available on the node in MB. peakMemoryUsageInMB: type: number example: 6075 description: Peak memory usage in MB in the segment. peakMemoryUsagePercent: type: number example: 81.5 description: Peak memory usage percentage in the segment. averageMemoryUsageInMB: type: number example: 6042 description: Average memory usage in MB in the segment. averageMemoryUsagePercent: type: number example: 81.06 description: Average memory usage percentage in the segment. description: Memory usage details for the segment. diskUsage: type: object properties: totalDiskSpaceUsageInMB: type: number example: 37308 description: Total disk space available on the node in MB. peakDiskSpaceUsageInMB: type: number example: 18874 description: Peak disk space usage in MB in the segment. peakDiskUsagePercent: type: number example: 50.59 description: Peak disk usage percentage in the segment. averageDiskUsage: type: number example: 18874 description: Average disk usage in MB in the segment. averageDiskUsagePercent: type: number example: 50.59 description: Average disk usage percentage in the segment. description: Disk usage details for the segment. networkTestTypeResult: type: object properties: type: type: string example: DNSResolutionTest description: Type of network test. results: type: array items: $ref: '#/components/schemas/serviceTestResults' description: List of service type test results. 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. noOfOnlineNodes: type: integer example: 1 description: Number of online nodes in the cluster in the segment. noOfOfflineNodes: type: integer example: 1 description: Number of offline nodes in the cluster in the segment. totalNodes: type: integer example: 2 description: Total number of nodes in the cluster in the segment. tenantDetails: type: object properties: tenantOrgId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFCGCGCGH description: Unique ID of the tenant organization. tenantOrgName: 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. 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. nodeDetailsResponse: type: object properties: context: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG description: Unique ID of the organization. clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI description: Unique ID of the cluster. clusterName: type: string example: San Jose description: Name of the cluster. description: Metadata information about the cluster to which the node belongs. nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjNzI description: Unique ID of the connector/node. host: type: string example: xyz.abc.com description: Host Name or Host IP of the Hybrid Data Security node. availabilityDetails: type: object properties: nodeAvailability: type: string example: Online description: Current availability of the Hybrid Data Security node. hdsHealthStatus: type: string example: Healthy / Unhealthy description: Health status of the Hybrid Data Security node. hdsUnhealthyReasons: type: array items: type: string example: - kms unhealthy - avalon unhealthy description: List of reasons for unhealthy status of the Hybrid Data Security node. description: Availability and health details of the Hybrid Data Security node. releaseVersion: type: string example: 2025.07.16.7042 description: The release version of the Hybrid Data Security node. proxyType: type: string example: Explicit description: Proxy type used by the Hybrid Data Security node. proxyStatus: type: string example: Enabled description: Current proxy status of the Hybrid Data Security node. maintenanceMode: type: string example: 'On' 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 Hybrid Data Security node. ovaDeploymentType: type: string example: Large description: Deployment type of the Hybrid Data Security node. ovaBuildType: type: string example: Dev description: Build type of the Hybrid Data Security node. nodeResourceUsageResponse: type: object properties: context: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG description: Unique ID of the organization. clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI description: Unique ID of the cluster. clusterName: type: string example: cluster-1 description: Name of the cluster. nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI description: Unique ID of the node. host: type: string example: xyz.abc.com description: Host name or IP address of the Hybrid Data Security node. description: Metadata information about the node for which resource usage is being retrieved. resourceUsage: type: array items: $ref: '#/components/schemas/nodeResourceUsageSegment' description: List of resource usage segments over the requested time range. timeRange: type: object properties: from: type: string format: date-time example: '2025-06-15T15:00:00Z' description: Start time of the requested data range. to: type: string format: date-time example: '2025-06-15T15:20:00Z' description: End time of the requested data range. description: The time range for the resource usage data. nodeAlarm: type: object properties: alarmId: type: string example: AUTH_WARN.expiring-60 description: Unique identifier of the alarm. alarmName: type: string example: Hybrid Data Security Machine Accounts Expiring in 60 days description: Name of the alarm. alarmSeverity: type: string example: Warning description: Severity level of the alarm. alarmDetails: type: string example: Expiration Details description: Additional details about the alarm. possibleRemediation: type: string example: Refresh Hybrid Data Security Machine Accounts using Hybrid Data Security Setup Tool description: Suggested remediation steps for the alarm. currentStatus: type: string example: Active description: Current status of the alarm. occurrences: type: object properties: total: type: string example: '4' description: Total number of occurrences of the alarm. details: type: array items: $ref: '#/components/schemas/alarmOccurrence' description: List of individual alarm occurrence details. description: Occurrence details of the alarm. nodeAlarmsResponse: type: object properties: context: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG description: Unique ID of the organization. clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5xxx description: Unique ID of the cluster. clusterName: type: string example: San Jose description: Name of the cluster. nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo0NjdiNGIxZC1jZWI2LTQwN2EtYWZmOC1mMjIxZmFiNzhjyyy description: Unique ID of the node. host: type: string example: 10.196.5.82 description: Host name or IP of the Hybrid Data Security node. description: Metadata information about the node for which alarms are being retrieved. alarms: type: array items: $ref: '#/components/schemas/nodeAlarm' description: List of alarms raised for the node. timeRange: type: object properties: from: type: string format: date-time example: '2025-06-15T15:53:00Z' description: Start time of the requested data range. to: type: string format: date-time example: '2025-06-16T15:53:00Z' description: End time of the requested data range. description: The time range for the alarms data. orgDetailsResponse: 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. orgClustersResponse: type: object properties: clusters: type: array items: $ref: '#/components/schemas/clusterDetailsResponse' description: List of clusters in the organization. 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. networkTestFailureDetails: type: object properties: possibleFailureReason: type: array items: type: string example: - 'DNS Resolution issue detected in the Hybrid Data Security Node [Error Code: 1302].' description: List of possible reasons for the test failure. possibleRemediation: type: array items: type: string example: - Please ensure that the configured DNS Servers are correct and healthy, and verify the network settings are adhering to the Hybrid Data Security Deployment Guide. description: List of suggested remediation steps. description: Failure details for a failed network test, present only when testResult is Failed. clustersAvailabilityDetailsResponse: type: object properties: context: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ description: Unique ID of the organization. clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI= description: Unique ID of the cluster. clusterName: type: string example: San Jose description: Name of the cluster. description: Metadata information about the cluster for which availability details are being retrieved. availabilitySegments: type: array items: $ref: '#/components/schemas/availabilitySegment' description: List of availability segments for the cluster. timeRange: type: object properties: from: type: string format: date-time example: '2025-06-15T15:53:00Z' description: Start time of the requested data range. to: type: string format: date-time example: '2025-06-17T15:53:00Z' description: End time of the requested data range. description: The time range for the availability data. networkTestsResultsResponse: type: object properties: context: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJVGNG description: Unique ID of the organization. clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI= description: Unique ID of the cluster. clusterName: type: string example: hds_bangalore description: Name of the cluster. nodeId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk description: Unique ID of the node. hostName: type: string example: abc.xyz.com description: Hostname of the Hybrid Data Security node. hostIP: type: string example: 10.196.5.82 description: IP address of the Hybrid Data Security node. description: Metadata information about the node for which network test results are being retrieved. testResults: type: array items: $ref: '#/components/schemas/networkTestResult' description: List of network test results. clusterDetailsResponse: type: object properties: context: type: object properties: orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ= description: Unique ID of the organization. description: Metadata information about the organization for which the cluster details are being retrieved. clusterId: type: string example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI description: Unique ID of the cluster. clusterName: type: string example: Bangalore description: Name of the cluster. clusterStatus: type: string example: Operational description: Current status of the cluster. releaseChannel: type: string example: beta description: Release channel of the cluster. upgradeSchedule: type: object properties: scheduleDays: type: array items: type: string example: sunday description: Days of the week when upgrades are scheduled. scheduleTime: type: string example: 02: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: '2025-07-25T20:30:00Z' description: Next scheduled upgrade time. description: Upgrade schedule details of the cluster. clusterNodesResponse: type: object properties: nodes: type: array items: $ref: '#/components/schemas/nodeDetailsResponse' description: List of nodes in the cluster. 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. alarmOccurrence: type: object properties: raisedAt: type: string format: date-time example: '2025-06-14T15:53:00Z' description: Timestamp when the alarm was raised. clearedAt: type: string format: date-time example: '2025-06-15T15:53:00Z' description: Timestamp when the alarm was cleared. networkTestResult: type: object properties: timestamp: type: string format: date-time example: '2025-06-15T15:53:00Z' description: Timestamp when the test was triggered. triggerType: type: string example: OnDemand description: Type of trigger for the test. result: type: array items: $ref: '#/components/schemas/networkTestTypeResult' description: List of results per test type. securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT