Trust in Protection, Trust in Us .
Guardians of Cyber Space .
Safeguarding Your Digital Identity .
Ensuring Security in the Digital Age .
Fortifying Your Cyber Defenses.
Securing Your Digital Frontier.
Documentation
Explore our comprehensive documentation to find technical guides, setup instructions, and troubleshooting resources.
Download Report

Endpoint

GET https://api.docspot.docexploit.com/reports/{analysisId}/download

Description

This endpoint allows authorized users to download a JSON file containing a list of vulnerabilities for a specified analysis.

Authentication & Authorization

Clients must provide a valid API key in the request headers to authenticate.

Headers

NameTypeRequiredDescription
x-api-keyStringYesAPI key for authentication

Path Parameters

NameTypeRequiredDescription
analysisIdStringYesThe unique identifier of the analysis

Response

Success Response

Status Code: 200 OK

Headers:

NameValue
Content-Typeapplication/json
Content-Dispositionattachment; filename=vulnerabilities.json

Body:

[
    {
        "id": "string",
        "registerDate": "timestamp",
        "analysisId": "string",
        "ruleId": "string",
        "analyzer": "string",
        "rating": {
            "cwe": { "value": "string", "version": "string" },
            "pci": { "value": "string", "version": "string" },
            "cvss": { "value": "number", "version": "string" },
            "severity": { "value": "string", "version": "string" }
        },
        "location": {
            "filename": "string",
            "line": { "start": "number", "end": "number" },
            "column": { "start": "number", "end": "number" },
            "lines": [
                { "position": "number", "code": "string" }
            ]
        }
    }
]

Error Responses

The endpoint returns only HTTP status codes without custom error messages.#### 400 Bad Request Occurs when the request parameters are invalid. Status Code: 400

401 Unauthorized

Occurs if the API key is missing or invalid. Status Code: 401

403 Forbidden

Occurs if the user does not have the required role. Status Code: 403

404 Not Found

Occurs if the specified analysisId does not exist. Status Code: 404

500 Internal Server Error

Occurs in case of an unexpected server error. Status Code: 500

Example Request

cURL

curl -X GET "https://api.docspot.docexploit.com/reports/a6d2154a-66fa-4818-a479-35ea5529d8f1/download" \
     -H "x-api-key: your-api-key-here" \
     -o vulnerabilities.json

Notes

  • Ensure that the x-api-key header is included in the request.
  • The response is a downloadable JSON file containing vulnerability details for the given analysis.
  • Only users with the ROLE_DOCSPOT_VULNERABILITY_VIEW permission can access this endpoint.
Join Our Newsletter To Get The Latest Guides
Discover the new range of specialized and disruptive tools on the market, specialized in virtualized cloud and on-premise environments.
Gran Via, 18. 26001 Logrono, La Rioja
© DocExploit
Alcance para las actividades desarrolladas en su sede de Logroño
DOCEXPLOIT SL, con CIF B67868513, ha recibido financiación por parte de la Agencia de Desarrollo Económico de La Rioja. Esta financiación ha sido solicitada a través de la convocatoria 2025 de las ayudas destinadas al fomento de Nuevas Empresas de Base Tecnológica –Programa 1: Empresas de Base Tecnológica -en el marco del Programa de Redes Territoriales de Especialización Tecnológica (RETECH)-Proyecto TechFabLab, por valor de 320.394,76 € a través del expediente 2025-I-EBT-00001, y por valor de 257.317,75 € a través del expediente 2025-I-EBT-00009.
© 2024, All Rights Reserved