---
title: "Get Scan Profile"
method: GET
path: "/api/discovery-scan-config/v2/scan-profiles/{scanProfileId}"
tags: ["Scan Profiles"]
---

# Get Scan Profile

`GET /api/discovery-scan-config/v2/scan-profiles/{scanProfileId}`

## Request

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

Use this API to retrieve a single scan profile by its unique identifier along with the associated scan type, system, and paths.

## Path parameters

- `scanProfileId` string, uuid, required

## Response `200`

Scan Profile retrieved successfully

- DataUseGovernanceDataDiscoveryScanProfileV2Dto
  - `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

## 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)