Trellix Web Gateway REST API — Configuration

naftiko: 1.0.0-alpha2
info:
  label: Trellix Web Gateway REST API — Configuration
  description: 'Trellix Web Gateway REST API — Configuration. 5 operations. Lead operation: Get current configuration. Self-contained
    Naftiko capability covering one Trellix Web Gateway business surface.'
  tags:
  - Trellix Web Gateway
  - Configuration
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TRELLIX_WEB_GATEWAY_API_KEY: TRELLIX_WEB_GATEWAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-configuration
    baseUri: https://{mwg-server}:{port}/Konfigurator/REST
    description: Trellix Web Gateway REST API — Configuration business capability. Self-contained, no shared references.
    resources:
    - name: configuration
      path: /configuration
      operations:
      - name: getconfiguration
        method: GET
        description: Get current configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: configuration-backup
      path: /configuration/backup
      operations:
      - name: createbackup
        method: POST
        description: Create a configuration backup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: configuration-commit
      path: /configuration/commit
      operations:
      - name: commitconfiguration
        method: POST
        description: Commit configuration changes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: configuration-restore
      path: /configuration/restore
      operations:
      - name: restorebackup
        method: POST
        description: Restore a configuration backup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: configuration-rollback
      path: /configuration/rollback
      operations:
      - name: rollbackconfiguration
        method: POST
        description: Rollback configuration changes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: JSESSIONID
      value: '{{env.TRELLIX_WEB_GATEWAY_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: rest-configuration-rest
    port: 8080
    description: REST adapter for Trellix Web Gateway REST API — Configuration. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/configuration
      name: configuration
      description: REST surface for configuration.
      operations:
      - method: GET
        name: getconfiguration
        description: Get current configuration
        call: rest-configuration.getconfiguration
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/configuration/backup
      name: configuration-backup
      description: REST surface for configuration-backup.
      operations:
      - method: POST
        name: createbackup
        description: Create a configuration backup
        call: rest-configuration.createbackup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/configuration/commit
      name: configuration-commit
      description: REST surface for configuration-commit.
      operations:
      - method: POST
        name: commitconfiguration
        description: Commit configuration changes
        call: rest-configuration.commitconfiguration
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/configuration/restore
      name: configuration-restore
      description: REST surface for configuration-restore.
      operations:
      - method: POST
        name: restorebackup
        description: Restore a configuration backup
        call: rest-configuration.restorebackup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/configuration/rollback
      name: configuration-rollback
      description: REST surface for configuration-rollback.
      operations:
      - method: POST
        name: rollbackconfiguration
        description: Rollback configuration changes
        call: rest-configuration.rollbackconfiguration
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Trellix Web Gateway REST API — Configuration. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-current-configuration
      description: Get current configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-configuration.getconfiguration
      outputParameters:
      - type: object
        mapping: $.
    - name: create-configuration-backup
      description: Create a configuration backup
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-configuration.createbackup
      outputParameters:
      - type: object
        mapping: $.
    - name: commit-configuration-changes
      description: Commit configuration changes
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-configuration.commitconfiguration
      outputParameters:
      - type: object
        mapping: $.
    - name: restore-configuration-backup
      description: Restore a configuration backup
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-configuration.restorebackup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rollback-configuration-changes
      description: Rollback configuration changes
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-configuration.rollbackconfiguration
      outputParameters:
      - type: object
        mapping: $.