Commvault Automation API — Workflows

naftiko: 1.0.0-alpha2
info:
  label: Commvault Automation API — Workflows
  description: 'Commvault Automation API — Workflows. 5 operations. Lead operation: Commvault List all workflows. Self-contained
    Naftiko capability covering one Commvault business surface.'
  tags:
  - Commvault
  - Workflows
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COMMVAULT_API_KEY: COMMVAULT_API_KEY
capability:
  consumes:
  - type: http
    namespace: automation-workflows
    baseUri: https://{webserver}/webconsole/api
    description: Commvault Automation API — Workflows business capability. Self-contained, no shared references.
    resources:
    - name: Workflow
      path: /Workflow
      operations:
      - name: listworkflows
        method: GET
        description: Commvault List all workflows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: Workflow-Deploy
      path: /Workflow/Deploy
      operations:
      - name: deployworkflow
        method: POST
        description: Commvault Deploy a workflow definition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: Workflow-workflowId
      path: /Workflow/{workflowId}
      operations:
      - name: getworkflow
        method: GET
        description: Commvault Get workflow details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteworkflow
        method: DELETE
        description: Commvault Delete a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: Workflow-workflowName-Action-Execute
      path: /Workflow/{workflowName}/Action/Execute
      operations:
      - name: executeworkflow
        method: POST
        description: Commvault Execute a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowName
          in: path
          type: string
          description: Name of the workflow to execute
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authtoken
      value: '{{env.COMMVAULT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: automation-workflows-rest
    port: 8080
    description: REST adapter for Commvault Automation API — Workflows. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/workflow
      name: workflow
      description: REST surface for Workflow.
      operations:
      - method: GET
        name: listworkflows
        description: Commvault List all workflows
        call: automation-workflows.listworkflows
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflow/deploy
      name: workflow-deploy
      description: REST surface for Workflow-Deploy.
      operations:
      - method: POST
        name: deployworkflow
        description: Commvault Deploy a workflow definition
        call: automation-workflows.deployworkflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflow/{workflowid}
      name: workflow-workflowid
      description: REST surface for Workflow-workflowId.
      operations:
      - method: GET
        name: getworkflow
        description: Commvault Get workflow details
        call: automation-workflows.getworkflow
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteworkflow
        description: Commvault Delete a workflow
        call: automation-workflows.deleteworkflow
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflow/{workflowname}/action/execute
      name: workflow-workflowname-action-execute
      description: REST surface for Workflow-workflowName-Action-Execute.
      operations:
      - method: POST
        name: executeworkflow
        description: Commvault Execute a workflow
        call: automation-workflows.executeworkflow
        with:
          workflowName: rest.workflowName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: automation-workflows-mcp
    port: 9090
    transport: http
    description: MCP adapter for Commvault Automation API — Workflows. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: commvault-list-all-workflows
      description: Commvault List all workflows
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: automation-workflows.listworkflows
      outputParameters:
      - type: object
        mapping: $.
    - name: commvault-deploy-workflow-definition
      description: Commvault Deploy a workflow definition
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: automation-workflows.deployworkflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: commvault-get-workflow-details
      description: Commvault Get workflow details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: automation-workflows.getworkflow
      outputParameters:
      - type: object
        mapping: $.
    - name: commvault-delete-workflow
      description: Commvault Delete a workflow
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: automation-workflows.deleteworkflow
      outputParameters:
      - type: object
        mapping: $.
    - name: commvault-execute-workflow
      description: Commvault Execute a workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: automation-workflows.executeworkflow
      with:
        workflowName: tools.workflowName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.