Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Scan Profiles

List Scan Profiles

get/scan-profiles/

Query parameters

archivedboolean

If true, the scan profile is no longer in use.
If false, the scan profile can be used.

builtinboolean

If true, it is a built-in scan profile, which cannot be changed.
If false, it is a custom scan profile.

lengthinteger

Number of results to return per page.

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

searchstring

A search term.

type'api' | 'web'

Target type:

  • web - Scan a Web application, including Single Page Applications (SPA) that rely on one or more APIs.
  • api - Scan a standalone API defined by an OpenAPI / Swagger schema, or by a Postman Collection.
verifiedboolean

If true, the scan profile only allows targets with verified domains.

Response

countinteger

Total number of results.

page_totalinteger

Total number of pages.

pageinteger

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

lengthinteger

Number of results returned per page.

Example response

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10
}