openapi: 3.0.0
info:
title: Webex Admin Address Book Video Mesh 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: Video Mesh
paths:
/videoMesh/clusters/availability:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersAvailability'
example:
items:
- orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ=
items:
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI=
clusterName: San Jose
availabilitySegments:
- segmentStartTime: '2021-09-15T15:53:00Z'
segmentEndTime: '2021-09-15T16:53:00Z'
availability: Available
noOfOnlineNodes: 1
noOfOfflineNodes: 1
totalNodes: 2
- segmentStartTime: '2021-09-15T16:53:00Z'
segmentEndTime: '2021-09-15T17:53:00Z'
availability: Unavailable
noOfOnlineNodes: 0
noOfOfflineNodes: 2
totalNodes: 2
from: '2021-09-15T15:53:00Z'
to: '2021-09-15T17:53:00Z'
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. 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 request 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 used a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount 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, feel free to 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 on time. If your query uses max parameter, please try to reduce it.'
summary: List Clusters Availability
operationId: List Clusters Availability
description: Returns the availability details for all Video Mesh clusters in an organization.
tags:
- Video Mesh
parameters:
- name: from
in: query
description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.
required: true
example: '2021-09-15T15:53:00Z'
schema:
type: string
- name: to
in: query
description: The ending 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
- name: orgId
in: query
description: The unique ID for the organization.
required: true
example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ
schema:
type: string
/videoMesh/clusters/availability/{clusterId}:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ClustersAvailability'
example:
items:
- orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ=
items:
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI=
clusterName: San Jose
availabilitySegments:
- segmentStartTime: '2021-09-15T15:53:00Z'
segmentEndTime: '2021-09-15T16:53:00Z'
availability: Available
noOfOnlineNodes: 1
noOfOfflineNodes: 1
totalNodes: 2
- segmentStartTime: '2021-09-15T16:53:00Z'
segmentEndTime: '2021-09-15T17:53:00Z'
availability: Unavailable
noOfOnlineNodes: 0
noOfOfflineNodes: 2
totalNodes: 2
from: '2021-09-15T15:53:00Z'
to: '2021-09-15T17:53:00Z'
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. 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 request 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 used a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount 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, feel free to 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 on time. If your query uses max parameter, please try to reduce it.'
summary: Get Cluster Availability
operationId: Get Cluster Availability
description: Returns the availability details of a single Video Mesh cluster in an organization.
tags:
- Video Mesh
parameters:
- name: clusterId
in: path
description: The unique Video Mesh clusterID
required: true
example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI
schema:
type: string
- name: from
in: query
description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.
required: true
example: '2021-09-15T15:53:00Z'
schema:
type: string
- name: to
in: query
description: The ending 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
/videoMesh/nodes/availability:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/NodesAvailability'
example:
items:
- orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ=
items:
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI=
clusterName: San Jose
hostNameOrIp: xyz.abc.com
nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMWViNjVmZGYtOTY0My00MTdmLTk5NzQtYWQ3MmNhZTBlMTBmOmMyNTk0YmY2NDFmZTRkNTFiZDg3YThiMjYxYzg3NWY1
availabilitySegments:
- noOfOnlineNodes: 1
noOfOfflineNodes: 0
segmentStartTime: '2021-09-15T15:53:00Z'
segmentEndTime: '2021-09-15T16:53:00Z'
availability: Available
unAvailabilityReason: NA
totalNodes: 1
- noOfOnlineNodes: 0
noOfOfflineNodes: 1
segmentStartTime: '2021-09-15T16:53:00Z'
segmentEndTime: '2021-09-15T17:53:00Z'
availability: Unavailable
unAvailabilityReason: Connectivity Issues to the Node
totalNodes: 1
from: '2021-09-15T15:53:00Z'
to: '2021-09-15T17:53:00Z'
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. 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 request 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 used a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount 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, feel free to 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 on time. If your query uses max parameter, please try to reduce it.'
summary: List Node Availability
operationId: List Node Availability
description: Returns the availability details of all nodes in a Video Mesh cluster.
tags:
- Video Mesh
parameters:
- name: from
in: query
description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.
required: true
example: '2021-09-15T15:53:00Z'
schema:
type: string
- name: to
in: query
description: The ending 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
- name: clusterId
in: query
description: The unique Video Mesh cluster ID.
required: true
example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg
schema:
type: string
/videoMesh/nodes/availability/{nodeId}:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SingleNodeAvailability'
example:
items:
- orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNmQ4OTRmNy0yYjU3LTQzYzEtYWNlZS1kNDdlNjc3NjE0MTQ=
items:
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzFlYjY1ZmRmLTk2NDMtNDE3Zi05OTc0LWFkNzJjYWUwZTEwZjpiMzdmNTgzYy1kZGRjLTQyOGItODJlNS1jYmU2ODFkYjQ5NjI=
clusterName: San Jose
hostNameOrIp: xyz.abc.com
nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMWViNjVmZGYtOTY0My00MTdmLTk5NzQtYWQ3MmNhZTBlMTBmOmMyNTk0YmY2NDFmZTRkNTFiZDg3YThiMjYxYzg3NWY1
availabilitySegments:
- segmentStartTime: '2021-09-15T15:53:00Z'
segmentEndTime: '2021-09-15T16:53:00Z'
availability: Available
unAvailabilityReason: NA
- segmentStartTime: '2021-09-15T16:53:00Z'
segmentEndTime: '2021-09-15T17:53:00Z'
availability: Unavailable
unAvailabilityReason: Connectivity Issues to the Node
from: '2021-09-15T15:53:00Z'
to: '2021-09-15T17:53:00Z'
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. 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 request 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 used a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount 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, feel free to 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 on time. If your query uses max parameter, please try to reduce it.'
summary: Get Node Availability
operationId: Get Node Availability
description: Returns the availability details of a single node in a Video Mesh cluster.
tags:
- Video Mesh
parameters:
- name: nodeId
in: path
description: The unique Video Mesh node ID.
required: true
example: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzM2ZDg5NGY3LTJiNTctNDNjMS1hY2VlLWQ0N2U2Nzc2MTQxNDo1ODJhMWFlYy03YTMwLTQ2MDItYTI2NS02YTE5NDcwOWZkOTg
schema:
type: string
- name: from
in: query
description: The starting date and time of the requested data in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`.
required: true
example: '2021-09-15T15:53:00Z'
schema:
type: string
- name: to
in: query
description: The ending 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
/videoMesh/testResults/mediaHealthMonitorTest:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/MediaHealthMonitoringResultsCollectionfororganization'
example:
orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yYzNjOWY5NS03M2Q5LTQ0NjAtYTY2OC0wNDcxNjJmZjFiYWQ=
from: '2023-01-15T15:53:00Z'
to: '2023-01-20T15:53:00Z'
items:
- clusters:
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWI=
clusterName: banglore
nodes:
- nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk
hostNameOrIP: abc.company.com
mhmTestResults:
- timestamp: '2022-03-15T15:53:00Z'
id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU
testResults:
- testName: Media Signalling
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support.
- testName: Media Cascade
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1004]. If the issue persists, please contact Cisco Support.
- testName: SIP Signalling
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1002]. If the issue persists, please contact Cisco Support.
- timestamp: '2022-03-15T15:53:00Z'
id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU
testResults:
- testName: Media Signalling
testResult: Success
- testName: Media Cascade
testResult: Success
- testName: SIP Signalling
testResult: Success
- nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk
hostNameOrIP: xyz.company.com
mhmTestResults:
- timestamp: '2022-03-15T15:53:00Z'
id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU
testResults:
- testName: Media Signalling
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support.
- testName: Media Cascade
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1004]. If the issue persists, please contact Cisco Support.
- testName: SIP Signalling
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1002]. If the issue persists, please contact Cisco Support.
- timestamp: '2022-03-15T15:53:00Z'
id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU
testResults:
- testName: Media Signalling
testResult: Success
- testName: Media Cascade
testResult: Success
- testName: SIP Signalling
testResult: Success
- clusterId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DTFVTVEVSLzJjM2M5Zjk1LTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhZDpmMWJmMGI1MC0yMDUyLTQ3ZmUtYjg3ZC01MTFjMmZlNzQ3MWk=
clusterName: sanjose
nodes:
- nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk
hostNameOrIP: abc.company.com
mhmTestResults:
- timestamp: '2022-03-15T15:53:00Z'
id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU
testResults:
- testName: Media Signalling
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support.
- testName: Media Cascade
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1004]. If the issue persists, please contact Cisco Support.
- testName: SIP Signalling
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1002]. If the issue persists, please contact Cisco Support.
- timestamp: '2022-03-15T15:53:00Z'
id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU
testResults:
- testName: Media Signalling
testResult: Success
- testName: Media Cascade
testResult: Success
- testName: SIP Signalling
testResult: Success
- nodeId: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT05ORUNUT1IvMmMzYzlmOTUtNzNkOS00NDYwLWE2NjgtMDQ3MTYyZmYxYmFkOjE1NmRmNzg5Yzg1NTRkNTVhMjc1ZGY5OTc4Zjk5MDJk
hostNameOrIP: xyz.company.com
mhmTestResults:
- timestamp: '2022-03-15T15:53:00Z'
id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU
testResults:
- testName: Media Signalling
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1003]. If the issue persists, please contact Cisco Support.
- testName: Media Cascade
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1004]. If the issue persists, please contact Cisco Support.
- testName: SIP Signalling
testResult: Failed
failureReason: An internal error occurred in monitoring tool [Error Code:1002]. If the issue persists, please contact Cisco Support.
- timestamp: '2022-03-15T15:53:00Z'
id: Y2lzY29zcGFyazovL3VzL0hZQlJJRF9DT01NQU5EX0lELzJjM2M5ZjllLTczZDktNDQ2MC1hNjY4LTA0NzE2MmZmMWJhYzo2NTJmNmMxMC01NjgxLTExZWQtOTkyZS1kNTY5YzlkMDlhNzU
testResults:
- testName: Media Signalling
testResult: Success
- testName: Media Cascade
testResult: Success
- testName: SIP Signalling
testResult: Success
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. 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 request 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 used a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount 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, feel free to 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 on time. If your query uses max parameter, please try to reduce it.'
summary: List Media Health Monitoring Tool Test results V2
operationId: List Media Health Monitoring Tool Test results V2
description: 'Returns the test results of the Media Health Monitoring Tool tests for an organization.
<br/>
Changes in V2:
<br/>
On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes.'
tags:
- Video Mesh
parameters:
- name: orgId
in: query
description: Unique ID of the organization
# --- truncated at 32 KB (298 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-video-mesh-api-openapi.yml