Cisco Expressway Licensing API

openapi: 3.1.0
info:
  title: Cisco Expressway Configuration Admin Account Licensing API
  description: RESTful API for configuring and managing Cisco Expressway systems including zones, search rules, transforms, DNS servers, NTP servers, SFTP configuration, system upgrades, and admin account management. The API uses JSON Schema version 4 for request and response schemas and is self-documented via RAML definitions available at /api/raml on the Expressway system. All endpoints require HTTPS and 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: Licensing
  description: Smart licensing status and usage
paths:
  /v1/status/common/smartlicensing/licensing:
    get:
      operationId: getSmartLicensingStatus
      summary: Cisco Expressway Retrieve smart licensing status
      description: Returns the current smart licensing status for the Expressway including the license registration status, authorization status, license entitlements, usage counts, and compliance state. This endpoint is documented in the Cisco Expressway REST API Summary Guide as a primary status retrieval endpoint.
      tags:
      - Licensing
      responses:
        '200':
          description: Smart licensing status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmartLicensingStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  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'
  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
    SmartLicensingStatus:
      type: object
      description: Smart licensing status for the Expressway including registration and authorization state, entitlements, and compliance information.
      properties:
        RegistrationStatus:
          type: string
          description: Smart licensing registration status
          enum:
          - Registered
          - Not Registered
          - Registration Expired
          examples:
          - Registered
        AuthorizationStatus:
          type: string
          description: License authorization status
          enum:
          - Authorized
          - Not Authorized
          - Authorization Expired
          - Out of Compliance
          examples:
          - Authorized
        SmartAccountName:
          type: string
          description: Name of the associated Cisco Smart Account
        VirtualAccountName:
          type: string
          description: Name of the associated Virtual Account
        LastRenewalAttempt:
          type: string
          format: date-time
          description: Timestamp of the last license renewal attempt
        NextRenewalAttempt:
          type: string
          format: date-time
          description: Timestamp of the next scheduled renewal
        Entitlements:
          type: array
          description: List of license entitlements and their usage
          items:
            type: object
            properties:
              Name:
                type: string
                description: Entitlement name
                examples:
                - Rich Media Session
              InUse:
                type: integer
                description: Number of licenses currently in use
              Authorized:
                type: integer
                description: Number of authorized licenses
              ComplianceStatus:
                type: string
                description: Compliance status for this entitlement
                enum:
                - In Compliance
                - Out of Compliance
  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