---
title: "Query advisories"
method: GET
path: "/advisory"
tags: ["advisory"]
---

# Query advisories

`GET /advisory`

## Request

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

Query the VulnCheck v4 advisory index. Only feeds your subscription includes are searched, and naming one it doesn't include returns 402.

## Query parameters

- `name` string
- `cve_id` string
- `vendor` string
- `product` string
- `platform` string
- `version` string
- `cpe` string
- `package_name` string
- `purl` string
- `reference_url` string
- `reference_tag` string
- `description_lang` string
- `updatedAfter` string
- `updatedBefore` string
- `page` integer
- `limit` integer
- `start_cursor` string
- `cursor` string

## Response `200`

OK

- SearchV4AdvisoryReturnValue
  - `_meta` SearchV4AdvisoryMeta
    - `cursor` string
    - `filtered` integer
    - `limit` integer
    - `next_cursor` string
    - `page` integer
    - `pages` integer
    - `total` integer
  - `data` AdvisoryMitreCVEListV5Ref[]
    - `containers` AdvisoryMContainers
      - `adp` AdvisoryADPContainer[]
        - `affected` AdvisoryMAffected[]
          - `collectionURL` string
          - `cpes` string[]
          - `defaultStatus` string
          - `modules` string[]
          - `packageName` string
          - `packageURL` string
          - `platforms` string[]
          - `product` string
          - `programFiles` string[]
          - `programRoutines` AdvisoryProgramRoutine[]
            - `name` string
          - `repo` string
          - `vendor` string
          - `versions` AdvisoryMVersion[]
            - `changes` AdvisoryVersionChange[]
              - …
            - `lessThan` string
            - `lessThanOrEqual` string
            - `status` string
            - `version` string
            - `versionType` string
        - `configurations` AdvisoryMDescriptions[]
          - `lang` string
          - `value` string
        - `cpeApplicability` AdvisoryCustomCPE[]
          - `mcpeapplicability` AdvisoryMCPEApplicability
            - `negate` boolean
            - `nodes` AdvisoryMNodes[]
              - …
            - `operator` string
          - `stringValue` string
        - `credits` AdvisoryCredit[]
          - `lang` string
          - `type` string
          - `user` string
          - `value` string
        - `datePublic` string
        - `descriptions` AdvisoryMDescriptions[]
          - `lang` string
          - `value` string
        - `exploits` AdvisoryMDescriptions[]
          - `lang` string
          - `value` string
        - `impacts` AdvisoryImpact[]
          - `capecId` string
          - `descriptions` AdvisoryMDescriptions[]
            - `lang` string
            - `value` string
        - `metrics` AdvisoryMetric[]
          - `cvssV2_0` AdvisoryMCvssV20
            - `accessVector` string
            - `attackComplexity` string
            - `authentication` string
            - `availabilityImpact` string
            - `baseScore` number
            - `confidentialityImpact` string
            - `integrityImpact` string
            - `vectorString` string
            - `version` string
          - `cvssV3_0` AdvisoryMCvssV30
            - `attackComplexity` string
            - `attackVector` string
            - `availabilityImpact` string
            - `baseScore` number
            - `baseSeverity` string
            - `confidentialityImpact` string
            - `integrityImpact` string
            - `privilegesRequired` string
            - `scope` string
            - `userInteraction` string
            - `vectorString` string
            - `version` string
          - `cvssV3_1` AdvisoryMCvssV31
            - `attackComplexity` string
            - `attackVector` string
            - `availabilityImpact` string
            - `baseScore` number
            - `baseSeverity` string
            - `confidentialityImpact` string
            - `integrityImpact` string
            - `privilegesRequired` string
            - `scope` string
            - `userInteraction` string
            - `vectorString` string
            - `version` string
          - `cvssV4_0` AdvisoryMCvssV40
            - `attackComplexity` string
            - `attackRequirements` string
            - `attackVector` string
            - `automatable` string
            - `baseScore` number
            - `baseSeverity` string
            - `privilegesRequired` string
            - `providerUrgency` string
            - `recovery` string
            - `safety` string
            - `subAvailabilityImpact` string
            - `subConfidentialityImpact` string
            - `subIntegrityImpact` string
            - `userInteraction` string
            - `valueDensity` string
            - `vectorString` string
            - `version` string
            - `vulnAvailabilityImpact` string
            - `vulnConfidentialityImpact` string
            - `vulnIntegrityImpact` string
            - `vulnerabilityResponseEffort` string
          - `format` string
          - `other` AdvisoryMetricsOther
            - `content` object
            - `type` string
          - `scenarios` AdvisoryMetricScenario[]
            - `lang` string
            - `value` string
        - `problemTypes` AdvisoryMProblemTypes[]
          - `descriptions` AdvisoryPTMDescriptions[]
            - `cweId` string
            - `description` string
            - `lang` string
            - `references` AdvisoryMReference[]
              - …
            - `type` string
        - `providerMetadata` AdvisoryMProviderMetadata
          - `dateUpdated` string: FIXME: flip to time
          - `orgId` string
          - `shortName` string
        - `references` AdvisoryMReference[]
          - `name` string
          - `tags` string[]
          - `url` string
        - `solutions` AdvisoryMDescriptions[]
          - `lang` string
          - `value` string
        - `source` object
        - `tags` string[]
        - `taxonomyMappings` AdvisoryTaxonomyMapping[]
          - `taxonomyName` string
          - `taxonomyRelations` AdvisoryTaxonomyRelation[]
            - `relationshipName` string
            - `relationshipValue` string
            - `taxonomyId` string
          - `taxonomyVersion` string
        - `timeline` AdvisoryTimeline[]
          - `lang` string
          - `time` string: FIXME: flip to time
          - `value` string
        - `title` string
        - `workarounds` AdvisoryMDescriptions[]
          - `lang` string
          - `value` string
      - `cna` AdvisoryMCna
        - `affected` AdvisoryMAffected[]
          - `collectionURL` string
          - `cpes` string[]
          - `defaultStatus` string
          - `modules` string[]
          - `packageName` string
          - `packageURL` string
          - `platforms` string[]
          - `product` string
          - `programFiles` string[]
          - `programRoutines` AdvisoryProgramRoutine[]
            - `name` string
          - `repo` string
          - `vendor` string
          - `versions` AdvisoryMVersion[]
            - `changes` AdvisoryVersionChange[]
              - …
            - `lessThan` string
            - `lessThanOrEqual` string
            - `status` string
            - `version` string
            - `versionType` string
        - `configurations` AdvisoryMDescriptions[]
          - `lang` string
          - `value` string
        - `cpeApplicability` AdvisoryCustomCPE[]
          - `mcpeapplicability` AdvisoryMCPEApplicability
            - `negate` boolean
            - `nodes` AdvisoryMNodes[]
              - …
            - `operator` string
          - `stringValue` string
        - `credits` AdvisoryCredit[]
          - `lang` string
          - `type` string
          - `user` string
          - `value` string
        - `dateAssigned` string
        - `datePublic` string
        - `descriptions` AdvisoryMDescriptions[]
          - `lang` string
          - `value` string
        - `exploits` AdvisoryMDescriptions[]
          - `lang` string
          - `value` string
        - `impacts` AdvisoryImpact[]
          - `capecId` string
          - `descriptions` AdvisoryMDescriptions[]
            - `lang` string
            - `value` string
        - `metrics` AdvisoryMetric[]
          - `cvssV2_0` AdvisoryMCvssV20
            - `accessVector` string
            - `attackComplexity` string
            - `authentication` string
            - `availabilityImpact` string
            - `baseScore` number
            - `confidentialityImpact` string
            - `integrityImpact` string
            - `vectorString` string
            - `version` string
          - `cvssV3_0` AdvisoryMCvssV30
            - `attackComplexity` string
            - `attackVector` string
            - `availabilityImpact` string
            - `baseScore` number
            - `baseSeverity` string
            - `confidentialityImpact` string
            - `integrityImpact` string
            - `privilegesRequired` string
            - `scope` string
            - `userInteraction` string
            - `vectorString` string
            - `version` string
          - `cvssV3_1` AdvisoryMCvssV31
            - `attackComplexity` string
            - `attackVector` string
            - `availabilityImpact` string
            - `baseScore` number
            - `baseSeverity` string
            - `confidentialityImpact` string
            - `integrityImpact` string
            - `privilegesRequired` string
            - `scope` string
            - `userInteraction` string
            - `vectorString` string
            - `version` string
          - `cvssV4_0` AdvisoryMCvssV40
            - `attackComplexity` string
            - `attackRequirements` string
            - `attackVector` string
            - `automatable` string
            - `baseScore` number
            - `baseSeverity` string
            - `privilegesRequired` string
            - `providerUrgency` string
            - `recovery` string
            - `safety` string
            - `subAvailabilityImpact` string
            - `subConfidentialityImpact` string
            - `subIntegrityImpact` string
            - `userInteraction` string
            - `valueDensity` string
            - `vectorString` string
            - `version` string
            - `vulnAvailabilityImpact` string
            - `vulnConfidentialityImpact` string
            - `vulnIntegrityImpact` string
            - `vulnerabilityResponseEffort` string
          - `format` string
          - `other` AdvisoryMetricsOther
            - `content` object
            - `type` string
          - `scenarios` AdvisoryMetricScenario[]
            - `lang` string
            - `value` string
        - `problemTypes` AdvisoryMProblemTypes[]
          - `descriptions` AdvisoryPTMDescriptions[]
            - `cweId` string
            - `description` string
            - `lang` string
            - `references` AdvisoryMReference[]
              - …
            - `type` string
        - `providerMetadata` AdvisoryMProviderMetadata
          - `dateUpdated` string: FIXME: flip to time
          - `orgId` string
          - `shortName` string
        - `references` AdvisoryMReference[]
          - `name` string
          - `tags` string[]
          - `url` string
        - `rejectedReasons` AdvisoryMDescriptions[]: Fields below appear only on rejected records (cveMetadata.state == "REJECTED").
          - `lang` string
          - `value` string
        - `replacedBy` string[]
        - `solutions` AdvisoryMDescriptions[]
          - `lang` string
          - `value` string
        - `source` object
        - `tags` string[]
        - `taxonomyMappings` AdvisoryTaxonomyMapping[]
          - `taxonomyName` string
          - `taxonomyRelations` AdvisoryTaxonomyRelation[]
            - `relationshipName` string
            - `relationshipValue` string
            - `taxonomyId` string
          - `taxonomyVersion` string
        - `timeline` AdvisoryTimeline[]
          - `lang` string
          - `time` string: FIXME: flip to time
          - `value` string
        - `title` string
        - `workarounds` AdvisoryMDescriptions[]
          - `lang` string
          - `value` string
    - `cveMetadata` AdvisoryMCveMetadata
      - `assignerOrgId` string
      - `assignerShortName` string
      - `cveId` string
      - `datePublished` string
      - `dateRejected` string
      - `dateReserved` string
      - `dateUpdated` string
      - `requesterUserId` string
      - `serial` integer
      - `state` string
    - `dataType` string
    - `dataVersion` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `402`: Payment Required
- `503`: Service Unavailable

---

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