Cisco Voice Portal Administration API — System Configuration

naftiko: 1.0.0-alpha2
info:
  label: Cisco Voice Portal Administration API — System Configuration
  description: 'Cisco Voice Portal Administration API — System Configuration. 3 operations. Lead operation: Cisco Voice Portal
    Get System-wide Configuration. Self-contained Naftiko capability covering one Cisco Voice Portal business surface.'
  tags:
  - Cisco Voice Portal
  - System Configuration
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CISCO_VOICE_PORTAL_API_KEY: CISCO_VOICE_PORTAL_API_KEY
capability:
  consumes:
  - type: http
    namespace: administration-system-configuration
    baseUri: https://{oamp-server}:9443/oamp/rest
    description: Cisco Voice Portal Administration API — System Configuration business capability. Self-contained, no shared
      references.
    resources:
    - name: system-config
      path: /system/config
      operations:
      - name: getsystemconfig
        method: GET
        description: Cisco Voice Portal Get System-wide Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesystemconfig
        method: PUT
        description: Cisco Voice Portal Update System-wide Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: system-license
      path: /system/license
      operations:
      - name: getlicenseinfo
        method: GET
        description: Cisco Voice Portal Get Licensing Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: JSESSIONID
      value: '{{env.CISCO_VOICE_PORTAL_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: administration-system-configuration-rest
    port: 8080
    description: REST adapter for Cisco Voice Portal Administration API — System Configuration. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/system/config
      name: system-config
      description: REST surface for system-config.
      operations:
      - method: GET
        name: getsystemconfig
        description: Cisco Voice Portal Get System-wide Configuration
        call: administration-system-configuration.getsystemconfig
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatesystemconfig
        description: Cisco Voice Portal Update System-wide Configuration
        call: administration-system-configuration.updatesystemconfig
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/system/license
      name: system-license
      description: REST surface for system-license.
      operations:
      - method: GET
        name: getlicenseinfo
        description: Cisco Voice Portal Get Licensing Information
        call: administration-system-configuration.getlicenseinfo
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: administration-system-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Cisco Voice Portal Administration API — System Configuration. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: cisco-voice-portal-get-system
      description: Cisco Voice Portal Get System-wide Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: administration-system-configuration.getsystemconfig
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-update-system
      description: Cisco Voice Portal Update System-wide Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: administration-system-configuration.updatesystemconfig
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-get-licensing
      description: Cisco Voice Portal Get Licensing Information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: administration-system-configuration.getlicenseinfo
      outputParameters:
      - type: object
        mapping: $.