Cisco Expressway System Status API

openapi: 3.2.0
info:
  title: Cisco Expressway Status System Status API
  description: RESTful API for retrieving status information, alarms, call history, licensing status, upgrade progress, registration details, and system health metrics from Cisco Expressway. Status endpoints follow the pattern /api/status/common/ for items common between Expressway-E and Expressway-C. The API uses JSON Schema version 4 for response schemas and requires HTTPS with HTTP Basic Authentication using Expressway administrator credentials.
  version: 14.2.0
  contact:
    name: Cisco TAC
    email: tac@cisco.com
    url: https://www.cisco.com/c/en/us/support/unified-communications/expressway-series/tsd-products-support-series-home.html
  license:
    name: Cisco EULA
    url: https://www.cisco.com/c/en/us/about/legal/cloud-and-software/end_user_license_agreement.html
  x-logo:
    url: https://www.cisco.com/c/dam/en/us/products/collateral/unified-communications/expressway-series/datasheet-c78-733751.jpg
servers:
- url: https://{host}/api
  description: Cisco Expressway server
  variables:
    host:
      default: expressway.example.com
      description: The FQDN or IP address of the Cisco Expressway node. The API is only accessible via HTTPS.
security:
- basicAuth: []
tags:
- name: System Status
  description: System overview and health information
paths:
  /status/common/systeminfo:
    get:
      operationId: getSystemStatus
      summary: Cisco Expressway Retrieve system status overview
      description: Returns a comprehensive system status overview for the Expressway node including the system name, software version, hardware version, serial number, uptime, IPv4 and IPv6 addresses, virtual machine size, current registration and call counts, and option key status.
      tags:
      - System Status
      responses:
        '200':
          description: System status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Error:
      type: object
      description: Standard error response from the Expressway API
      properties:
        error:
          type: string
          description: Error code or type
        message:
          type: string
          description: Human-readable error description
    SystemStatus:
      type: object
      description: Comprehensive system status overview for the Expressway node
      properties:
        SystemName:
          type: string
          description: The name assigned to the Expressway
          examples:
          - Expressway-C-Primary
        SoftwareVersion:
          type: string
          description: Currently installed software version
          examples:
          - X14.2
        HardwareVersion:
          type: string
          description: Hardware or virtual appliance version
          examples:
          - VM
        SerialNumber:
          type: string
          description: Hardware or VM serial number
        Uptime:
          type: string
          description: Time elapsed since the system last restarted
          examples:
          - 45 days 12:34:56
        IPv4Address:
          type: string
          format: ipv4
          description: IPv4 address of the Expressway
          examples:
          - 10.0.0.1
        IPv6Address:
          type: string
          format: ipv6
          description: IPv6 address of the Expressway
        VMSize:
          type: string
          description: Virtual machine size designation
          enum:
          - Small
          - Medium
          - Large
        CurrentRegistrations:
          type: integer
          description: Number of currently active registrations
          examples:
          - 150
        CurrentCalls:
          type: integer
          description: Number of currently active calls
          examples:
          - 12
        OptionKeys:
          type: array
          description: List of installed option keys and their status
          items:
            type: object
            properties:
              Name:
                type: string
                description: Option key feature name
              Status:
                type: string
                description: Activation status
                enum:
                - Active
                - Expired
                - Not Installed
        ClusterRole:
          type: string
          description: Role of this node in a cluster
          enum:
          - Primary
          - Peer
          - Standalone
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid. The API requires HTTP Basic Authentication with administrator credentials over HTTPS.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The authenticated user does not have sufficient permissions for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Expressway administrator credentials. The API is only accessible via HTTPS.
externalDocs:
  description: Cisco Expressway REST API Summary Guide (X14.2)
  url: https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/expressway/admin_guide/X14-2/rest-api/exwy_b_cisco-expressway-rest-api-summary-guide--x142/exwy_m_using-the-expressway-rest-api.html