Sign in

v1

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

Get Scan Profile

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

get/api/discovery-scan-config/v2/scan-profiles/{scanProfileId}

Path parameters

scanProfileIdstring uuid required

ID of a scan profile. This value can be obtained from Get All Scan Profiles API. Must be a valid UUID.

Response

Scan Profile retrieved successfully

idstring uuid required

Unique ID for Scan Profile

namestring required

Name of Scan Profile

scanType'CATALOG' | 'CATALOG_SCAN' required

Scan Type of Scan Profile

sourceType'SEED' | 'USER_DEFINED'

Source of this Scan Profile

systemNamestring required

System Name of Scan Profile

scanProfileContextobject 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

createdDatestring date-time

Creation Date of Scan Profile

displayNamestring

Display Name for System Name of Scan Profile

Example response

{
  "id": "4f162d7c-a563-4bf1-a7c4-b7899f6dcdef",
  "name": "My SQL Scan Profile",
  "scanType": "CATALOG",
  "sourceType": "USER_DEFINED",
  "systemName": "MySQL",
  "scanProfileContext": {
    "type": "MySQL",
    "includes": [
      {
        "database": "OT",
        "table": "Employee",
        "columns": "Name"
      }
    ],
    "excludes": [
      {
        "database": "OT",
        "table": "Credential",
        "columns": "Id"
      }
    ],
    "samplingScan": {
      "enableSampling": false
    },
    "tableLimits": {
      "randomize": false,
      "maxCount": 10
    },
    "tableTypes": [
      "TABLE"
    ],
    "databaseLimits": {
      "randomize": false,
      "maxCount": 1
    }
  },
  "systemType": "RELATIONAL_DATABASE",
  "createdDate": "2021-09-11T01:41:50.143+00:00",
  "displayName": "Amazon Redshift"
}