Docs
View as Markdown

github.advisory

stable Standard

One GitHub security advisory by GHSA id.

GET /v1/github/advisory

What you get#

One GitHub record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

  • Standard · 1 credit for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
ghsastringyes(required)GHSA idmax 19 chars; must match GHSA(?:-[a-z0-9]{4}){3}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/github/advisory?ghsa=GHSA-9wx4-h78v-vm56" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real GitHub response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "content": {
      "id": "GHSA-9wx4-h78v-vm56",
      "title": "Requests `Session` object does not verify requests after making first request with verify=False",
      "url": "https://github.com/advisories/GHSA-9wx4-h78v-vm56",
      "createdAt": "2024-05-20T20:15:00Z",
      "text": "When using a `requests.Session`, if the first request to a given origin is made with `verify=False`, TLS certificate verification may remain disabled for all subsequent requests to that origin, even if `verify=True` is explicitly specified later.\n\nThis occurs because the underlying connection is reused from the session's connection pool, causing the initial TLS verification setting to persist for the lifetime of the pooled connection. As a result, applications may unintentionally send requests without certificate verification, leading to potential man-in-the-middle attacks and compromised confidentiality or integrity.\n\nThis behavior affects versions of `requests` prior to 2.32.0."
    },
    "ext": {
      "severity": "medium",
      "cveId": "CVE-2024-35195",
      "cvss": 5.6,
      "vulnerabilities": [
        {
          "package": {
            "ecosystem": "pip",
            "name": "requests"
          },
          "vulnerable_version_range": "< 2.32.0",
          "first_patched_version": "2.32.0",
          "vulnerable_functions": []
        }
      ]
    }
  },
  "metadata": {
    "platform": "github",
    "endpoint": "advisory",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
ghsa_idcontent.id-
summarycontent.title-
html_urlcontent.urlsafeUrl
published_atcontent.createdAttoIsoDate
severityext.severity-
cve_idext.cveId-
cvss.scoreext.cvsstoNumber
descriptioncontent.text-
vulnerabilitiesext.vulnerabilities-

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).