{ "openapi": "3.0.1", "info": { "title": "GitHub Security Advisories Scraper", "description": "GitHub Security Advisories Scraper for GHSA feeds, CVE lookup, package lookup, severity filters, CVSS, EPSS, CWE, fixed versions, references, credits, and advisory timestamps.", "version": "0.1", "x-build-id": "Z6mY8wT2ZsOunuXV9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~github-security-advisories-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-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/maximedupre~github-security-advisories-scraper/runs": { "post": { "operationId": "runs-sync-maximedupre-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/maximedupre~github-security-advisories-scraper/run-sync": { "post": { "operationId": "run-sync-maximedupre-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": { "collectFeed": { "title": "Collect advisory feed", "type": "boolean", "description": "Collect matching GitHub Security Advisories from the public catalogue.", "default": true }, "ghsaIds": { "title": "GHSA IDs", "maxItems": 500, "uniqueItems": true, "type": "array", "description": "GitHub Security Advisory IDs to fetch directly.", "items": { "type": "string", "pattern": "^GHSA-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}-[A-Za-z0-9]{4}$" } }, "cveIds": { "title": "CVE IDs", "maxItems": 500, "uniqueItems": true, "type": "array", "description": "CVE IDs to map to their GitHub Security Advisories.", "items": { "type": "string", "pattern": "^CVE-[0-9]{4}-[0-9]{4,}$" } }, "affectedPackages": { "title": "Affected packages", "maxItems": 500, "uniqueItems": true, "type": "array", "description": "Package names or package@version values to check for advisories.", "items": { "type": "string", "minLength": 1 } }, "ecosystems": { "title": "Package ecosystems", "uniqueItems": true, "type": "array", "description": "Limit results to selected package ecosystems.", "items": { "type": "string", "enum": [ "actions", "composer", "erlang", "go", "maven", "npm", "nuget", "other", "pip", "pub", "rubygems", "rust", "swift" ], "enumTitles": [ "GitHub Actions", "Composer", "Erlang and Elixir", "Go", "Maven", "npm", "NuGet", "Other", "pip", "Pub", "RubyGems", "Rust", "Swift" ] } }, "advisoryTypes": { "title": "Advisory types", "uniqueItems": true, "type": "array", "description": "Limit results to GitHub advisory classifications.", "items": { "type": "string", "enum": [ "reviewed", "unreviewed", "malware" ], "enumTitles": [ "Reviewed", "Unreviewed", "Malware" ] } }, "severities": { "title": "Severities", "uniqueItems": true, "type": "array", "description": "Limit results to selected severity buckets.", "items": { "type": "string", "enum": [ "critical", "high", "medium", "low", "unknown" ], "enumTitles": [ "Critical", "High", "Medium", "Low", "Unknown" ] } }, "cweIds": { "title": "CWE IDs", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "CWE numbers to filter by, such as 79 or 862.", "items": { "type": "string", "pattern": "^(CWE-)?[0-9]+$" } }, "publishedFrom": { "title": "Published from", "type": "string", "description": "Earliest advisory publication date." }, "publishedTo": { "title": "Published to", "type": "string", "description": "Latest advisory publication date." }, "updatedFrom": { "title": "Updated from", "type": "string", "description": "Earliest advisory update date." }, "updatedTo": { "title": "Updated to", "type": "string", "description": "Latest advisory update date." }, "modifiedAfter": { "title": "Modified after", "type": "string", "description": "Collect advisories changed after this date." }, "withdrawnOnly": { "title": "Withdrawn advisories only", "type": "boolean", "description": "Collect advisories marked as withdrawn.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "published", "updated", "epssPercentage", "epssPercentile" ], "type": "string", "description": "Order feed results by this advisory field.", "default": "published" }, "sortDirection": { "title": "Sort direction", "enum": [ "desc", "asc" ], "type": "string", "description": "Choose newest/highest first or oldest/lowest first.", "default": "desc" }, "maxItems": { "title": "Maximum advisories", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum advisory records to save for feed and package targets.", "default": 1024 }, "githubToken": { "title": "GitHub token", "type": "string", "description": "Optional token for larger public GitHub pulls." } } }, "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 } } } } } } } } } }