{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book HDS API", "version": "1.0.0" }, "items": [ { "info": { "name": "HDS", "type": "folder" }, "items": [ { "info": { "name": "Get organization details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hds/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ", "type": "path", "description": "Unique ID of the HDS organization." } ] }, "docs": "Retrieve details for an HDS organization, such as the organization name, type of organization, and clusters in the organization.\nTo obtain the Organization ID needed for this API, use the [Organizations API]()" }, { "info": { "name": "Get cluster details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hds/clusters/:clusterId", "params": [ { "name": "clusterId", "value": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI", "type": "path", "description": "Unique ID of the HDS cluster." } ] }, "docs": "Retrieve details for a specific HDS cluster, such as the cluster name, cluster status, upgrade schedule, and HDS nodes in the cluster.\nTo obtain the Cluster ID needed for this API, use the [Get organization details API]()" }, { "info": { "name": "Get node details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hds/nodes/:nodeId", "params": [ { "name": "nodeId", "value": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "type": "path", "description": "Unique ID of the HDS node" } ] }, "docs": "Retrieve details for a specific HDS node, such as host name, release version, proxy details, deployment and build type, availability details, etc.\nTo obtain the Node ID needed for this API, use the [Get cluster details API]()" }, { "info": { "name": "Get database details for the HDS organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hds/organizations/:organizationId/database", "params": [ { "name": "organizationId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ", "type": "path", "description": "Unique ID of the HDS organization" } ] }, "docs": "Retrieve details of database information for an HDS organization, such as database type and version used.\nTo obtain the Organization ID needed for this API, use the [Organizations API]()" }, { "info": { "name": "Get Multi-Tenant HDS organization details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hds/organizations/:organizationId/tenants", "params": [ { "name": "organizationId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ", "type": "path", "description": "Unique ID of the HDS organization." } ] }, "docs": "Retrieve details of Multi-Tenant HDS organization such as Organization Name and ID, CMK state and state of Tenants Organizations.\nTo obtain the Organization ID needed for this API, use the [Organizations API]()" }, { "info": { "name": "Get test results for HDS node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hds/testResults/nodes/:nodeId/networkTest", "params": [ { "name": "nodeId", "value": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk", "type": "path", "description": "Unique ID of the HDS node." }, { "name": "triggerType", "value": "All", "type": "query", "description": "Trigger type." } ] }, "docs": "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]()" }, { "info": { "name": "Get availability details for HDS cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hds/clusters/:clusterId/availability", "params": [ { "name": "clusterId", "value": "Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI", "type": "path", "description": "Unique ID of the HDS cluster." }, { "name": "from", "value": "2021-09-15T15:53:00Z", "type": "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." }, { "name": "to", "value": "2021-09-15T17:53:00Z", "type": "query", "description": "The end date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format." } ] }, "docs": "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.\nTo obtain the Cluster ID needed for this API, use the [Get organization details API]()" } ] } ], "bundled": true }