Retrieve a vulnerability

get

https://sentinel.whitehatsec.com/api/source_vuln/{vuln_id}

This operation returns an object containing information about the specified vulnerability.

Path Params

vuln_id

int32

required

Vulnerability id.

Query Params

display_traces

string

enum

Defaults to 1

Display traces data collection for this vulnerability.

Allowed:

display_steps

string

enum

Defaults to 0

Display step data associated with each trace for this vuln (data-intensive - can take significant time to fetch).

Allowed:

display_description

string

enum

Defaults to 0

Display general information about vulnerability. The 'custom' option will display custom descriptions.

Allowed:

display_solution

string

enum

Defaults to 0

Display general vulnerability solution information. The 'custom' option will display custom solutions.

Allowed:

display_patch_count

string

enum

Defaults to 1

To get faster results, set this flag to 0, which omits patch counts for vulnerabilities. Unless this flag is present and set to 0, patch counts will be fetched.

Allowed:

page:limit

int32

Limit results to n number of pages.

page:offset

int32

Begin showing results from page number n.

format

string

enum

Defaults to xml

Format of returned results.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

BadRequestResponse indicates a request with invalid parameters.

401

UnauthorizedResponse signals an unauthorized API access.

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized.

404

NotFound the requested resource could not be found.

500

GenericError generic error.

Language

Response

Choose an example:

application/json

application/xml

text/csv, text/comma-separated-values

200Provides the information of particular vulnerability.