Security

Start a security scan

Queues a scan for the given profile and returns immediately with the tracking id, because a scan runs in the background. Poll the scan run endpoint until its status leaves queued and running.

post/api/projects/{projectId}/security/scan-profiles/{profileId}/run

Request

  • Base URL: https://api.routebase.dev
  • URL: https://api.routebase.dev/api/projects/{projectId}/security/scan-profiles/{profileId}/run
  • Auth: API key in header X-API-Key

Path parameters

profileIdstring uuid required

Public id of the scan profile.

ProjectIdstring uuid required

Public id of the project.

Headers

X-RB-Regionstring
Example:us

Region of your organization. US organizations must send us; EU organizations leave the header out. Without it a US call is routed to the EU region and answered with 401.

Response

The scan was queued.

idstring uuid required

Public id of the scan run.

scanProfilePublicIdstring uuid required

Profile the run was started from.

status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required

The lifecycle state of a scan run.

trigger'manual' | 'scheduled' | 'api' | 'ciCd' required

What started a scan run.

startedAtstring date-time required

When the run was queued, in UTC.

completedAtstring date-time nullable

When the run finished, in UTC. Null while it is still going.

totalChecksinteger required

How many individual checks the enabled scanners performed.

checksPassedinteger required

Checks that found nothing.

checksFailedinteger required

Checks that produced a finding.

checksSkippedinteger required

Checks that could not run, for example because an endpoint needs authentication the profile does not carry.

securityScoreinteger required

Score between 0 and 100, final once the status is completed.

errorMessagestring nullable

Set when the run failed.

openFindingsCountinteger required

Findings still open after this run.

enabledScannerCountinteger

Scanners the profile enables.

scannersCompletedinteger

Scanners finished so far.

currentScannerIdstring nullable

Scanner running right now.

cancelRequestedAtstring date-time nullable

Set when a cancel was asked for but the run has not stopped yet.

Changes

No recorded changes to this operation across all 1 revision of this API.