Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Scan Profiles

Get List of 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.

get/api/discovery-scan-config/v2/scan-profiles

Query parameters

searchstring

The parameter to search for a scan profile by name.

systemName'Azure Cosmos' | 'Box' | 'Cassandra' | 'Azure Databricks' | 'IBM DB2' | 'Exchange' | 'GCP' | 'Google Workspace Gmail' | 'Google BigQuery' | 'Google BigTable' | 'MongoDB' | 'MySQL' | 'OneDrive' | 'Oracle RDBMS' | 'PostgreSQL' | 'Amazon S3' | 'SalesForce' | 'SAP HANA' | 'ServiceNow' | 'SharePoint' | 'SMB' | 'Snowflake' | 'Microsoft SQL' | 'Teradata' | 'Workday' | 'Zendesk' | 'Amazon RDS for SQL Server' | 'Azure SQL Server' | 'Redshift' | 'Google Drive' | 'Amazon DynamoDB' | 'Amazon Athena' | 'SharePoint 2019 OnPrem' | 'SFTP' | 'NFS' | 'GCS' | 'Redis' | 'Elastic Search' | 'Microsoft Teams' | 'Slack' | 'AlibabaCloudOSS' | 'Azure Files' | 'Iceberg' | 'Kafka'

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

scanType'CATALOG' | 'CATALOG_SCAN' | 'OFFSET_REPORT'

It is the scan profile type.

createdFromstring 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.

createdTostring 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.

pageinteger

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

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

sizeinteger

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

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

sort'name,asc' | 'name,desc' | 'systemName,asc' | 'systemName,desc' | 'scanType,asc' | 'scanType,desc' | 'createdDate,asc' | 'createdDate,desc'

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

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

Response

Successfully retrieved scan profiles

numberinteger

Current page number.

sizeinteger

The size of the page (number of elements per page).

numberOfElementsinteger

The number of elements on the current page.

totalElementsinteger

The total number of elements across all pages.

totalPagesinteger

The total number of pages.

firstboolean

Indicates if this is the first page.

lastboolean

Indicates if this is the last page.

emptyboolean

Indicates if the page is empty.

Example response

{
  "content": [
    {
      "id": 1,
      "name": "Item"
    }
  ],
  "size": 20,
  "numberOfElements": 15,
  "totalElements": 150,
  "totalPages": 8,
  "first": true
}