v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Data Sources

Create or Update Data Source

Use this API to create a new data source or update an existing data source. The data source will be created or updated with the details provided in the request body.

put/api/discovery-scan-config/v3/system

Request body

dataSourceNamestring

Name of Data Source

systemType'AWS' | 'Azure' | 'AzureCosmos' | 'AzureStorage' | 'Box' | 'Cassandra' | 'Databricks' | 'IBMDB2' | 'Exchange' | 'GCP' | 'GoogleWorkspaceGmail' | 'GoogleBigQuery' | 'GoogleBigTable' | 'MongoDB' | 'MySQL' | 'Netezza' | 'Office365' | 'OneDrive' | 'OracleRDBMS' | 'PostgreSQL' | 'AmazonS3' | 'AmazonSageMaker' | 'AmazonBedrock' | 'GCPVertex' | 'AzureFoundry' | 'SalesForce' | 'SAPHana' | 'ServiceNow' | 'SharePoint' | 'SMB' | 'Snowflake' | 'MicrosoftSQL' | 'Teradata' | 'Workday' | 'Zendesk' | 'AmazonRDSforSQLServer' | 'AzureSQLServer' | 'Redshift' | 'GoogleDrive' | 'CustomConnector' | 'AmazonDynamoDB' | 'AmazonAthena' | 'Hive' | 'SharePoint2019OnPrem' | 'GenericJDBC' | 'SFTP' | 'NFS' | 'GCS' | 'Redis' | 'ElasticSearch' | 'MicrosoftTeams' | 'Slack' | 'AlibabaCloudOSS' | 'AzureFiles' | 'Iceberg' | 'NGFSFILES' | 'Github' | 'Unknown' | 'RELATIONAL_DATABASE' | 'NON_RELATIONAL_DATABASE' | 'FILE' | 'API' | 'Kafka' | 'WorkdayApp'

System Type of Data Source

systemNamestring

System Name of Data Source

status'INACTIVE' | 'ACTIVE' | 'DELETED'

Data Source current status

oneTrustAssetIdstring uuid

Asset ID for Data Source

orgGroupIdstring uuid

Org Group ID for Data Source

createdBystring uuid

UserID who created Data Source

modifiedBystring uuid

UserID who modified Data Source

createdDatestring date-time

Data Source Created date

modifiedDatestring date-time

Data Source modified date

systemIdstring uuid

SystemTile ID for Data Source

idstring uuid

Example request

{
  "dataSourceName": "S3-DS-24thMarch",
  "systemType": "AmazonS3",
  "systemName": "Amazon S3",
  "status": "ACTIVE",
  "oneTrustAssetId": "860abcce-fbf3-4f32-a38b-df19f8c08eae",
  "orgGroupId": "ec33136e-dd31-492b-8cd7-cb1a0109fe93",
  "createdBy": "e897fe47-a504-4dd4-8eda-52add1a397f0",
  "modifiedBy": "e897fe47-a504-4dd4-8eda-52add1a397f0",
  "createdDate": "2022-04-04T11:33:16.538+00:00",
  "modifiedDate": "2022-04-04T11:53:16.538+00:00",
  "dataSourceSettings": {
    "scannerId": "4f162d7c-a563-4bf1-a7c4-b7899f6dcdef",
    "workerNodeName": "WN-24thAugust",
    "scanProfileId": "3f162d7c-a463-4bf1-a7c4-b7899f6dcdef",
    "scanProfileName": "ScanProfile-Mysql",
    "credentialId": "8f162d7c-a563-4bf1-a0c4-b7899f6dcdef",
    "credentialName": "Credential-Mysql",
    "oneTrustAssetId": "860abcce-fbf3-4f32-a38b-df19f8c08eae",
    "classificationProfileId": "3f162d7c-a863-4bf1-a9c4-b7899f6dcdef",
    "detectorProfileId": "3f162d7c-a863-4bf1-a9c4-b7899f6dcdef"
  },
  "dataSourceTriggerList": [
    {
      "cronExpression": "0 0 buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils ? buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils *",
      "dateTime": {
        "seconds": "0",
        "minutes": "0",
        "hours": {
          "label": "OneHour",
          "value": "1",
          "cronExp": null
        },
        "dayOfMonth": null,
        "month": null,
        "dayOfWeek": {
          "label": "M",
          "value": "2",
          "cronExp": "MON"
        },
        "year": null,
        "frequency": {
          "label": "Hourly",
          "value": "8",
          "cronExp": "?"
        },
        "frequencyIntervalTracker": "?"
      },
      "isRunManual": false,
      "id": 17717
    }
  ],
  "systemId": "760abcce-fbf3-4f32-a28b-df19f8c08eae"
}

Response

Data source upserted successfully

dataSourceNamestring

Name of Data Source

systemType'AWS' | 'Azure' | 'AzureCosmos' | 'AzureStorage' | 'Box' | 'Cassandra' | 'Databricks' | 'IBMDB2' | 'Exchange' | 'GCP' | 'GoogleWorkspaceGmail' | 'GoogleBigQuery' | 'GoogleBigTable' | 'MongoDB' | 'MySQL' | 'Netezza' | 'Office365' | 'OneDrive' | 'OracleRDBMS' | 'PostgreSQL' | 'AmazonS3' | 'AmazonSageMaker' | 'AmazonBedrock' | 'GCPVertex' | 'AzureFoundry' | 'SalesForce' | 'SAPHana' | 'ServiceNow' | 'SharePoint' | 'SMB' | 'Snowflake' | 'MicrosoftSQL' | 'Teradata' | 'Workday' | 'Zendesk' | 'AmazonRDSforSQLServer' | 'AzureSQLServer' | 'Redshift' | 'GoogleDrive' | 'CustomConnector' | 'AmazonDynamoDB' | 'AmazonAthena' | 'Hive' | 'SharePoint2019OnPrem' | 'GenericJDBC' | 'SFTP' | 'NFS' | 'GCS' | 'Redis' | 'ElasticSearch' | 'MicrosoftTeams' | 'Slack' | 'AlibabaCloudOSS' | 'AzureFiles' | 'Iceberg' | 'NGFSFILES' | 'Github' | 'Unknown' | 'RELATIONAL_DATABASE' | 'NON_RELATIONAL_DATABASE' | 'FILE' | 'API' | 'Kafka' | 'WorkdayApp'

System Type of Data Source

systemNamestring

System Name of Data Source

status'INACTIVE' | 'ACTIVE' | 'DELETED'

Data Source current status

oneTrustAssetIdstring uuid

Asset ID for Data Source

orgGroupIdstring uuid

Org Group ID for Data Source

createdBystring uuid

UserID who created Data Source

modifiedBystring uuid

UserID who modified Data Source

createdDatestring date-time

Data Source Created date

modifiedDatestring date-time

Data Source modified date

systemIdstring uuid

SystemTile ID for Data Source

idstring uuid

Example response

{
  "dataSourceName": "S3-DS-24thMarch",
  "systemType": "AmazonS3",
  "systemName": "Amazon S3",
  "status": "ACTIVE",
  "oneTrustAssetId": "860abcce-fbf3-4f32-a38b-df19f8c08eae",
  "orgGroupId": "ec33136e-dd31-492b-8cd7-cb1a0109fe93",
  "createdBy": "e897fe47-a504-4dd4-8eda-52add1a397f0",
  "modifiedBy": "e897fe47-a504-4dd4-8eda-52add1a397f0",
  "createdDate": "2022-04-04T11:33:16.538+00:00",
  "modifiedDate": "2022-04-04T11:53:16.538+00:00",
  "dataSourceSettings": {
    "scannerId": "4f162d7c-a563-4bf1-a7c4-b7899f6dcdef",
    "workerNodeName": "WN-24thAugust",
    "scanProfileId": "3f162d7c-a463-4bf1-a7c4-b7899f6dcdef",
    "scanProfileName": "ScanProfile-Mysql",
    "credentialId": "8f162d7c-a563-4bf1-a0c4-b7899f6dcdef",
    "credentialName": "Credential-Mysql",
    "oneTrustAssetId": "860abcce-fbf3-4f32-a38b-df19f8c08eae",
    "classificationProfileId": "3f162d7c-a863-4bf1-a9c4-b7899f6dcdef",
    "detectorProfileId": "3f162d7c-a863-4bf1-a9c4-b7899f6dcdef"
  },
  "dataSourceTriggerList": [
    {
      "cronExpression": "0 0 buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils ? buildMR_Jenkinsfile getApiSpec.sh specVariationChecker_Jenkinsfile tryCatch.sh utils *",
      "dateTime": {
        "seconds": "0",
        "minutes": "0",
        "hours": {
          "label": "OneHour",
          "value": "1",
          "cronExp": null
        },
        "dayOfMonth": null,
        "month": null,
        "dayOfWeek": {
          "label": "M",
          "value": "2",
          "cronExp": "MON"
        },
        "year": null,
        "frequency": {
          "label": "Hourly",
          "value": "8",
          "cronExp": "?"
        },
        "frequencyIntervalTracker": "?"
      },
      "isRunManual": false,
      "id": 17717
    }
  ],
  "systemId": "760abcce-fbf3-4f32-a28b-df19f8c08eae"
}