Get List of Scan Profiles

get

https://{hostname}/api/discovery-scan-config/v2/scan-profiles

Use this API to retrieve a list of all scan profiles. The response will include details for each scan profile along with the corresponding scan profile ID and its associated scan type, system, and paths.

Query Params

string

The parameter to search for a scan profile by name.

systemName

string

enum

A system name. Include to filter results to be limited to scan profiles with this system. Some examples are "Box", "Snowflake", and "MongoDB".

scanType

string

enum

It is the scan profile type.

Allowed:

createdFrom

date-time

Include a date (yyyy-mm-dd) to filter the results to scan profiles created on or after the specified date. For example, including the parameter createdFrom=2021-08-17 will filter results to scan profiles on or after August 17th, 2021.

createdTo

date-time

Include a date (yyyy-mm-dd) to filter the results to scan profiles created on or before the specified date. For example, including the parameter createdTo=2021-08-17 would filter results to scan profiles on or before August 17th, 2021.

page

int32

≥ 0

Defaults to 0

Results page to be retrieved (0..N).

size

int32

1 to 50

Defaults to 20

Number of records per page (1..50). Maximum page size allowed is 50

sort

string

enum

Defaults to createdDate,desc

Sorting criteria in the format: property(,asc|desc). Default is ascending.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200Successfully retrieved scan profiles

429Too Many Requests. For more information, see API Rate Limits.