Palo Alto Networks AIOps for NGFW BPA API — BPA Reports

naftiko: 1.0.0-alpha2
info:
  label: Palo Alto Networks AIOps for NGFW BPA API — BPA Reports
  description: 'Palo Alto Networks AIOps for NGFW BPA API — BPA Reports. 2 operations. Lead operation: Palo Alto Networks
    Get BPA Report. Self-contained Naftiko capability covering one Palo Alto Networks business surface.'
  tags:
  - Palo Alto Networks
  - BPA Reports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PALO_ALTO_NETWORKS_API_KEY: PALO_ALTO_NETWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: palo-alto-aiops-ngfw-bpa-bpa-reports
    baseUri: https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1
    description: Palo Alto Networks AIOps for NGFW BPA API — BPA Reports business capability. Self-contained, no shared references.
    resources:
    - name: reports-report_id
      path: /reports/{report_id}
      operations:
      - name: getbpareport
        method: GET
        description: Palo Alto Networks Get BPA Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: report_id
          in: path
          type: string
          description: Unique identifier of the BPA report.
          required: true
    - name: reports-report_id-checks
      path: /reports/{report_id}/checks
      operations:
      - name: getbpareportchecks
        method: GET
        description: Palo Alto Networks Get BPA Report Check Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: report_id
          in: path
          type: string
          description: Unique identifier of the BPA report.
          required: true
        - name: category
          in: query
          type: string
          description: Filter checks by best practice category.
        - name: status
          in: query
          type: string
          description: Filter checks by result status.
        - name: offset
          in: query
          type: integer
          description: Number of results to skip for pagination.
        - name: limit
          in: query
          type: integer
          description: Maximum number of checks to return.
    authentication:
      type: bearer
      token: '{{env.PALO_ALTO_NETWORKS_API_KEY}}'
  exposes:
  - type: rest
    namespace: palo-alto-aiops-ngfw-bpa-bpa-reports-rest
    port: 8080
    description: REST adapter for Palo Alto Networks AIOps for NGFW BPA API — BPA Reports. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/reports/{report-id}
      name: reports-report-id
      description: REST surface for reports-report_id.
      operations:
      - method: GET
        name: getbpareport
        description: Palo Alto Networks Get BPA Report
        call: palo-alto-aiops-ngfw-bpa-bpa-reports.getbpareport
        with:
          report_id: rest.report_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/reports/{report-id}/checks
      name: reports-report-id-checks
      description: REST surface for reports-report_id-checks.
      operations:
      - method: GET
        name: getbpareportchecks
        description: Palo Alto Networks Get BPA Report Check Details
        call: palo-alto-aiops-ngfw-bpa-bpa-reports.getbpareportchecks
        with:
          report_id: rest.report_id
          category: rest.category
          status: rest.status
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: palo-alto-aiops-ngfw-bpa-bpa-reports-mcp
    port: 9090
    transport: http
    description: MCP adapter for Palo Alto Networks AIOps for NGFW BPA API — BPA Reports. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: palo-alto-networks-get-bpa
      description: Palo Alto Networks Get BPA Report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: palo-alto-aiops-ngfw-bpa-bpa-reports.getbpareport
      with:
        report_id: tools.report_id
      outputParameters:
      - type: object
        mapping: $.
    - name: palo-alto-networks-get-bpa-2
      description: Palo Alto Networks Get BPA Report Check Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: palo-alto-aiops-ngfw-bpa-bpa-reports.getbpareportchecks
      with:
        report_id: tools.report_id
        category: tools.category
        status: tools.status
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.