---
title: "Request vulnerabilities related to a PURL"
method: GET
path: "/purl"
tags: ["endpoints"]
---

# Request vulnerabilities related to a PURL

`GET /purl`

## Request

- Base URL: `https://api.vulncheck.com/v3`
- URL: `https://api.vulncheck.com/v3/purl`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/vulncheck/apis/vulncheck-api/docs/purl/get.ts> (a function with typed inputs; its response is checked against the schema)

Based on the specified PURL, this endpoint will return a list of vulnerabilities that are related to the package. We currently support hex, golang, hackage, npm, and pypi

## Query parameters

- `purl` string, required

## Response `200`

OK

- RenderResponseWithMetadataV3controllersPurlResponseDataV3controllersPurlResponseMetadata
  - `_benchmark` number: Benchmark is the server-side processing time for the request in seconds. Example: 0.122322 = approximately 122 milliseconds
  - `_meta` V3controllersPurlResponseMetadata: Meta is the metadata related to the endpoint response
    - `purl_struct` PurlPackageURLJSON: meta-data about the purl
      - `name` string
      - `namespace` string
      - `qualifiers` PurlQualifierJSON[]
        - `key` string
        - `value` string
      - `subpath` string
      - `type` string
      - `version` string
    - `timestamp` string: time of the transaction
    - `total_documents` integer: number of results found
  - `data` V3controllersPurlResponseData: Data is the data returned by the endpoint
    - `cves` string[]: list of associated CVE 's
    - `vulnerabilities` ApiOSSPackageVulnerability[]: list of associated vulnerabilities
      - `detection` string
      - `fixed_version` string

## Other responses

- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/vulncheck/apis/vulncheck-api.md) - [All operations](https://skmtc.dev/vulncheck/apis/vulncheck-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vulncheck/apis/vulncheck-api/revisions/7c714606affe?raw)