CentralCSP
APIScans

List your saved scans

Lists the scans you ran with one of the tools in this workspace, newest first. The history is scoped to you: it never lists another member's scans. The results themselves are readable by anyone holding a scanResultId, so treat a result as shareable rather than confidential.

Requires membership of the workspace.

GET
/v1/workspaces/{workspaceId}/scans

Authorization

AuthorizationBearer <token>

An OpenID Connect access token issued by Keycloak, acting as the signed-in user.

In: header

Path Parameters

workspaceId*string

Query Parameters

cursor?string

The nextCursor of the previous page. Omit it to start from the beginning. A cursor encodes a position and is not meant to be built by hand.

limit*|

How many items to return, from 1 to 200.

Range1 <= value <= 200
Default50
tool*string

Which scanner produced the scan. csp-scanner grades the Content Security Policy, header-scanner grades every security header, and reporting-api checks the reporting setup.

Value in

  • "csp-scanner"
  • "header-scanner"
  • "reporting-api"
search?string

Keeps only scans whose target contains this.

Response Body

application/json

curl -X GET "https://example.com/v1/workspaces/string/scans?limit=50&tool=csp-scanner"
{  "data": [    {      "id": "string",      "tool": "csp-scanner",      "target": "example.com",      "status": "running",      "outcome": "no_host",      "error": "bot protection interstitial detected",      "httpStatus": 403,      "urlAnalyzed": "https://example.com/",      "followRedirects": true,      "scanResultId": "string",      "scores": {        "overall": 0,        "security": 0,        "quality": 0      },      "findings": {        "critical": 0,        "high": 0,        "medium": 0,        "low": 0,        "info": 0,        "total": 0      },      "createdAt": "2019-08-24T14:15:22Z",      "finishedAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true,    "total": 0  }}