security-copilot-plugins/postScanURLVirusTotal.yaml at main · a-imran99/security-copilot-plugins · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
openapi: 3.0.0
info:
  title: VirusTotal URL Analysis API
  version: 1.0.0
  description: |
    This API allows you to submit URLs for analysis and retrieve their reports using VirusTotal's API v3.
    - Use **POST /urls** to submit a raw URL for analysis.
servers:
  - url: https://www.virustotal.com/api/v3

paths:
  /urls:
    post:
      summary: Submit URL for Analysis
      description: Submits a URL to VirusTotal for scanning. The response includes the analysis ID.
      operationId: SubmitUrlAnalysis
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  description: The raw URL to be submitted for analysis.
                  example: https://www.kvms.org.in/
      responses:
        "200":
          description: URL submitted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: >
                          The analysis ID, which is the Base64 URL-safe (no padding) encoded version of the URL.
                        example: aHR0cHM6Ly93d3cua3Ztcy5vcmcuaW4v
                      type:
                        type: string
                        example: analysis
        "400":
          description: Bad request – invalid URL or parameters
        "401":
          description: Unauthorized – invalid or missing API key
        "500":
          description: Internal server error
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-apikey