Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Video Mesh API

The Video Mesh API from Webex — 29 operation(s) for video mesh.

Webex Video Mesh API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Video Mesh. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 30 operations across 29 paths, and defines 172 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

30 operations 29 paths 172 schemas 26 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex Video Mesh API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 30

Across 29 paths, the API surfaces 30 operations — 26 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Video Mesh 30
GET
/videoMesh/clusters/availability
List Clusters Availability
List Clusters Availability 3 params → 200400401403404405409410
GET
/videoMesh/clusters/availability/{clusterId}
Get Cluster Availability
Get Cluster Availability 3 params → 200400401403404405409410
GET
/videoMesh/nodes/availability
List Node Availability
List Node Availability 3 params → 200400401403404405409410
GET
/videoMesh/nodes/availability/{nodeId}
Get Node Availability
Get Node Availability 3 params → 200400401403404405409410
GET
/videoMesh/testResults/mediaHealthMonitorTest
List Media Health Monitoring Tool Test results V2
List Media Health Monitoring Tool Test results V2 4 params → 200400401403404405409410
GET
/videoMesh/testResults/mediaHealthMonitorTest/clusters
Get Media Health Monitoring Tool Test results for clusters V2
Get Media Health Monitoring Tool Test results for clusters V2 4 params → 200400401403404405409410
GET
/videoMesh/testResults/mediaHealthMonitorTest/nodes
Get Media Health Monitoring Tool Test results for node V2
Get Media Health Monitoring Tool Test results for node V2 4 params → 200400401403404405409410
GET
/videoMesh/cloudOverflow
List Overflow to Cloud details
List Overflow to Cloud details 3 params → 200400401403404405409410
GET
/videoMesh/callRedirects
List Cluster Redirect details
List Cluster Redirect details 3 params → 200400401403404405409410
GET
/videoMesh/clusters/callRedirects
Get Cluster Redirect details
Get Cluster Redirect details 3 params → 200400401403404405409410
GET
/videoMesh/utilization
List Clusters Utilization
List Clusters Utilization 3 params → 200400401403404405409410
GET
/videoMesh/clusters/utilization
Get Cluster Utilization details
Get Cluster Utilization details 3 params → 200400401403404405409410
GET
/videoMesh/testResults/reachabilityTest
List Reachability Test results V2
List Reachability Test results V2 4 params → 200400401403404405409410
GET
/videoMesh/testResults/reachabilityTest/clusters
Get Reachability Test results for cluster V2
Get Reachability Test results for cluster V2 4 params → 200400401403404405409410
GET
/videoMesh/testResults/reachabilityTest/nodes
Get Reachability Test results for node V2
Get Reachability Test results for node V2 4 params → 200400401403404405409410
GET
/videoMesh/clusters
List Cluster Details
List Cluster Details 1 param → 200400401403404405409410
GET
/videoMesh/clusters/{clusterId}
Get Cluster Details
Get Cluster Details 1 param → 200400401403404405409410
POST
/videoMesh/triggerTest/clusters/{clusterId}
Trigger on-demand test for cluster
Trigger on-demand test for cluster 1 param body → 200400401403404405409410
POST
/videoMesh/triggerTest/nodes/{nodeId}
Trigger on-demand test for node
Trigger on-demand test for node 1 param body → 200400401403404405409410
GET
/videoMesh/testStatus
Get Triggered test status
Get Triggered test status 1 param → 200400401403404405409410
GET
/videoMesh/testResults
Get Triggered test results
Get Triggered test results 1 param → 200400401403404405409410
GET
/videoMesh/testResults/networkTest
List Network Test results
List Network Test results 4 params → 200400401403404405409410
GET
/videoMesh/testResults/networkTest/clusters
Get Network Test results for cluster
Get Network Test results for cluster 4 params → 200400401403404405409410
GET
/videoMesh/testResults/networkTest/nodes
Get Network Test results for node
Get Network Test results for node 4 params → 200400401403404405409410
GET
/videoMesh/clientTypeDistribution
List Cluster Client Type Distribution details
List Cluster Client Type Distribution details 4 params → 200400401403404405409410
GET
/videoMesh/clientTypeDistribution/clusters
Get Cluster Client Type Distribution details
Get Cluster Client Type Distribution details 4 params → 200400401403404405409410
GET
/videoMesh/eventThresholds
List Event Threshold Configuration
List Event Threshold Configuration 4 params → 200400401403404405409410
PATCH
/videoMesh/eventThresholds
Update Event Threshold Configuration
Update Event Threshold Configuration body → 200400401403404405409410
GET
/videoMesh/eventThresholds/{eventThresholdId}
Get Event Threshold Configuration
Get Event Threshold Configuration 1 param → 200400401403404405409410
POST
/videoMesh/eventThresholds/reset
Reset Event Threshold Configuration
Reset Event Threshold Configuration body → 200400401403404405409410

Schemas 172

The contract defines 172 schemas that model the data the API accepts and returns. The most detailed are NodeUnAvailableTimeline (7 properties), NodeAvailableTimeline (7 properties), ClusterUnAvailableTimeline (6 properties), ClusterAvailableTimeline (6 properties). Each schema is shown below with its type and property counts.

UtilizationForClusterTrend2
object
2 properties
ClusterRedirectBlr2
object
3 properties
ClientTypeDistributionCollectionForCluster
object
5 properties
DNSResolutionTest
object
2 properties
NodeAvailableTimeline
object
7 properties
NodesAvailability
object
1 property
ReachabilityTestResultsStunresults1
object
5 properties
PerNodeConnectivityResult1
object
3 properties
RedirectCollectionForCluster
object
5 properties
ReachabilityTestResultsforfirstcluster
object
3 properties
OverflowDetails3
object
3 properties
MediaHealthMonitoringforfirstcluster
object
3 properties
ReachabilityTestResultsforcluster
object
1 property
FailureDetails2
object
2 properties
ResetEventThresholdResponse
object
3 properties
ClientTypeDistributionTrend2
object
2 properties
SIPSignallingtestResultFailure
object
3 properties
OverflowDetails1
object
3 properties
ClusterRedirectDetailsSJ2
object
3 properties
ClusterRedirectDetailsBlr2
object
3 properties
ClusterClientTypeDistributionDetailsBlr2
object
3 properties
MediaHealthMonitoringTestResultsFailure
object
3 properties
ClusterRedirectSJ1
object
3 properties
MediaCascadetestResultFailure
object
3 properties
UtilizationForClusterTrend1
object
2 properties
ServiceTypeResult2
object
2 properties
ReachabilityTestResultsforoneclusteronenode
object
1 property
ClusterUtilizationTrend2
object
2 properties
BulkUpdateEventThresholdResponse
object
3 properties
ClusterAvailability
object
3 properties
ClusterUtilizationT2Blr
object
3 properties
ClusterClientTypeDistributionSJ2
object
3 properties
RedirectTrendForCluster1
object
2 properties
MediaSignallingtestResultSuccess
object
2 properties
MediaHealthMonitoringclusters
object
1 property
MediaHealthMonitoringTestResultsSuccess
object
3 properties
ClusterUnAvailableTimeline
object
6 properties
MHMTestResult3
object
2 properties
Results
object
3 properties
NodeAvailability
object
5 properties
MediaCascadetestResultSuccess
object
2 properties
CloudOverflowTrend1
object
2 properties
EventThresholdConfig1
object
2 properties
ClientTypeDistributionTrendForCluster1
object
2 properties
ReachabilityTestresultsSuccess
object
3 properties
RedirectForCluster
object
1 property
PernodeMediaHealthMonitoringresult
object
3 properties
MediaHealthMonitoringResultsCollectionfororganization
object
4 properties
GetEntityThresholdConfig1
object
5 properties
ClusterClientTypeDistributionDetailsBlr1b
object
3 properties
ClusterClientTypeDistributionBlr1
object
3 properties
ClusterAvailabilityCollection
object
4 properties
ClusterClientTypeDistributionDetailsBlr1a
object
3 properties
UtilizationMetricsT2SJ
object
4 properties
ClusterRedirectBlr1
object
3 properties
ClusterUtilizationT1Blr
object
3 properties
RedirectforOrg
object
1 property
NodeStatusList2
object
2 properties
NodeUnAvailableTimeline
object
7 properties
ClusterDetails
object
1 property
ServiceTypeResult4
object
3 properties
ConnectivityTestResultsForNode
object
4 properties
ConnectivityTestResultsClustersObject1
object
1 property
SJClusterDetails
object
5 properties
NodeAvailabilityCollection
object
4 properties
WebSocketConnectivityTest
object
2 properties
ClusterDetailsCollection
object
2 properties
TestClustersResult
object
1 property
SingleNodeAvailabilityObject
object
5 properties
MHMTestResult1
object
3 properties
ReachabilityTestResultsforsinglecluster
object
1 property
ReachabilityTestresultsFailure
object
3 properties
TriggerOnDemandBody
object
1 property
ClusterClientTypeDistributionDetailsSJ2
object
3 properties
ClustersAvailability
object
1 property
CloudOverflowTrend2
object
2 properties
ClusterClientTypeDistributionDetailsSJ1
object
3 properties
BlrNodeLocation
object
3 properties
ClustersUtilization
object
1 property
RedirectTrend1
object
2 properties
ClientTypeDistributionForCluster
object
1 property
ClienttypedistributionCollectionforOrg
object
5 properties
PerclusterMediaHealthMonitoringresult
object
3 properties
UpdateEventThresholdConfig1
object
2 properties
OverflowDetails2
object
3 properties
ReachabilityTestresultsfornode
object
4 properties
UtilizationForClusterCollection
object
5 properties
SpecificClusterDetails
object
1 property
GetEntityThresholdConfig2
object
5 properties
ReachabilityTestresultsdestinationcluster
object
2 properties
OverflowtoCloudCollection
object
5 properties
ClusterRedirectDetailsBlr1a
object
3 properties
NodesResult
object
3 properties
ClusterUpgradeScheduleBlr
object
5 properties
ClusterClientTypeDistributionSJ1
object
3 properties
BlrNode1
object
4 properties
SIPSignallingtestResultSuccess
object
2 properties
ConnectivityTestResultsNodesObject
object
4 properties
ListEventThresholdResponse
object
2 properties
TriggeredTestStatus2
object
4 properties
UtilizationMetricsT1SJ
object
4 properties
SingleNodeAvailableTimeline
object
4 properties
MediaHealthMonitoringsecondnode
object
3 properties
ConnectivityTestResultsClustersObject2
object
1 property
MediaHealthMonitoringResultsCollectionforcluster
object
4 properties
ReachabilityTestresultsfororganization
object
4 properties
TriggeredTestStatus1
object
4 properties
BlrNode2
object
4 properties
NodeStatusList1
object
2 properties
ClusterRedirectDetailsBlr1b
object
3 properties
PerNodeConnectivityResult3
object
3 properties
SJNode1
object
4 properties
ClientTypeDistributionTrendForCluster2
object
2 properties
PernodeMediaHealthMonitoringclusters
object
1 property
ConnectivityTestResultsObject
object
4 properties
RedirectTrendForCluster2
object
2 properties
ClusterAvailableTimeline
object
6 properties
MediaHealthMonitoringforsecondcluster
object
3 properties
UtilizationMetricsT1Blr
object
4 properties
ConnectivityTestResultsClustersObject3
object
1 property
SpecificClusterDetailsCollection
object
2 properties
UtilizationMetricsT2Blr
object
4 properties
ReachabilityTestresultssecondnode
object
3 properties
ClusterUtilizationT2SJ
object
3 properties
PerClusterConnectivityResult3
object
3 properties
ReachabilityTestresultsforcluster
object
4 properties
MHMTestResult2
object
3 properties
ClusterRedirectDetailsSJ1
object
3 properties
ClusterUpgradeScheduleSJ
object
5 properties
PerClusterConnectivityResult1
object
3 properties
RedirectCollectionForOrg
object
5 properties
EventThresholdConfig2
object
2 properties
GetEventThresholdResponse
object
2 properties
MediaHealthMonitoringfirstnode
object
3 properties
ConnectivityTestResultsClustersObject
object
4 properties
PerNodeConnectivityResult2
object
3 properties
RedirectTrend2
object
2 properties
TriggeredTestResult
object
4 properties
BlrClusterDetails
object
5 properties
ServiceTypeResult3
object
3 properties
ServiceTypeResult1
object
3 properties
SingleNodeUnAvailableTimeline
object
4 properties
ServiceTypeResult5
object
2 properties
MediaHealthMonitoringResultsCollectionfornode
object
4 properties
FailureDetails1
object
2 properties
SJNodeLocation
object
3 properties
HTTPConnectivityTest
object
2 properties
ReachabilityTestResultsStunresults2
object
5 properties
ClientTypeDistributionTrend1
object
2 properties
MHMTestResults
object
3 properties
OverflowtoCloud
object
1 property
BandwidthTest
object
2 properties
SJNode2
object
4 properties
ClienttypedistributionforOrg
object
1 property
PerclusterMediaHealthMonitoringclusters
object
1 property
MediaSignallingtestResultFailure
object
3 properties
TriggerOn-DemandBodyCluster
object
2 properties
ClusterUtilizationT1SJ
object
3 properties
UtilizationForCluster
object
1 property
ClusterRedirectSJ2
object
3 properties
ReachabilityTestResultsforonecluster
object
3 properties
ClusterUtilizationCollection
object
5 properties
ClusterClientTypeDistributionBlr2
object
3 properties
SingleNodeAvailability
object
1 property
FailureDetails3
object
2 properties
PerClusterConnectivityResult2
object
3 properties
ClusterUtilizationTrend1
object
2 properties
ReachabilityTestResultsforsecondcluster
object
3 properties
UpdateEventThresholdResponse1
object
5 properties
ReachabilityTestresultsfirstnode
object
3 properties
SingleNodeAvailabilityCollection
object
4 properties
ScheduleDays
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-video-mesh-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agent Wellbeing API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API