InsightVM API — Administration

naftiko: 1.0.0-alpha2
info:
  label: InsightVM API — Administration
  description: 'InsightVM API — Administration. 6 operations. Lead operation: Information. Self-contained Naftiko capability covering one business surface.'
  tags:
  - Rapid7
  - Administration
  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-administration
    baseUri: https://localhost:3780
    description: InsightVM API — Administration business capability. Self-contained, no shared references.
    resources:
    - name: api-3-administration-commands
      path: /api/3/administration/commands
      operations:
      - name: executecommand
        method: POST
        description: Console Commands
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: command
          in: body
          type: string
          description: The console command to execute.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-3-administration-info
      path: /api/3/administration/info
      operations:
      - name: getinfo
        method: GET
        description: Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    - name: api-3-administration-license
      path: /api/3/administration/license
      operations:
      - name: getlicense
        method: GET
        description: License
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
      - name: activatelicense
        method: POST
        description: License
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: license
          in: formData
          type: string
          description: The contents of a license (.lic) file.
        - name: key
          in: query
          type: string
          description: A license activation key.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-3-administration-properties
      path: /api/3/administration/properties
      operations:
      - name: getproperties
        method: GET
        description: Properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
    - name: api-3-administration-settings
      path: /api/3/administration/settings
      operations:
      - name: getsettings
        method: GET
        description: Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
  exposes:
  - type: rest
    namespace: insightvm-console-swagger-administration-rest
    port: 8080
    description: REST adapter for InsightVM API — Administration. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/administration/commands
      name: api-3-administration-commands
      description: REST surface for api-3-administration-commands.
      operations:
      - method: POST
        name: executecommand
        description: Console Commands
        call: insightvm-console-swagger-administration.executecommand
        with:
          command: rest.command
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/administration/info
      name: api-3-administration-info
      description: REST surface for api-3-administration-info.
      operations:
      - method: GET
        name: getinfo
        description: Information
        call: insightvm-console-swagger-administration.getinfo
        with: {}
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/administration/license
      name: api-3-administration-license
      description: REST surface for api-3-administration-license.
      operations:
      - method: GET
        name: getlicense
        description: License
        call: insightvm-console-swagger-administration.getlicense
        with: {}
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: activatelicense
        description: License
        call: insightvm-console-swagger-administration.activatelicense
        with:
          license: rest.license
          key: rest.key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/administration/properties
      name: api-3-administration-properties
      description: REST surface for api-3-administration-properties.
      operations:
      - method: GET
        name: getproperties
        description: Properties
        call: insightvm-console-swagger-administration.getproperties
        with: {}
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/administration/settings
      name: api-3-administration-settings
      description: REST surface for api-3-administration-settings.
      operations:
      - method: GET
        name: getsettings
        description: Settings
        call: insightvm-console-swagger-administration.getsettings
        with: {}
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: insightvm-console-swagger-administration-mcp
    port: 9090
    transport: http
    description: MCP adapter for InsightVM API — Administration. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: rapid7-executecommand
      description: Console Commands
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: insightvm-console-swagger-administration.executecommand
      with:
        command: tools.command
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-getinfo
      description: Information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-administration.getinfo
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-getlicense
      description: License
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-administration.getlicense
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-activatelicense
      description: License
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: insightvm-console-swagger-administration.activatelicense
      with:
        license: tools.license
        key: tools.key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-getproperties
      description: Properties
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-administration.getproperties
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-getsettings
      description: Settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightvm-console-swagger-administration.getsettings
      with: {}
      outputParameters:
      - type: object
        mapping: $.