CI endpointsTrigger a run or scan

Trigger a run or scan

Start an existing test run or dispatch website or mobile discovery.

curl -X POST "https://app.aegisrunner.com/api/v1/ci/trigger" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "suiteIds": [
    "00000000-0000-4000-8000-000000000001"
  ],
  "browserProfile": "chromium"
}'
{
  "status": "crawl_failed",
  "error": "example_string",
  "message": "example_string"
}
POST
/ci/trigger
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Create a project token under Project setup → CI/CD.

Create a project token under Project setup → CI/CD.
Content-Typestring
Required

The media type of the request body

Options: application/json
suiteIdsarray

Suite IDs belonging to the token project.

caseIdsarray

Case IDs belonging to the token project. Takes precedence over suiteIds.

browserProfilestring

Browser profile for the run; defaults to chromium.

environmentIdstring

Environment belonging to the token project.

Format: uuid
testDataSetIdstring

Project data set. If omitted, the current project default is used.

Format: uuid
baseUrlstring

Target override. Full cloud scans require the configured project's base domain.

Format: uri
crawlboolean

Start discovery and test generation instead of an existing-suite run.

maxPagesinteger

Requested full-scan page limit. Plan limits still apply.

Min: 1
maxDepthinteger

Requested full-scan navigation depth.

Min: 1
devicestring

Device mode for a full website scan.

Options: desktop, mobile
authRolestring

Saved login role name for a full scan.

credentialsobject

Full-scan target credentials. Saved to the project for future scans and runs.

mobileScanobject

Dispatch native app discovery. Omit app to reuse the latest scanned app.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Create a project token under Project setup → CI/CD.

Body

application/json
suiteIdsarray

Suite IDs belonging to the token project.

caseIdsarray

Case IDs belonging to the token project. Takes precedence over suiteIds.

browserProfilestring

Browser profile for the run; defaults to chromium.

Example:
chromium
environmentIdstring

Environment belonging to the token project.

testDataSetIdstring

Project data set. If omitted, the current project default is used.

baseUrlstring

Target override. Full cloud scans require the configured project's base domain.

crawlboolean

Start discovery and test generation instead of an existing-suite run.

maxPagesinteger

Requested full-scan page limit. Plan limits still apply.

maxDepthinteger

Requested full-scan navigation depth.

devicestring

Device mode for a full website scan.

Allowed values:desktopmobile
authRolestring

Saved login role name for a full scan.

Example:
Admin
credentialsobject

Full-scan target credentials. Saved to the project for future scans and runs.

mobileScanobject

Dispatch native app discovery. Omit app to reuse the latest scanned app.

Responses

statusstring
Required
Allowed values:crawl_failed
errorstring
Required
messagestring

Start an existing test run or dispatch website or mobile discovery. Use a CI token from the project you want to test. Acknowledging dispatch does not establish successful completion.

See API authentication for tokens and API errors for completion and failure handling.