{ "openapi": "3.0.1", "info": { "title": "GitHub Security Advisories Scraper (GHSA, CVE, CVSS)", "description": "Scrape the GitHub Global Security Advisory database. Extract GHSA & CVE IDs, severity, CVSS score+vector, CWEs, affected packages, patched versions and references. Optional OSV.dev cross-reference and AI remediation. JSON, CSV, Excel.", "version": "0.1", "x-build-id": "9HM6bxQaAWhgXBdy6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~github-security-advisories-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-github-security-advisories-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/scrapers_lat~github-security-advisories-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-github-security-advisories-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/scrapers_lat~github-security-advisories-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-github-security-advisories-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "ecosystem": { "title": "Ecosystem", "enum": [ "", "npm", "pip", "rubygems", "maven", "nuget", "composer", "go", "rust", "erlang", "actions", "pub", "swift", "other" ], "type": "string", "description": "Only return advisories affecting this package ecosystem. Leave as Any for all ecosystems.", "default": "" }, "severity": { "title": "Severity", "enum": [ "", "low", "medium", "high", "critical" ], "type": "string", "description": "Only return advisories with this severity level.", "default": "" }, "type": { "title": "Advisory type", "enum": [ "reviewed", "unreviewed", "malware" ], "type": "string", "description": "Reviewed = GitHub-reviewed advisories, unreviewed = auto-imported (mostly from NVD), malware = malicious package advisories.", "default": "reviewed" }, "cveId": { "title": "CVE ID", "type": "string", "description": "Look up one exact CVE identifier, for example CVE-2024-3094." }, "ghsaId": { "title": "GHSA ID", "type": "string", "description": "Look up one exact GitHub advisory identifier, for example GHSA-rxjr-6c9q-h67x." }, "affectsPackage": { "title": "Affects package", "type": "string", "description": "Only return advisories affecting a specific package, for example lodash or django. Comma-separate for several packages." }, "publishedSince": { "title": "Published since", "type": "string", "description": "Only include advisories published on or after this date (YYYY-MM-DD)." }, "updatedSince": { "title": "Updated since", "type": "string", "description": "Only include advisories updated on or after this date (YYYY-MM-DD)." }, "sort": { "title": "Sort by", "enum": [ "published", "updated" ], "type": "string", "description": "Which timestamp to order results by.", "default": "published" }, "direction": { "title": "Direction", "enum": [ "desc", "asc" ], "type": "string", "description": "Sort direction.", "default": "desc" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of advisories to collect. Free Apify plans are capped at 10 per run.", "default": 100 }, "crossReferenceOsv": { "title": "Cross-reference OSV.dev (paid add-on)", "type": "boolean", "description": "For each advisory, query OSV.dev for cross-source affected version ranges, aliases and related advisories for the same package(s). Charged only when OSV returns a usable match. Paid Apify plans only.", "default": false }, "aiRemediation": { "title": "AI remediation guidance (paid add-on)", "type": "boolean", "description": "Use AI to turn each advisory into a plain-language summary, who is affected, concrete remediation steps and an urgency rating. Charged only when the model returns usable output. Paid Apify plans only.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used to reach GitHub. Residential US proxy is recommended to avoid shared-IP rate limits.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }