InsightVM API — Policy Override

naftiko: 1.0.0-alpha2
info:
  label: InsightVM API — Policy Override
  description: 'InsightVM API — Policy Override. 8 operations. Lead operation: Asset Policy Overrides. Self-contained Naftiko capability covering one business surface.'
  tags:
  - Rapid7
  - Policy Override
  created: '2026-05-20'
  modified: '2026-05-20'
binds:
- namespace: env
  keys:
    RAPID7_API_KEY: RAPID7_API_KEY
capability:
  consumes:
  - type: http
    namespace: insightvm-console-swagger-policy-override
    baseUri: https://localhost:3780
    description: InsightVM API — Policy Override business capability. Self-contained, no shared references.
    resources:
    - name: api-3-assets-id-policy-overrides
      path: /api/3/assets/{id}/policy_overrides
      operations:
      - name: getassetpolicyoverrides
        method: GET
        description: Asset Policy Overrides
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The identifier of the asset.
          required: true
    - name: api-3-policy-overrides
      path: /api/3/policy_overrides
      operations:
      - name: getpolicyoverrides
        method: GET
        description: Policy Overrides
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
          description: The index of the page (zero-based) to retrieve.
        - name: size
          in: query
          type: integer
          description: The number of records per page to retrieve.
        - name: sort
          in: query
          type: array
          description: 'The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.'
      - name: createpolicyoverride
        method: POST
        description: Policy Overrides
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: policyOverride
          in: body
          type: string
          description: The specification of a policy override. Allows users to override the compliance result of a policy rule.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-3-policy-overrides-id
      path: /api/3/policy_overrides/{id}
      operations:
      - name: getpolicyoverride
        method: GET
        description: Policy Override
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The identifier of the policy override.
          required: true
      - name: deletepolicyoverride
        method: DELETE
        description: Policy Override
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The identifier of the policy override.
          required: true
    - name: api-3-policy-overrides-id-expires
      path: /api/3/policy_overrides/{id}/expires
      operations:
      - name: getpolicyoverrideexpiration
        method: GET
        description: Policy Override Expiration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The identifier of the policy override.
          required: true
      - name: setpolicyoverrideexpiration
        method: PUT
        description: Policy Override Expiration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The identifier of the policy override.
          required: true
        - name: expiration
          in: body
          type: string
          description: The date the policy override is set to expire. Date is represented in ISO 8601 format.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-3-policy-overrides-id-status
      path: /api/3/policy_overrides/{id}/{status}
      operations:
      - name: setpolicyoverridestatus
        method: POST
        description: Policy Override Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The identifier of the policy override.
          required: true
        - name: status
          in: path
          type: string
          description: Policy Override Status
          required: true
        - name: comment
          in: body
          type: string
          description: A comment describing the change of the policy override status.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: insightvm-console-swagger-policy-override-rest
    port: 8080
    description: REST adapter for InsightVM API — Policy Override. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/assets/{id}/policy_overrides
      name: api-3-assets-id-policy-overrides
      description: REST surface for api-3-assets-id-policy-overrides.
      operations:
      - method: GET
        name: getassetpolicyoverrides
        description: Asset Policy Overrides
        call: insightvm-console-swagger-policy-override.getassetpolicyoverrides
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/policy_overrides
      name: api-3-policy-overrides
      description: REST surface for api-3-policy-overrides.
      operations:
      - method: GET
        name: getpolicyoverrides
        description: Policy Overrides
        call: insightvm-console-swagger-policy-override.getpolicyoverrides
        with:
          page: rest.page
          size: rest.size
          sort: rest.sort
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpolicyoverride
        description: Policy Overrides
        call: insightvm-console-swagger-policy-override.createpolicyoverride
        with:
          policyOverride: rest.policyOverride
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/policy_overrides/{id}
      name: api-3-policy-overrides-id
      description: REST surface for api-3-policy-overrides-id.
      operations:
      - method: GET
        name: getpolicyoverride
        description: Policy Override
        call: insightvm-console-swagger-policy-override.getpolicyoverride
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletepolicyoverride
        description: Policy Override
        call: insightvm-console-swagger-policy-override.deletepolicyoverride
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/policy_overrides/{id}/expires
      name: api-3-policy-overrides-id-expires
      description: REST surface for api-3-policy-overrides-id-expires.
      operations:
      - method: GET
        name: getpolicyoverrideexpiration
        description: Policy Override Expiration
        call: insightvm-console-swagger-policy-override.getpolicyoverrideexpiration
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: setpolicyoverrideexpiration
        description: Policy Override Expiration
        call: insightvm-console-swagger-policy-override.setpolicyoverrideexpiration
        with:
          id: rest.id
          expiration: rest.expiration
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/policy_overrides/{id}/{status}
      name: api-3-policy-overrides-id-status
      description: REST surface for api-3-policy-overrides-id-status.
      operations:
      - method: POST
        name: setpolicyoverridestatus
        description: Policy Override Status
        call: insightvm-console-swagger-policy-override.setpolicyoverridestatus
        with:
          id: rest.id
          status: rest.status
          comment: rest.comment
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: insightvm-console-swagger-policy-override-mcp
    port: 9090
    transport: http
    description: MCP adapter for InsightVM API — Policy Override. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: rapid7-getassetpolicyoverrides
      description: Asset Policy Overrides
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-policy-override.getassetpolicyoverrides
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-getpolicyoverrides
      description: Policy Overrides
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-policy-override.getpolicyoverrides
      with:
        page: tools.page
        size: tools.size
        sort: tools.sort
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-createpolicyoverride
      description: Policy Overrides
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: insightvm-console-swagger-policy-override.createpolicyoverride
      with:
        policyOverride: tools.policyOverride
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-getpolicyoverride
      description: Policy Override
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-policy-override.getpolicyoverride
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-deletepolicyoverride
      description: Policy Override
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: insightvm-console-swagger-policy-override.deletepolicyoverride
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-getpolicyoverrideexpiration
      description: Policy Override Expiration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-policy-override.getpolicyoverrideexpiration
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-setpolicyoverrideexpiration
      description: Policy Override Expiration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-policy-override.setpolicyoverrideexpiration
      with:
        id: tools.id
        expiration: tools.expiration
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-setpolicyoverridestatus
      description: Policy Override Status
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: insightvm-console-swagger-policy-override.setpolicyoverridestatus
      with:
        id: tools.id
        status: tools.status
        comment: tools.comment
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.