Start a New Vulnerability Scan

curl --request POST \ --url https://api.enkryptai.com/mcp-hub/scan \ --header 'Content-Type: application/json' \ --header 'apikey: <api-key>' \ --data ' { "source_url": "https://github.com/user/mcp-server", "version_or_commit": "main" } '

{ "job_id": "123e4567-e89b-12d3-a456-426614174000", "source_url": "https://github.com/user/mcp-server", "user_email": "user@example.com", "job_status": "initializing", "message": "Scan job created successfully" }

Authorizations

apikey

string

header

required

Body

application/json

Request body for starting a source-based MCP server vulnerability scan.

source_url

string

required

GitHub URL or npm package name/URL to scan

Example:

"https://github.com/user/mcp-server"

version_or_commit

string | null

Git commit/branch/tag or npm version. Defaults to the repo's default branch when omitted.

Example:

"main"

base_path

string | null

Optional subdirectory path within the repository to scan (e.g., 'packages/server')

Example:

"packages/server"

is_private

boolean

default:false

Mark this scan as private (visible only within your account)

Response

Scan job accepted

Response returned when a source-based scan job is accepted.

job_id

string

required

Unique identifier for the scan job

Example:

"123e4567-e89b-12d3-a456-426614174000"

source_url

string

required

Example:

"https://github.com/user/mcp-server"

user_email

string

required

Example:

"user@example.com"

job_status

string

required

Example:

"initializing"

message

string

required

Human-readable status message

Example:

"Scan job created successfully"