---
title: "Get List of Scan Profiles"
method: GET
path: "/api/discovery-scan-config/v2/scan-profiles"
tags: ["Scan Profiles"]
---

# Get List of Scan Profiles

`GET /api/discovery-scan-config/v2/scan-profiles`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/discovery-scan-config/v2/scan-profiles`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `DATA_DISCOVERY`

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 parameters

- `search` string
- `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'
- `scanType` 'CATALOG' | 'CATALOG_SCAN' | 'OFFSET_REPORT'
- `createdFrom` string, date-time
- `createdTo` string, date-time
- `page` integer: Results page to be retrieved (0..N).
- `size` integer: 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.

## Response `200`

Successfully retrieved scan profiles

- DataUseGovernanceDataDiscoveryPageWrapperScanProfileDto
  - `content` DataUseGovernanceDataDiscoveryScanProfileV2Dto[]: The content of this page.
    - `id` string, uuid, required: Unique ID for Scan Profile
    - `name` string, required: Name of Scan Profile
    - `scanType` 'CATALOG' | 'CATALOG_SCAN', required: Scan Type of Scan Profile
    - `sourceType` 'SEED' | 'USER_DEFINED': Source of this Scan Profile
    - `systemName` string, required: System Name of Scan Profile
    - `scanProfileContext` object, required: Properties of Scan Profile Specific to System
    - `systemType` 'RELATIONAL_DATABASE' | 'NON_RELATIONAL_DATABASE' | 'FILE' | 'API' | 'CUSTOM' | 'UNKNOWN' | 'CLOUD_PLATFORM' | 'MACHINE_LEARNING_PLATFORM', required: System Type of Scan Profile
    - `createdDate` string, date-time: Creation Date of Scan Profile
    - `displayName` string: Display Name for System Name of Scan Profile
  - `number` integer: Current page number.
  - `size` integer: The size of the page (number of elements per page).
  - `numberOfElements` integer: The number of elements on the current page.
  - `totalElements` integer: The total number of elements across all pages.
  - `totalPages` integer: The total number of pages.
  - `first` boolean: Indicates if this is the first page.
  - `last` boolean: Indicates if this is the last page.
  - `empty` boolean: Indicates if the page is empty.
  - `sort` DataUseGovernanceDataDiscoverySort
    - `sort` string[]
  - `pageable` DataUseGovernanceDataDiscoveryPageable
    - `page` integer
    - `size` integer
    - `sort` string[]

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/data-use-governance-data-discovery.md) - [All operations](https://skmtc.dev/onetrust/apis/data-use-governance-data-discovery/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/data-use-governance-data-discovery/revisions/3de7ce93ffb7?raw)