How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cisco Voice Portal Device Management API

Manage CVP devices (Call Servers, VXML Servers, Reporting Servers)

Cisco Voice Portal Device Management API is one of 24 APIs that Cisco Voice Portal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 12.6.0.

Requests are made against a single base URL, https://{oamp-server}:9443/oamp/rest.

7 operations 4 paths 6 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
12.6.0
Base URL
https://cvp-callserver.example.com:8000/cvp/rest
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

Cisco Voice Portal Device Management API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the cookie as JSESSIONID (sessionCookie). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication using CVP OAMP administrative credentials. The default administrator account is configured during CVP installation.
  • sessionCookie — Session-based authentication obtained after login. The JSESSIONID cookie is returned after successful basic authentication.

Paths & Operations 7

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

Device Management 7

Manage CVP devices (Call Servers, VXML Servers, Reporting Servers)

GET
/device
Cisco Voice Portal List All Managed Devices
listDevices → 200401500
POST
/device
Cisco Voice Portal Add a New Device
addDevice body → 201400401409500
GET
/device/{deviceId}
Cisco Voice Portal Get Device Details
getDevice 1 param → 200401404500
PUT
/device/{deviceId}
Cisco Voice Portal Update Device Configuration
updateDevice 1 param body → 200400401404500
DELETE
/device/{deviceId}
Cisco Voice Portal Remove a Managed Device
deleteDevice 1 param → 204401404500
GET
/device/{deviceId}/status
Cisco Voice Portal Get Device Operational Status
getDeviceStatus 1 param → 200401404500
POST
/device/{deviceId}/restart
Cisco Voice Portal Restart a Device Service
restartDevice 1 param → 202401404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Device (8 properties), DeviceStatus (7 properties), OperationStatus (6 properties), DeviceCreateRequest (5 properties). Each schema is shown below with its type and property counts.

Device
object
8 properties
Error
object
4 properties
DeviceCreateRequest
object
5 properties 3 required
OperationStatus
object
6 properties
DeviceUpdateRequest
object
3 properties
DeviceStatus
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-voice-portal-device-management-api-openapi.yml Raw ↑

Other APIs Cisco Voice Portal publishes across the network.

Cisco Voice Portal Call Events API
Cisco Voice Portal Application Configuration API
Cisco Voice Portal Application Management API
Cisco Voice Portal Call Detail Records API
Cisco Voice Portal Call Management API
Cisco Voice Portal Call Routing API
Cisco Voice Portal Call Server Management API
Cisco Voice Portal Deployment API
Cisco Voice Portal Dialed Number Patterns API
Cisco Voice Portal Grammar Management API
Cisco Voice Portal Health API
Cisco Voice Portal Historical Reports API
Where this information came from

This is an independent, third-party profile of Cisco Voice Portal Device Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.