Connections

List Workspace Connections

GET /v1/workspaces/{workspaceId}/connections

Lists all connections in the specified workspace.

Parameters

NAME TYPE IN DESCRIPTION DEFAULT VALUE
workspaceId int32 path The workspace ID. None
take int32 query The number of connections to return in the response. 20
skip int32 query The number of connections to skip before returning results. 0

Responses

Code Message Action
200 OK Returns a list of connections in the workspace.

Response Example:

1
2
3
4
5
6
7
8
9
10
{
  "data": [
    {
      "id": 123,
      "name": "Connection 1",
      "connector": "SQL Server"
    }
  ],
  "hasMore": true
}

Request Example

1
2
curl -X GET "https://api.skyvia.com/v1/workspaces/123/connections?take=20&skip=0" \
  -H "Authorization: <access_token>"

Get Connection Details

GET /v1/workspaces/{workspaceId}/connections/{connectionId}

Retrieves details of a specific connection in the workspace.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
connectionId int32 path The connection ID to retrieve details for.

Responses

Code Message Action
200 OK Returns the details of the specified connection.

Response Example:

1
2
3
4
5
6
{
  "id": 123,
  "name": "Connection 1",
  "connector": "SQL Server",
  "type": "Direct"
}

Request Example

1
2
curl -X GET "https://api.skyvia.com/v1/workspaces/123/connections/456" \
  -H "Authorization: <access_token>"

Test Connection

POST /v1/workspaces/{workspaceId}/connections/{connectionId}/test

Tests the specified connection in the workspace to verify if it is functioning.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
connectionId int32 path The connection ID to test.

Responses

Code Message Action
200 OK Returns the result of the connection test.

Response Example:

1
2
3
4
{
  "message": "Connection successful",
  "refresh": false
}

Request Example

1
2
curl -X POST "https://api.skyvia.com/v1/workspaces/123/connections/456/test" \
  -H "Authorization: <access_token>"

On This Page