Skip to main content

Workflow sample - Retrieve a gateway's definition

Available since 2021 Update 9

This workflow sample demonstrates how to retrieve a gateway's definition.

tip

Obtain the authorization token needed to execute the request using POST /api/auth/login.

Obtain the gateway ID needed to execute the request using GET /api/gateways.

Retrieve a gateway's definition GET /api/gateways/{id}​

Sample Request Header:

"accept": "application/json"
"X-MSTR-AuthToken": "pisu5dkkutqfblaamdomgr00ch"

Sample Request Body: Empty

Sample Curl:

curl -X "GET" \
  "http://demo.microstrategy.com/MicroStrategyLibrary/api/gateways/EAD0E3D84E8B47D1A1A860CEF66FE602" \
  -H "accept: application/json" \
  -H "X-MSTR-AuthToken: pisu5dkkutqfblaamdomgr00ch"

Sample Response Body:

You can get the gateway's definition in the body of the response.

{
  "name": "Microsoft SQL Server 2012",
  "id": "EAD0E3D84E8B47D1A1A860CEF66FE602",
  "type": "Relational",
  "certifiedAsGateway": true,
  "dbType": "sql_server"
}

Sample Response Code: 200