Skip to content

Create Scan

POST
/repos/{repo_id}/scan

Record pre-computed repository scan results.

This endpoint does not scan a repository server-side — it persists a scan produced by the g8 CLI (or any MCP client that walks the filesystem itself). Required fields in the body: tech_stack, api_routes, gtm_readiness. The server stores the results and links them to the repo so subsequent /install calls can derive a patch set.

Authorizations

Parameters

Path Parameters

repo_id
required

Repository ID

string

Repository ID

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
api_routes

Detected API routes

Array<object>
default:
object
key
additional properties
any
gtm_readiness

GTM readiness flags

object
key
additional properties
any
product_type
Any of:
string
readme_summary
Any of:
string
scan_duration_ms
Any of:
integer
tech_stack
required

Detected tech stack (framework, language, etc.)

object
key
additional properties
any

Responses

201

Successful Response

object
data
required
object
api_routes
required
Array<object>
object
key
additional properties
any
created_at
Any of:
string format: date-time
gtm_readiness
object
key
additional properties
any
id
required
string format: uuid
product_type
Any of:
string
readme_summary
Any of:
string
repo_id
required
string format: uuid
scan_duration_ms
Any of:
integer
tech_stack
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string