Skip to main content
POST
/
api
/
v1
/
scans
Launch a scan
curl --request POST \
  --url https://app.gecko.security/api/v1/scans \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Paperbaum",
  "gitlabUrl": "https://gitlab.com/gecko-security/Paperbaum/-/tree/main"
}
'
{
  "version": "v1",
  "data": {
    "scanId": "f5d35de5-8fc8-4a01-8e28-3bae5d6d26ad",
    "name": "Paperbaum",
    "status": "launched",
    "repository": {
      "fullName": "gecko-security/Paperbaum",
      "branch": "main",
      "instance": "gitlab.com"
    },
    "taskArn": "arn:aws:ecs:eu-west-2:123456789012:task/gecko/1234567890abcdef"
  }
}

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