get /connections
Gets the list of connections.
Returns the list of connections. The list can be filtered by a particular app, and is sorted in the order specified by the sort parameter.
Query parameters
- offset (optional)
- The number of entries to skip. Default is 0.
- limit (optional)
- The maximum number of entries to return. Default is 50.
- sort (optional)
A comma separated list of fields to be used for sorting the connections. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order. Default is -created.
Usage example: /connections?sort=+name,-created
- appId (optional)
- The ID of the app to filter on.
Return type
Example data
Content-Type: application/json
{
"data" : {
"totalItems" : 0,
"offset" : 6,
"limit" : 1,
"items" : [ {
"connectionString" : "connectionString",
"created" : "2000-01-23T04:56:07.000+00:00",
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"appId" : "appId",
"name" : "name",
"connectionStatus" : "Unknown",
"description" : "description",
"notificationsEnabled" : true,
"cacheStatus" : "NeverGenerated",
"id" : "00000000-0000-0000-0000-000000000000",
"source" : "source"
}, {
"connectionString" : "connectionString",
"created" : "2000-01-23T04:56:07.000+00:00",
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"appId" : "appId",
"name" : "name",
"connectionStatus" : "Unknown",
"description" : "description",
"notificationsEnabled" : true,
"cacheStatus" : "NeverGenerated",
"id" : "00000000-0000-0000-0000-000000000000",
"source" : "source"
} ]
}
}
Responses
- 200
- Success. A paginated list of connections is returned.
- 400
- The specified ID is not a valid GUID.