Commvault REST API — Plans

naftiko: 1.0.0-alpha2
info:
  label: Commvault REST API — Plans
  description: 'Commvault REST API — Plans. 5 operations. Lead operation: Commvault List server plans. Self-contained Naftiko
    capability covering one Commvault business surface.'
  tags:
  - Commvault
  - Plans
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COMMVAULT_API_KEY: COMMVAULT_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-plans
    baseUri: https://{webserver}/webconsole/api
    description: Commvault REST API — Plans business capability. Self-contained, no shared references.
    resources:
    - name: V4-ServerPlan
      path: /V4/ServerPlan
      operations:
      - name: listplans
        method: GET
        description: Commvault List server plans
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createplan
        method: POST
        description: Commvault Create a server plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: V4-ServerPlan-planId
      path: /V4/ServerPlan/{planId}
      operations:
      - name: getplan
        method: GET
        description: Commvault Get server plan details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateplan
        method: PUT
        description: Commvault Update a server plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteplan
        method: DELETE
        description: Commvault Delete a server plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authtoken
      value: '{{env.COMMVAULT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-plans-rest
    port: 8080
    description: REST adapter for Commvault REST API — Plans. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v4/serverplan
      name: v4-serverplan
      description: REST surface for V4-ServerPlan.
      operations:
      - method: GET
        name: listplans
        description: Commvault List server plans
        call: rest-plans.listplans
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createplan
        description: Commvault Create a server plan
        call: rest-plans.createplan
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v4/serverplan/{planid}
      name: v4-serverplan-planid
      description: REST surface for V4-ServerPlan-planId.
      operations:
      - method: GET
        name: getplan
        description: Commvault Get server plan details
        call: rest-plans.getplan
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateplan
        description: Commvault Update a server plan
        call: rest-plans.updateplan
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteplan
        description: Commvault Delete a server plan
        call: rest-plans.deleteplan
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-plans-mcp
    port: 9090
    transport: http
    description: MCP adapter for Commvault REST API — Plans. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: commvault-list-server-plans
      description: Commvault List server plans
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-plans.listplans
      outputParameters:
      - type: object
        mapping: $.
    - name: commvault-create-server-plan
      description: Commvault Create a server plan
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-plans.createplan
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: commvault-get-server-plan-details
      description: Commvault Get server plan details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-plans.getplan
      outputParameters:
      - type: object
        mapping: $.
    - name: commvault-update-server-plan
      description: Commvault Update a server plan
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-plans.updateplan
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: commvault-delete-server-plan
      description: Commvault Delete a server plan
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-plans.deleteplan
      outputParameters:
      - type: object
        mapping: $.