Skip to main content
POST
Launch a scan

Authorizations

X-API-Key
string
header
required

Team-scoped Gecko API key. Keys start with gk_.

Body

application/json
name
string
required

Readable scan name.

gitlabUrl
string<uri>
required

GitLab repository URL. You can include a branch in ?ref= or in a /-/tree/<branch> path.

branch
string

Optional branch override.

Response

The scan was launched.

version
string
required
Allowed value: "v1"
data
object
required