GET /api/v1/docs/
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/vnd.oai.openapi
Vary: Accept

openapi: 3.0.2
info:
  title: Nmmapper Exploit API Documentation
  version: ''
  description: Nmmapper Exploit API Documentation
paths:
  /api/v1/exploits/:
    get:
      operationId: listExploits
      description: '@ API GET'
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    example: 123
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      properties:
                        url:
                          type: string
                          readOnly: true
                        download_file:
                          type: string
                          readOnly: true
                        exploit_id:
                          type: string
                          nullable: true
                        exploit_description:
                          type: string
                          nullable: true
                        exploit_date:
                          type: string
                          nullable: true
                          maxLength: 250
                        exploit_author:
                          type: string
                          nullable: true
                          maxLength: 250
                        exploit_type:
                          type: string
                          nullable: true
                          maxLength: 250
                        exploit_platform:
                          type: string
                          nullable: true
                          maxLength: 250
                        exploit_port:
                          type: string
                          nullable: true
                          maxLength: 250
          description: ''
  /api/v1/exploitdetails/{exploit_id}/:
    get:
      operationId: RetrieveAPIExploitDetails
      description: '@ expoit_id --> The ID of the exploit we want to view it''s details'
      parameters:
      - name: exploit_id
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: ''
  /api/v1/exploitauthor/{author}/:
    get:
      operationId: RetrieveFilterExploitByAuthor
      description: '@ author --> The author of the exploit we want to view it''s details'
      parameters:
      - name: author
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: ''
  /api/v1/exploitbyplatform/{platform}/:
    get:
      operationId: RetrieveExploit
      description: '@ platform --> The platform of the exploit we want to view.

        @ return Json'
      parameters:
      - name: platform
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  url:
                    type: string
                    readOnly: true
                  download_file:
                    type: string
                    readOnly: true
                  exploit_id:
                    type: string
                    nullable: true
                  exploit_description:
                    type: string
                    nullable: true
                  exploit_date:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_author:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_type:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_platform:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_port:
                    type: string
                    nullable: true
                    maxLength: 250
          description: ''
  /api/v1/exploitbytype/{exploit_type}/:
    get:
      operationId: RetrieveExploit
      description: '@ platform --> The platform of the exploit we want to view.

        @ return Json'
      parameters:
      - name: exploit_type
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  url:
                    type: string
                    readOnly: true
                  download_file:
                    type: string
                    readOnly: true
                  exploit_id:
                    type: string
                    nullable: true
                  exploit_description:
                    type: string
                    nullable: true
                  exploit_date:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_author:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_type:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_platform:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_port:
                    type: string
                    nullable: true
                    maxLength: 250
          description: ''
  /api/v1/exploitbydate/{exploit_date}/:
    get:
      operationId: RetrieveExploit
      description: '@ exploit_date --> Specific date of this exploit.

        @ return Json'
      parameters:
      - name: exploit_date
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  url:
                    type: string
                    readOnly: true
                  download_file:
                    type: string
                    readOnly: true
                  exploit_id:
                    type: string
                    nullable: true
                  exploit_description:
                    type: string
                    nullable: true
                  exploit_date:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_author:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_type:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_platform:
                    type: string
                    nullable: true
                    maxLength: 250
                  exploit_port:
                    type: string
                    nullable: true
                    maxLength: 250
          description: ''