Query the connection list¶
Query the agent connections saved in the current workspace.
HTTP
GET $CLOUDSIGMA_API_BASE/workspaces/{workspace_id}/connections
Before you call this API¶
Configure the regional API endpoint and authentication, and select the target workspace.
The example below uses $CLOUDSIGMA_API_KEY and $WORKSPACE_ID.
Request¶
Shell
curl "$CLOUDSIGMA_API_BASE/workspaces/$WORKSPACE_ID/connections" -H "X-API-Key: $CLOUDSIGMA_API_KEY" -H "X-Workspace-ID: $WORKSPACE_ID"
Successful response¶
Returns 200 and the connection list on success.
JSON
{"code":0,"data":{"items":[],"total":0}}
The response fields are as follows.
Field |
Type |
Description |
|---|---|---|
|
array |
Current page connection. |
|
integer |
The total number of matches. |
Error response¶
JSON
{"code":6,"message":"unauthenticated"}
Last updated on