Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: KernelScan Analysis API
description: 'Public REST API for KernelScan — the Linux kernel CVE analyzer. Upload a kernel .config and get a CycloneDX VEX report of affecting CVEs, query the CVE database, and manage product analyses. Authenticate with `Authorization: Bearer ks_live_` (create one at /api/auth/api-keys). The same surface is also available over MCP at /mcp/.'
version: 1.0.0
contact:
name: KernelScan Support
url: https://kernelscan.io/docs
email: support@kernelscan.io
termsOfService: https://kernelscan.io/agb
servers:
- url: https://kernelscan.io
tags:
- name: Analysis
description: Submit a kernel .config and retrieve its CycloneDX VEX report.
paths:
/api/health:
get:
tags:
- Analysis
summary: Health
operationId: health_api_health_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties:
type: string
type: object
title: Response Health Api Health Get
/api/promo:
get:
tags:
- Analysis
summary: Promo Status
description: 'Public flag the register form gates its plan choice on.
The signup offer only exists through a Stripe checkout, so it is live
exactly when a checkout would actually succeed: self-serve billing
switched on AND at least one paid tier with a monthly price configured —
the same gates ``start_checkout`` enforces, so the marketing copy and
the real offer can never diverge. ``tiers`` lists which paid plans the
register form may reveal its card for (the form shows those and no
others); a tier without a price never appears, because the flag must
not advertise a plan that tier''s checkout would refuse. Every paid card
additionally needs the trial campaign to be open
(``signup_trial_being_offered``: its card copy IS the 30-day offer), and
``days`` is the length of that signup trial. Fails closed: any error
means no choice is offered and the form registers a plain free account.'
operationId: promo_status_api_promo_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Promo Status Api Promo Get
/api/stats/public:
get:
tags:
- Analysis
summary: Public Stats
operationId: public_stats_api_stats_public_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Public Stats Api Stats Public Get
/api/versions:
get:
tags:
- Analysis
summary: Versions
operationId: versions_api_versions_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
type: string
type: array
title: Response Versions Api Versions Get
/api/analyze:
post:
tags:
- Analysis
summary: Analyze
operationId: analyze_api_analyze_post
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_analyze_api_analyze_post'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Analyze Api Analyze Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/jobs/{job_id}:
get:
tags:
- Analysis
summary: Job Status
operationId: job_status_api_jobs__job_id__get
parameters:
- name: job_id
in: path
required: true
schema:
type: string
title: Job Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Job Status Api Jobs Job Id Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/jobs/{job_id}/push-to-dt:
post:
tags:
- Analysis
summary: Push Job To Dt
description: 'Manually push (or re-push) the VEX for a completed job to DT.
Useful as a retry path when auto-push failed transiently, and as the
only path for jobs that completed before the customer enabled
auto-push. Ownership is checked: callers see only their own jobs
(admins see all).'
operationId: push_job_to_dt_api_jobs__job_id__push_to_dt_post
parameters:
- name: job_id
in: path
required: true
schema:
type: string
title: Job Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Push Job To Dt Api Jobs Job Id Push To Dt Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/download/{job_id}:
get:
tags:
- Analysis
summary: Download Vex
operationId: download_vex_api_download__job_id__get
parameters:
- name: job_id
in: path
required: true
schema:
type: string
title: Job Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/kernel-releases:
get:
tags:
- Analysis
summary: Kernel Releases
description: 'Known releases of an overlay tree for one series. Public and read-only:
git tags and public fix data. ``complete`` is true only when the tag list
from the tree''s git tags is stored and readable; otherwise the list holds
the fix-data releases only, and a client must not conclude from it that a
release does not exist (nor that a lone entry is the only one).'
operationId: kernel_releases_api_kernel_releases_get
parameters:
- name: flavor
in: query
required: true
schema:
type: string
title: Flavor
- name: series
in: query
required: true
schema:
type: string
title: Series
- name: rt
in: query
required: false
schema:
type: boolean
default: false
title: Rt
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Kernel Releases Api Kernel Releases Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
Body_analyze_api_analyze_post:
properties:
config_file:
type: string
format: binary
title: Config File
kernel_release:
anyOf:
- type: string
- type: 'null'
title: Kernel Release
type: object
required:
- config_file
title: Body_analyze_api_analyze_post
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
externalDocs:
description: KernelScan documentation
url: https://kernelscan.io/docs