GEgecko

Trigger a scan (GitHub or GitLab)

post/scans

Request

  • Base URL
    https://app.gecko.security/api/v1
  • URL
    https://app.gecko.security/api/v1/scans
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Headers

Idempotency-Keystring

Safely retry a POST/PATCH; a replayed key returns the original response.

Request body

namestring required
repositorystring required
provider'github' | 'gitlab'
branchstring
commitstring

Scan exactly this commit instead of the branch tip. Full or abbreviated SHA; it must exist in the repository.

base_commitstring

Analyze only the files changed from this commit to commit (a diff scan). Requires commit; findings land as repository findings.

model'haiku' | 'sonnet' | 'opus'

Response

Scan created

object'scan' required
idstring uuid required
namestring required
statusstring nullable required
is_doneboolean required
progressinteger nullable required
programming_languagestring nullable required
kind'main' | 'pr' | 'fix' required
branchstring nullable required
commit_shastring nullable required
pull_request_numberinteger nullable required
repositorystring nullable required
modelstring nullable required
created_atstring required
ended_atstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.