VirusTotal API v3 - Private Scanning — Private Scanning - URLs

naftiko: 1.0.0-alpha2
info:
  label: VirusTotal API v3 - Private Scanning — Private Scanning - URLs
  description: 'VirusTotal API v3 - Private Scanning — Private Scanning - URLs. 4 operations. Lead operation: Private Scan URL. Self-contained Naftiko capability covering one VirusTotal business surface.'
  tags:
  - VirusTotal
  - Private Scanning
  - URLs
  created: '2026-05-29'
  modified: '2026-05-29'
binds:
- namespace: env
  keys:
    VIRUSTOTAL_API_KEY: VIRUSTOTAL_API_KEY
capability:
  consumes:
  - type: http
    namespace: private-scanning-private-scanning-urls
    baseUri: https://www.virustotal.com/api/v3
    description: VirusTotal API v3 - Private Scanning — Private Scanning - URLs. Self-contained, no shared references.
    authentication:
      type: apikey
      key: x-apikey
      value: '{{env.VIRUSTOTAL_API_KEY}}'
      placement: header
    resources:
    - name: private-urls
      path: /private/urls
      operations:
      - name: privateScanUrl
        method: POST
        description: VirusTotal Private Scan URL
        inputParameters:
        - name: body
          in: body
          type: object
          required: false
          description: Request body payload.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: private-urls-id
      path: /private/urls/{id}
      operations:
      - name: getAPrivateUrlAnalysisReport
        method: GET
        description: VirusTotal Get a URL Analysis Report
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
          description: URL identifier or base64 representation of URL to scan (w/o padding)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: private-urls-id-relationship
      path: /private/urls/{id}/{relationship}
      operations:
      - name: privateGetObjectsRelatedToAUrl
        method: GET
        description: VirusTotal Get Objects Related to a Private URL
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
          description: URL identifier
        - name: relationship
          in: path
          type: string
          required: true
          description: Relationship name (see [table](ref:private-urls-object#relationships))
        - name: limit
          in: query
          type: integer
          required: false
          description: Maximum number of related objects to retrieve
        - name: cursor
          in: query
          type: string
          required: false
          description: Continuation cursor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: private-urls-id-relationships-relationship
      path: /private/urls/{id}/relationships/{relationship}
      operations:
      - name: privateGetObjectDescriptorsRelatedToAUrl
        method: GET
        description: VirusTotal Get Object Descriptors Related to a Private URL
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
          description: URL ID
        - name: relationship
          in: path
          type: string
          required: true
          description: Relationship name (see [table](ref:private-urls-object#relationships))
        - name: limit
          in: query
          type: string
          required: false
          description: Maximum number of related objects to retrieve
        - name: cursor
          in: query
          type: string
          required: false
          description: Continuation cursor
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: private-scanning-private-scanning-urls-rest
    port: 8080
    description: REST adapter for VirusTotal API v3 - Private Scanning — Private Scanning - URLs. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/private/urls
      name: private-urls
      description: REST surface for /private/urls.
      operations:
      - method: POST
        name: privateScanUrl
        description: VirusTotal Private Scan URL
        call: private-scanning-private-scanning-urls.privateScanUrl
        outputParameters:
        - type: object
          mapping: $.
        with:
          body: rest.body
    - path: /v1/private/urls/{id}
      name: private-urls-id
      description: REST surface for /private/urls/{id}.
      operations:
      - method: GET
        name: getAPrivateUrlAnalysisReport
        description: VirusTotal Get a URL Analysis Report
        call: private-scanning-private-scanning-urls.getAPrivateUrlAnalysisReport
        outputParameters:
        - type: object
          mapping: $.
        with:
          id: rest.id
    - path: /v1/private/urls/{id}/{relationship}
      name: private-urls-id-relationship
      description: REST surface for /private/urls/{id}/{relationship}.
      operations:
      - method: GET
        name: privateGetObjectsRelatedToAUrl
        description: VirusTotal Get Objects Related to a Private URL
        call: private-scanning-private-scanning-urls.privateGetObjectsRelatedToAUrl
        outputParameters:
        - type: object
          mapping: $.
        with:
          id: rest.id
          relationship: rest.relationship
          limit: rest.limit
          cursor: rest.cursor
    - path: /v1/private/urls/{id}/relationships/{relationship}
      name: private-urls-id-relationships-relationship
      description: REST surface for /private/urls/{id}/relationships/{relationship}.
      operations:
      - method: GET
        name: privateGetObjectDescriptorsRelatedToAUrl
        description: VirusTotal Get Object Descriptors Related to a Private URL
        call: private-scanning-private-scanning-urls.privateGetObjectDescriptorsRelatedToAUrl
        outputParameters:
        - type: object
          mapping: $.
        with:
          id: rest.id
          relationship: rest.relationship
          limit: rest.limit
          cursor: rest.cursor
  - type: mcp
    namespace: private-scanning-private-scanning-urls-mcp
    port: 9090
    transport: http
    description: MCP adapter for VirusTotal API v3 - Private Scanning — Private Scanning - URLs. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: private-scan-url
      description: VirusTotal Private Scan URL
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: private-scanning-private-scanning-urls.privateScanUrl
      outputParameters:
      - type: object
        mapping: $.
      with:
        body: tools.body
    - name: get-url-analysis-report
      description: VirusTotal Get a URL Analysis Report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: private-scanning-private-scanning-urls.getAPrivateUrlAnalysisReport
      outputParameters:
      - type: object
        mapping: $.
      with:
        id: tools.id
    - name: get-objects-related-private-url
      description: VirusTotal Get Objects Related to a Private URL
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: private-scanning-private-scanning-urls.privateGetObjectsRelatedToAUrl
      outputParameters:
      - type: object
        mapping: $.
      with:
        id: tools.id
        relationship: tools.relationship
        limit: tools.limit
        cursor: tools.cursor
    - name: get-object-descriptors-related-private
      description: VirusTotal Get Object Descriptors Related to a Private URL
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: private-scanning-private-scanning-urls.privateGetObjectDescriptorsRelatedToAUrl
      outputParameters:
      - type: object
        mapping: $.
      with:
        id: tools.id
        relationship: tools.relationship
        limit: tools.limit
        cursor: tools.cursor