Endpoints

List Endpoint Types

GET /v1/endpoints/types

Lists all available endpoint types.

Request Example

1
2
curl -X GET "https://api.skyvia.com/v1/endpoints/types" \
  -H "Authorization: <access_token>"

Responses

Code Message Action
200 OK Returns the list of endpoint types.

Response Example:

1
2
3
4
{
  "OData": 1,
  "Sql": 2
}

List Workspace Endpoints

GET /v1/workspaces/{workspaceId}/endpoints

Lists all endpoints in the specified workspace.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
skip int32 query Number of items to skip.
take int32 query Number of items to return.

Request Example

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

Responses

Code Message Action
200 OK Returns the list of endpoints.

Response Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "data": [
    {
      "id": 1,
      "name": "OData Endpoint",
      "token": "abcdefg",
      "active": true,
      "type": "OData",
      "created": "2024-10-03T12:34:56Z",
      "modified": "2024-10-04T09:23:12Z"
    }
  ],
  "hasMore": true
}

Get Endpoint Details

GET /v1/workspaces/{workspaceId}/endpoints/{endpointId}

Retrieves the details of a specific endpoint in the workspace.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
endpointId int32 path The endpoint ID.

Request Example

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

Responses

Code Message Action
200 OK Returns the endpoint details.

Response Example:

1
2
3
4
5
6
7
8
9
{
  "id": 456,
  "name": "OData Endpoint",
  "token": "abcdefg",
  "active": true,
  "type": "OData",
  "created": "2024-10-03T12:34:56Z",
  "modified": "2024-10-04T09:23:12Z"
}

Enable Endpoint

POST /v1/workspaces/{workspaceId}/endpoints/{endpointId}/enable

Enables a specific endpoint in the workspace.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
endpointId int32 path The endpoint ID.

Request Example

1
2
3
curl -X POST "https://api.skyvia.com/v1/workspaces/123/endpoints/456/enable" \
  -H "Authorization: <access_token>" \
  -H "Content-Type: application/json"

Responses

Code Message Action
200 OK Endpoint enabled successfully.

Disable Endpoint

POST /v1/workspaces/{workspaceId}/endpoints/{endpointId}/disable

Disables a specific endpoint in the workspace.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
endpointId int32 path The endpoint ID.

Request Example

1
2
3
curl -X POST "https://api.skyvia.com/v1/workspaces/123/endpoints/456/disable" \
  -H "Authorization: <access_token>" \
  -H "Content-Type: application/json"

Responses

Code Message Action
200 OK Endpoint disabled successfully.

List Endpoint Executions

GET /v1/workspaces/{workspaceId}/endpoints/{endpointId}/executions

Lists all executions of the specified endpoint in the workspace.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
endpointId int32 path The endpoint ID.
startDate date-time query Start date for filtering executions.
endDate date-time query End date for filtering executions.
failed boolean query Whether to filter executions by failed status.
skip int32 query Number of items to skip.
take int32 query Number of items to return.
sortOrder string query Specifies how the result records are sorted. Allowed values are 'asc' and 'desc' (without quotes).
sortBy string query The field, by which the result records are sorted. Allowed values are 'date' and 'executionId' (without quotes).

Request Example

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

Responses

Code Message Action
200 OK Returns the list of executions.

Response Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "data": [
    {
      "executionId": "abc123",
      "date": "2024-10-04T09:00:00Z",
      "method": "GET",
      "failed": false,
      "bytes": 1024,
      "remoteIP": "192.168.0.1",
      "url": "https://api.skyvia.com/v1/endpoints/456/data"
    }
  ],
  "hasMore": true
}

Get Endpoint Execution Details

GET /v1/workspaces/{workspaceId}/endpoints/{endpointId}/executions/{executionId}

Retrieves the details of the specified endpoint execution.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
endpointId int32 path The endpoint ID.
executionId string path The execution record ID.

Request Example

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

Responses

Code Message Action
200 OK Returns the execution details.

Response Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "endpointId": 456,
  "workspaceId": 123,
  "date": "2024-10-04T09:00:00Z",
  "url": "https://api.skyvia.com/v1/endpoints/456/data",
  "method": "GET",
  "remoteIP": "192.168.0.1",
  "userAgent": "Mozilla/5.0",
  "user": "admin",
  "error": null,
  "errorDetails": null,
  "log": ["Step 1: OK", "Step 2: OK"],
  "bytes": 1024,
  "rows": 50
}

On This Page