find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cisco-voice-portal-health-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Cisco Voice Portal Call Control Health API
  description: The Cisco Unified Customer Voice Portal (CVP) Call Control API provides programmatic access to call control functions on the CVP Call Server. The Call Server is the SIP-based call control component that manages call routing, transfers, and session management within the CVP deployment. It integrates with Cisco Unified ICM/UCCE for intelligent call routing and with Cisco Unified Communications Manager (CUCM) for agent delivery. This API exposes management and monitoring operations for active call sessions and call routing configuration on the Call Server component, typically accessible on port 8000.
  version: 12.6.0
  contact:
    name: Cisco Developer Support
    url: https://developer.cisco.com/
  license:
    name: Cisco DevNet
    url: https://developer.cisco.com/site/license/
  x-provider: cisco
  x-product: unified-customer-voice-portal
servers:
- url: https://{call-server}:8000/cvp/rest
  description: CVP Call Server REST management interface
  variables:
    call-server:
      default: cvp-callserver.example.com
      description: Hostname or IP of the CVP Call Server
security:
- basicAuth: []
tags:
- name: Health
  description: Call Server health and connectivity status
paths:
  /health:
    get:
      operationId: getCallServerHealth
      summary: Cisco Voice Portal Get Call Server Health Status
      description: Retrieves the health and resource status of the Call Server, including active call count, SIP stack status, and connectivity to upstream components (ICM, CUCM, VXML Server).
      tags:
      - Health
      responses:
        '200':
          description: Call Server health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /health/connectivity:
    get:
      operationId: getConnectivityStatus
      summary: Cisco Voice Portal Get Connectivity Status to Upstream Components
      description: Checks and reports the connectivity status to all configured upstream components including ICM/UCCE, CUCM clusters, VXML Servers, and Reporting Server.
      tags:
      - Health
      responses:
        '200':
          description: Connectivity status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectivityStatus'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ConnectivityStatus:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        connections:
          type: array
          items:
            type: object
            properties:
              component:
                type: string
                enum:
                - ICM
                - CUCM
                - VXMLServer
                - ReportingServer
                - MediaServer
              hostname:
                type: string
              ipAddress:
                type: string
              port:
                type: integer
              status:
                type: string
                enum:
                - connected
                - disconnected
                - timeout
                - error
              latency:
                type: integer
                description: Connection latency in milliseconds
              lastSuccessfulContact:
                type: string
                format: date-time
          example: []
    HealthStatus:
      type: object
      properties:
        serverName:
          type: string
          example: example_value
        status:
          type: string
          enum:
          - healthy
          - degraded
          - unhealthy
          example: healthy
        uptime:
          type: string
          description: Server uptime duration
          example: example_value
        version:
          type: string
          example: example_value
        activeCalls:
          type: integer
          example: 10
        maxCalls:
          type: integer
          description: Maximum concurrent call capacity
          example: 10
        sipStackStatus:
          type: string
          enum:
          - running
          - stopped
          - error
          example: running
        cpuUsage:
          type: number
          format: float
          example: 42.5
        memoryUsage:
          type: number
          format: float
          example: 42.5
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        details:
          type: string
          example: example_value
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
  responses:
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using CVP Call Server credentials