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

Call Server health and connectivity status

Cisco Voice Portal Health 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 Health. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against a single base URL, https://{call-server}:8000/cvp/rest.

2 operations 2 paths 3 schemas 2 GET

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
Resource Areas
1

Authentication & Security 1

Cisco Voice Portal Health API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication using CVP Call Server credentials

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Health 2

Call Server health and connectivity status

GET
/health
Cisco Voice Portal Get Call Server Health Status
getCallServerHealth → 200500
GET
/health/connectivity
Cisco Voice Portal Get Connectivity Status to Upstream Components
getConnectivityStatus → 200500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are HealthStatus (10 properties), Error (4 properties), ConnectivityStatus (2 properties). Each schema is shown below with its type and property counts.

ConnectivityStatus
object
2 properties
HealthStatus
object
10 properties
Error
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cisco-voice-portal-health-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 Device Management API
Cisco Voice Portal Dialed Number Patterns API
Cisco Voice Portal Grammar Management API
Cisco Voice Portal Historical Reports API
Where this information came from

This is an independent, third-party profile of Cisco Voice Portal Health 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.