Skip to main content
POST
Trigger a scan (GitHub or GitLab)

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
required
Minimum string length: 1
repository
string
required
Minimum string length: 1
provider
enum<string>
Available options:
github,
gitlab
branch
string
Minimum string length: 1

Response

Scan created

object
string
required
Allowed value: "scan"
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
status
string | null
required
is_done
boolean
required
progress
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
programming_language
string | null
required
branch
string | null
required
commit_sha
string | null
required
repository
string | null
required
vulnerability_counts
object
required
created_at
string
required
ended_at
string | null
required