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 Devices API

The Devices API from Webex — 3 operation(s) for devices.

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

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

This API exposes 6 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

6 operations 3 paths 9 schemas 1 DELETE2 GET1 PATCH2 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 Devices 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 6

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

Devices 6
GET
/devices
List Devices
List Devices 21 params → 200400401403404405409410
POST
/devices
Create a Device by MAC Address
Create a Device by MAC Address 1 param body → 200400401403404405409410
GET
/devices/{deviceId}
Get Device Details
getDeviceDetails 2 params → 200400401403404405409410
DELETE
/devices/{deviceId}
Delete a Device
Delete a Device 2 params → 204400401403404405409410
PATCH
/devices/{deviceId}
Modify Device Tags
Modify Device Tags 2 params body → 200400401403404405409410
POST
/devices/activationCode
Create a Device Activation Code
Create a Device Activation Code 1 param body → 200400401403404405409410

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Device (29 properties), ActivationCode (2 properties), DeviceCollectionResponse (1 property). Each schema is shown below with its type and property counts.

DevicePlatform
string
Device platform
NetworkConnectivityType
string
The current network connectivity for the device.
DeviceConnectionStatus
string
The connection status of the device.
Device
object
29 properties 1 required
ActivationCode
object
2 properties
DevicePermissions
string
DeviceCollectionResponse
object
1 property
DeviceCapabilities
string
ManagedBy
string
Entity managing the device configuration.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-devices-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