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 OAuth 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: OAuth
paths:
/api/oauth/authorization-request:
get:
tags:
- OAuth
summary: Describe Authorization Request
description: 'What the consent page needs to render: who is asking, and for what.
Deliberately unauthenticated: the page calls this before it knows whether
anyone is signed in, and it reveals nothing secret — only a client name the
client chose for itself. Validating here means an invalid request is caught
BEFORE the user logs in, rather than after.
``client_kind`` tells the page how to present the requester: for ``cimd``
the proven ``client_host`` is the identity and ``client_name`` secondary;
for ``dcr`` everything is self-asserted and the page warns. Because this
endpoint has no user, the DCR opt-in cannot be checked here — the page
checks ``oauth_dcr_enabled`` after sign-in for the explanation, and
POST /api/oauth/authorize is where it is enforced.'
operationId: describe_authorization_request_api_oauth_authorization_request_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/oauth/authorize:
post:
tags:
- OAuth
summary: Grant Authorization
description: 'Mint an authorization code for the signed-in user.
Authenticated with the user''s own JWT (the consent page sends it from
localStorage), so the identity being granted is unambiguous and no
cross-site form can trigger it.
The code stores the redirect_uri exactly as presented (for a CIMD loopback
redirect that includes the ephemeral port), and /oauth/token demands that
same string.'
operationId: grant_authorization_api_oauth_authorize_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/oauth/connections:
get:
tags:
- OAuth
summary: List Connections
description: 'Live OAuth grants for this account, so a user can see and cut them.
A connector the user can''t revoke is worse than the config-file key it
replaces — that one they could at least delete.'
operationId: list_connections_api_oauth_connections_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/oauth/connections/{client_id}:
delete:
tags:
- OAuth
summary: Revoke Connection
description: Revoke this client's tokens and pending codes in one serialized action.
operationId: revoke_connection_api_oauth_connections__client_id__delete
parameters:
- name: client_id
in: path
required: true
schema:
type: string
title: Client Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/oauth/dcr-setting:
put:
tags:
- OAuth
summary: Set Dcr Setting
description: 'Allow or forbid authorizing clients without a verified identity (backend#419).
Deliberately NOT in ``OAUTH_REST_ALLOWLIST``: a connector must never be able
to widen which connectors its user can authorize. Turning it off stops new
DCR grants; existing connections stay listed on the account page, where the
user can revoke them.'
operationId: set_dcr_setting_api_oauth_dcr_setting_put
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
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
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