Create Scan

curl --request POST \
  --url https://api.example.com/api/scans/{repo_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'

{}

API Reference

Create Scan

Create a new scan for a repository and queue it for execution.

Required Scope: write:scan Security: Repository ownership validation

Args: repo_id: Repository ID to scan request: Scan creation request with scan_type and active_models background_tasks: FastAPI background tasks auth: Authentication context

Returns: Created scan details with task ID

Raises: 400: Bad request (validation errors, including if scan is already running) 401: Unauthorized (invalid token/API key) 403: Forbidden (insufficient scope or repository not owned by user’s org) 404: Not found (repository not found) 500: Internal server error

POST

api

scans

{repo_id}

Create Scan

curl --request POST \
  --url https://api.example.com/api/scans/{repo_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'

{}

Authorizations

X-API-Key

string

header

required

Use an API key in the X-API-Key header.

Path Parameters

repo_id

string

required

Body

application/json

The body is of type Request · object.

Response

Successful Response

The response is of type Response Create Scan Api Scans Repo Id Post · object.

List Repository Summaries Stop Scan

⌘I

Endpoints

Authorizations

Path Parameters

Body

Response