Logo
MicroStrategy REST API API Documentation

Get a datasource connection for given ID

GET {{baseUrl}}/api/datasources/connections/:id

Get a datasource connection for given id. You obtain the authorization token needed to execute the request using POST /auth/login. You pass the authorization token in the request header. You specify the database source ID in the path of the request; you obtain the datasource login ID using GET /datasources/connections

 

Body PARAM

Key Datatype Required Description 
fields
null Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model.



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization token




RESPONSES

status OK

{ "name": "Test Datasource Connection", "id": "B5FBC35F1B439F5A4E6AC4B072193C96", "description": "Test datasource connection.", "acg": 0, "executionMode": "synchronous", "maxCancelAttemptTime": 60, "maxQueryExeTime": 0, "maxConnectionAttemptTime": 60, "connectionLifetime": 36000, "connectionIdleTimeout": 60000, "charEncodingWindows": "multibyte", "charEncodingUnix": "utf8", "tablePrefix": "", "connectionString": "", "parameterizedQueries": false, "extendedFetch": false, "database": { "login": {}, "type": "sql_server", "version": "default" }, "driverType": "odbc", "oauthParameter": "" }



Curl
curl -X GET 'baseUrl/api/datasources/connections/:id?fields=' -H 'X-MSTR-AuthToken: authToken'

ENDPOINTS