CI endpointsStream scan progress

Stream scan progress

Follow website discovery and test generation through Server-Sent Events.

curl -X GET "https://app.aegisrunner.com/api/v1/ci/crawls/123e4567-e89b-12d3-a456-426614174000/events" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{}
GET
/ci/crawls/{crawlId}/events
GET
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.
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.

Path Parameters

Responses

Server-Sent Events with JSON data. Comment lines are keepalives.

Follow website discovery and test generation through Server-Sent Events. Use the crawl_id returned by a website scan trigger. Completion is reported by the done event.

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

Event stream example

The successful response is text/event-stream, not a JSON object. A completed website scan can produce:

event: connected
data: {"crawl_id":"00000000-0000-4000-8000-000000000002","status":"running"}

event: done
data: {"crawl_id":"00000000-0000-4000-8000-000000000002","result":"completed"}

Progress events can appear between these messages. Inspect the done event's result: failed indicates an unsuccessful scan. A timeout or disconnection does not establish successful completion.

Use the streaming cURL example or aegis scan --watch when you need live progress outside the dashboard.