A valid request URL is required to generate request examples[
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "mssql",
"scope": "personal",
"isPublic": true,
"owners": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"contributors": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"users": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"inheritEntitlements": true,
"endpoint": "<string>",
"port": 123,
"database": "<string>",
"cloudProvider": "aws",
"region": "<string>",
"workspace": "<string>",
"warehouse": "<string>",
"httpPath": "<string>",
"catalog": "<string>",
"schema": "<string>",
"s3OutputLocation": "<string>",
"authentication": {
"type": "username-password",
"username": "<string>",
"password": "<string>",
"token": "<string>",
"apiKey": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"tenantId": "<string>"
},
"index": "<string>",
"namespace": "<string>",
"ssl": true,
"verifySSL": true,
"timeout": 123,
"maxRetries": 123,
"connectionString": "<string>",
"isEnabled": true,
"createdBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"tags": [
"<string>"
]
}
]List data platform connections
Returns all data platform connections the user is entitled to (with credentials redacted).
A valid request URL is required to generate request examples[
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "mssql",
"scope": "personal",
"isPublic": true,
"owners": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"contributors": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"users": [
{
"id": "<string>",
"type": "group",
"displayName": "<string>",
"mail": "<string>",
"securityEnabled": true,
"mailEnabled": true,
"groupTypes": [
"<string>"
],
"groupType": "<string>",
"userPrincipalName": "<string>",
"jobTitle": "<string>",
"department": "<string>",
"officeLocation": "<string>"
}
],
"inheritEntitlements": true,
"endpoint": "<string>",
"port": 123,
"database": "<string>",
"cloudProvider": "aws",
"region": "<string>",
"workspace": "<string>",
"warehouse": "<string>",
"httpPath": "<string>",
"catalog": "<string>",
"schema": "<string>",
"s3OutputLocation": "<string>",
"authentication": {
"type": "username-password",
"username": "<string>",
"password": "<string>",
"token": "<string>",
"apiKey": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"tenantId": "<string>"
},
"index": "<string>",
"namespace": "<string>",
"ssl": true,
"verifySSL": true,
"timeout": 123,
"maxRetries": 123,
"connectionString": "<string>",
"isEnabled": true,
"createdBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"tags": [
"<string>"
]
}
]Authorizations
Azure AD access token obtained via MSAL
Response
Array of sanitized connections
DataPlatformType — database or vector store engine
mssql, postgres, mysql, mariadb, oracle, db2, sqlite, supabase, hana, duckdb, databricks, snowflake, redshift, synapse, fabric-warehouse, fabric-lakehouse, athena, bigquery, clickhouse, trino, adx, cosmosdb, mongodb, dynamodb, cassandra, couchdb, firebase, pinecone, weaviate, qdrant, chroma, elasticsearch, opensearch, pgvector, redis, milvus, mongodb_atlas, vertex_ai_search, aws_kendra, oracle_vector, vespa, lancedb, marqo personal, shared Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Hostname, URL, or workspace URL
Database / catalog / project name
aws, azure, gcp AWS/Azure/GCP region
Databricks workspace ID
Snowflake warehouse / Databricks SQL warehouse
Databricks HTTP path
Unity Catalog / BigQuery dataset
Default schema
Athena results S3 location
Show child attributes
Show child attributes
Index / collection / class name for vector stores
Namespace / partition (Pinecone namespace, Redis prefix)
Verify SSL certificates (default: true)
Connection timeout in milliseconds
Full connection string (alternative to individual fields)
Was this page helpful?