The Data Discovery API provides comprehensive REST endpoints for managing data discovery operations including data sources, scan profiles, credentials, and scan jobs with OAuth2 security and extensive filtering capabilities. (26 operations.)
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/data-use-governance-data-discovery"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{"openapi":"3.1.0","info":{"title":"Data Use Governance - Data Discovery","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my.onetrust.com/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"description":"The Data Discovery API provides comprehensive REST endpoints for managing data discovery operations including data sources, scan profiles, credentials, and scan jobs with OAuth2 security and extensive filtering capabilities."},"servers":[{"url":"https://{hostname}","variables":{"hostname":{"default":"hostname","description":"The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."}}}],"tags":[{"name":"Classification","description":"The Classification APIs are used to manage custom data classifiers and classification rules for Data Discovery.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Classification"},{"name":"Credentials","description":"APIs to manage credential operations including creation, updates, deletion, retrieval, and secure reference key management for multiple system authentication types.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Credentials"},{"name":"Data Sources","description":"APIs to manage data sources including creation, retrieval, updates, deletion, and comprehensive filtering with support for multiple system types and asset integration.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Data Sources"},{"name":"Installer","description":"APIs to retrieve Docker image tags and installation resources for worker node deployment and version management across different environments.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Installer"},{"name":"Scan Jobs","description":"APIs to control scan job execution including creation, cancellation, status monitoring, and comprehensive job history retrieval with filtering and pagination support.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Scan Jobs"},{"name":"Scan Profiles","description":"APIs to handle scan profile lifecycle management including creation, updates, deletion, and retrieval with support for catalog and catalog-scan types across various system platforms.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"x-displayName":"Scan Profiles"}],"paths":{"/api/discovery-scan-config/v2/credentials":{"get":{"operationId":"getCredentials","summary":"Get List of Credentials","description":"Use this API to retrieve a list of all credentials. The response will include details such as the credential name, ID, and reference key.","tags":["Credentials"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"name","in":"query","description":"The parameter to search for a credential by name.","required":false,"schema":{"description":"The parameter to search for a credential by name.","type":"string","maxLength":200,"minLength":0},"example":"AmazonS3 Ref Credential"},{"name":"systemName","in":"query","description":"The parameter to search for a credential by systemName.","required":false,"schema":{"description":"The parameter to search for a credential by systemName.","type":"string","enum":["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"],"maxLength":50,"minLength":0},"example":"Amazon S3"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N).","schema":{"description":"Results page to be retrieved (0..N).","type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1..50). Maximum page size allowed is 50","schema":{"description":"Number of records per page (1..50). Maximum page size allowed is 50","type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","schema":{"description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","type":"string","default":"createdDate,desc","enum":["name,asc","name,desc","systemName,asc","systemName,desc"]},"example":"name,desc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_PageWrapperCredentialDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"put":{"operationId":"updateCredential","summary":"Update Credential","description":"Use this API to update an existing credential.","tags":["Credentials"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto"}}}},"responses":{"200":{"description":"Credential updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"post":{"operationId":"createCredential","summary":"Create Credential","description":"Use this API to create a new credential.","tags":["Credentials"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialRequestV2Dto"}}}},"responses":{"201":{"description":"Credential Created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/credentials/{id}":{"get":{"operationId":"getCredentialById","summary":"Get Credential","description":"Use this API to retrieve a single credential by its unique identifier.","tags":["Credentials"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"id","in":"path","description":"ID of the credential. This value can be obtained from Get Credentials API.","required":true,"schema":{"type":"string","format":"uuid"},"example":"ad390cb4-9ce9-4976-8895-66d724493c7b"}],"responses":{"200":{"description":"Credential details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"delete":{"operationId":"deleteCredential","summary":"Delete Credential","description":"Use this API to delete an existing credential and its associated reference keys.","tags":["Credentials"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"id","in":"path","description":"ID of a credential. This value is obtained using [Create Credential]","required":true,"schema":{"type":"string","format":"uuid"},"example":"ad390cb4-9ce9-4976-8895-66d724493c7b"}],"responses":{"204":{"description":"Credential deleted successfully"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-job":{"post":{"operationId":"createJobUsingPOST","summary":"Create Scan Job","description":"Use this API to create a new scan job in the specified data source.","tags":["Scan Jobs"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanJobTriggerV3Dto"}}}},"responses":{"201":{"description":"Scan job created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-job/datasource/{dataSourceId}":{"get":{"operationId":"getScanJobsByDataSourceUsingGET_1","summary":"Get List of Scan Jobs","description":"Use this API to retrieve a list of all scan jobs in JSON format for the specified data source. The response will include relevant details for each scan job, including the corresponding scan job ID, created date, and cancelled date.","tags":["Scan Jobs"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"dataSourceId","in":"path","description":"The unique identifier of the data source.","required":true,"schema":{"type":"string","format":"uuid"},"example":"d841a8dc-bd67-47cd-b5e3-418f7d243de7"},{"name":"status","in":"query","description":"Status of the job scan","required":false,"schema":{"type":"array","items":{"type":"string","enum":["PENDING","IN_PROGRESS","COMPLETED"]}},"example":["PENDING","IN_PROGRESS","COMPLETED"]},{"name":"scanLevel","in":"query","description":"Array of scan levels","required":false,"schema":{"type":"array","items":{"type":"string","enum":["CATALOG","CATALOG_SCAN"]}},"example":["CATALOG","CATALOG_SCAN"]},{"name":"isManual","in":"query","description":"The flag to check if the retrieved jobs are Manual or Scheduled","required":false,"schema":{"type":"boolean"},"example":true},{"name":"createdFrom","in":"query","description":"The date (yyyy-mm-dd) to filter the scan jobs created on or after the specified date. For example, including the parameter createdFrom=2022-06-06 will filter results to scan jobs on or after June 6th, 2022.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-01-01T00:00:00Z"},{"name":"createdTo","in":"query","description":"The date (yyyy-mm-dd) to filter the scan jobs created on or before the specified date. For example, including the parameter createdTo=2022-06-06 would filter results to scan jobs on or before June 6th, 2022.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2024-12-31T23:59:59Z"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N).","schema":{"description":"Results page to be retrieved (0..N).","type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1..50). Maximum page size allowed is 50","schema":{"description":"Number of records per page (1..50). Maximum page size allowed is 50","type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","schema":{"description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","type":"string","default":"createdDate,desc","enum":["status,asc","status,desc","scanLevel,asc","scanLevel,desc","createdDate,asc","createdDate,desc"]},"example":"status,desc"}],"responses":{"200":{"description":"List of scan jobs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_PageWrapperMetadataScanJobDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["INTEGRATIONS","DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-job/{jobId}":{"get":{"operationId":"getJobByIdUsingGET","summary":"Get Scan Job","description":"Use this API to retrieve details of a specific scan job by its unique identifier. Returns comprehensive job information including status, progress, timestamps, metadata counts, scan profile used, and ingestion status.","tags":["Scan Jobs"],"parameters":[{"name":"jobId","in":"path","description":"Unique identifier (UUID) of the scan job. Obtain from Create Scan Job API or Get List of Scan Jobs API. Must be a valid UUID format.","required":true,"schema":{"type":"string","format":"uuid"},"example":"ef5c9081-431e-4577-bd91-1ff8bbd40f96"}],"responses":{"200":{"description":"Scan job details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-job/{jobId}/cancel":{"patch":{"operationId":"cancelJobUsingPATCH","summary":"Cancel Scan Job","description":"Use this API to cancel an existing scan job by its unique identifier. The job must be in a cancellable state (PENDING, PROCESSING, PAUSING). Jobs that are already COMPLETED, FAILED, CANCELLED, or CANCELLING cannot be cancelled. The cancellation is asynchronous - the job status will change to CANCELLING immediately, then to CANCELLED once the worker node acknowledges the cancellation.","tags":["Scan Jobs"],"parameters":[{"name":"jobId","in":"path","description":"Unique identifier (UUID) of the scan job to cancel. Obtain from Create Scan Job API or Get List of Scan Jobs API. Must be a valid UUID format.","required":true,"schema":{"type":"string","format":"uuid"},"example":"ef5c9081-431e-4577-bd91-1ff8bbd40f96"}],"responses":{"202":{"description":"Scan job cancellation accepted and initiated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_MetadataScanJobV2Dto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-profiles":{"get":{"operationId":"getAllUsingGET_2","summary":"Get List of Scan Profiles","description":"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.","tags":["Scan Profiles"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"search","in":"query","description":"The parameter to search for a scan profile by name.","required":false,"schema":{"type":"string"},"example":"MySQL Profile"},{"name":"systemName","in":"query","description":"A system name. Include to filter results to be limited to scan profiles with this system. Some examples are \"Box\", \"Snowflake\", and \"MongoDB\".","required":false,"schema":{"type":"string","enum":["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"]},"example":"MySQL"},{"name":"scanType","in":"query","description":"It is the scan profile type.","required":false,"schema":{"type":"string","enum":["CATALOG","CATALOG_SCAN","OFFSET_REPORT"]},"example":"CATALOG"},{"name":"createdFrom","in":"query","description":"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.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2021-09-11T01:41:50.143+00:00"},{"name":"createdTo","in":"query","description":"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.","required":false,"schema":{"type":"string","format":"date-time"},"example":"2021-09-11T02:41:50.143+00:00"},{"name":"page","in":"query","description":"Results page to be retrieved (0..N).","schema":{"description":"Results page to be retrieved (0..N).","type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1..50). Maximum page size allowed is 50","schema":{"description":"Number of records per page (1..50). Maximum page size allowed is 50","type":"integer","format":"int32","default":20,"maximum":50,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","schema":{"description":"Sorting criteria in the format: property(,asc|desc). Default is ascending.","type":"string","default":"createdDate,desc","enum":["name,asc","name,desc","systemName,asc","systemName,desc","scanType,asc","scanType,desc","createdDate,asc","createdDate,desc"]},"example":"name,desc"}],"responses":{"200":{"description":"Successfully retrieved scan profiles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_PageWrapperScanProfileDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"put":{"operationId":"updateV2UsingPUT","summary":"Update Scan Profile","description":"Use this API to update an existing scan profile.","tags":["Scan Profiles"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"}}}},"responses":{"200":{"description":"Scan Profile updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]},"post":{"operationId":"createV2UsingPOST","summary":"Create Scan Profile","description":"Use this API to create a new scan profile.","tags":["Scan Profiles"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileRequestV2Dto"}}}},"responses":{"201":{"description":"Scan Profile created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"DataUseGovernance-DataDiscovery_OAUTH2":["DATA_DISCOVERY"]}]}},"/api/discovery-scan-config/v2/scan-profiles/{scanProfileId}":{"get":{"operationId":"getScanProfileUsingGET_1","summary":"Get Scan Profile","description":"Use this API to retrieve a single scan profile by its unique identifier along with the associated scan type, system, and paths.","tags":["Scan Profiles"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json"},"parameters":[{"name":"scanProfileId","in":"path","description":"ID of a scan profile. This value can be obtained from Get All Scan Profiles API. Must be a valid UUID.","required":true,"schema":{"type":"string","format":"uuid"},"example":"ad390cb4-9ce9-4976-8895-66d724493c7b"}],"responses":{"200":{"description":"Scan Profile retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataUseGovernance-DataDiscovery_ScanProfileV2Dto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The un
# --- truncated at 32 KB (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-data-use-governance-data-discovery-openapi.json