Cisco Voice Portal Server Status API

VXML Server status and monitoring

Operations 2

GET /server/status Cisco Voice Portal Get Vxml Server Status #
GET /server/log Cisco Voice Portal Get Recent Server Log Entries #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-server-status-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.

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

OpenAPI Specification

cisco-voice-portal-server-status-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cisco Voice Portal VXML Services Server Status API
  description: The Cisco Unified Customer Voice Portal (CVP) VXML Services API provides management and monitoring capabilities for the CVP VXML Server component.
  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://{vxml-server}:7443/CVP/rest
  description: CVP VXML Server REST management interface
  variables:
    vxml-server:
      default: cvp-vxmlserver.example.com
      description: Hostname or IP of the CVP VXML Server
security:
- basicAuth: []
tags:
- name: Server Status
  description: VXML Server status and monitoring
paths:
  /server/status:
    get:
      operationId: getVxmlServerStatus
      summary: Cisco Voice Portal Get Vxml Server Status
      description: Retrieves the operational status of the VXML Server, including active session count, thread pool status, and resource utilization.
      tags:
      - Server Status
      responses:
        '200':
          description: Server status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VxmlServerStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /server/log:
    get:
      operationId: getServerLogs
      summary: Cisco Voice Portal Get Recent Server Log Entries
      description: Retrieves recent log entries from the VXML Server. Supports filtering by severity level and time range.
      tags:
      - Server Status
      parameters:
      - name: level
        in: query
        description: Minimum log level to include
        schema:
          type: string
          enum:
          - ERROR
          - WARN
          - INFO
          - DEBUG
          default: INFO
      - name: since
        in: query
        description: Return logs since this timestamp
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        schema:
          type: integer
          default: 100
          maximum: 1000
      responses:
        '200':
          description: Log entries
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LogEntry'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    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'
    LogEntry:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        level:
          type: string
          enum:
          - ERROR
          - WARN
          - INFO
          - DEBUG
          example: ERROR
        logger:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        sessionId:
          type: string
          description: Associated session ID, if applicable
          example: '500123'
        applicationName:
          type: string
          description: Associated application, if applicable
          example: example_value
    VxmlServerStatus:
      type: object
      properties:
        hostname:
          type: string
          example: example_value
        status:
          type: string
          enum:
          - running
          - stopped
          - error
          example: running
        uptime:
          type: string
          example: example_value
        version:
          type: string
          example: example_value
        activeSessions:
          type: integer
          example: 10
        maxSessions:
          type: integer
          example: 10
        threadPool:
          type: object
          properties:
            activeThreads:
              type: integer
            idleThreads:
              type: integer
            maxThreads:
              type: integer
            queuedRequests:
              type: integer
          example: example_value
        cpuUsage:
          type: number
          format: float
          example: 42.5
        memoryUsage:
          type: object
          properties:
            heapUsed:
              type: integer
              description: Heap memory used in bytes
            heapMax:
              type: integer
              description: Maximum heap memory in bytes
            heapPercentage:
              type: number
              format: float
          example: example_value
        deployedApplications:
          type: integer
          example: 10
        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'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using CVP VXML Server credentials