v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Credentials

Update Credential

Use this API to update an existing credential.

put/api/discovery-scan-config/v2/credentials

Request body

idstring uuid

Unique ID for Credential

namestring

Name of Credential

descriptionstring

Credential Description

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'

System Name

referenceKeystring

Reference Key

workerNodeNamestring

Worker Node Name

Example request

{
  "id": "4f162d7c-a563-4bf1-a7c4-b7899f6dcdef",
  "name": "MySQL Credential",
  "description": "MySQL Ref Credential",
  "systemName": "MySQL",
  "referenceKey": "kv/mysql",
  "workerNodeName": "WN-24thAugust"
}

Response

Credential updated successfully

idstring uuid

Unique ID for Credential

namestring

Name of Credential

descriptionstring

Credential Description

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'

System Name

referenceKeystring

Reference Key

workerNodeNamestring

Worker Node Name

Example response

{
  "id": "4f162d7c-a563-4bf1-a7c4-b7899f6dcdef",
  "name": "MySQL Credential",
  "description": "MySQL Ref Credential",
  "systemName": "MySQL",
  "referenceKey": "kv/mysql",
  "workerNodeName": "WN-24thAugust"
}