Integrations

List Workspace Integrations

GET /v1/workspaces/{workspaceId}/integrations

Lists all integrations in the specified workspace.

Parameters

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

Responses

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

Response Example:

1
2
3
4
5
6
7
8
9
10
11
12
13

{
  "data": [
    {
      "id": 123,
      "name": "Data Integration 1",
      "type": "import",
      "created": "2023-10-02T14:15:15.307Z",
      "modified": "2023-10-03T14:15:15.307Z",
      "scheduled": true
    }
  ],
  "hasMore": true
}

Request Example

1
2

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

Get Integration Details

GET /v1/workspaces/{workspaceId}/integrations/{integrationId}

Retrieves details of a specific integration in the workspace.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
integrationId int32 path The integration ID to retrieve details for.

Responses

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

Response Example:

1
2
3
4
5
6
7
8

{
  "id": 123,
  "name": "Data Integration 1",
  "type": "import",
  "created": "2023-10-02T14:15:15.307Z",
  "modified": "2023-10-03T14:15:15.307Z",
  "scheduled": true
}

Request Example

1
2

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

List Integration Executions

GET /v1/workspaces/{workspaceId}/integrations/{integrationId}/executions

Lists all finished executions for the specified integration.

Parameters

NAME TYPE IN DESCRIPTION DEFAULT VALUE
workspaceId int32 path The workspace ID. None
integrationId int32 path The integration ID to retrieve executions for. None
startDate date-time query Start date for filtering executions. None
endDate date-time query End date for filtering executions. None
failed boolean query Whether to filter executions by failed status. None
take int32 query The number of executions to return. 20
skip int32 query The number of executions to skip. 0
sortOrder string query Specifies how the result records are sorted. Allowed values are ‘asc’ and ‘desc’ (without quotes). asc
sortBy string query The field, by which the result records are sorted. Allowed values are ‘startDate’ and ‘executionId’ (without quotes). startDate

Responses

Code Message Action
200 OK Returns a list of integration executions.

Response Example:

1
2
3
4
5
6
7
8
9
10
11
12

{
  "data": [
    {
      "runId": 123,
      "date": "2023-10-02T14:15:15.307Z",
      "state": "Succeeded",
      "successRows": 100,
      "errorRows": 0
    }
  ],
  "hasMore": true
}

Request Example

1
2

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

Run Integration

POST /v1/workspaces/{workspaceId}/integrations/{integrationId}/executions

Runs specified integration in the workspace.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
integrationId int32 path The integration ID.

Responses

Code Message Action
200 OK Returns the details of the execution.

Response Example:

1
2
3
4
5
6
7
8

{
  "runId": 0,
  "date": "2024-10-04T09:53:28.371Z",
  "duration": 0,
  "state": "New",
  "successRows": 0,
  "errorRows": 0
}

Request Example

1
2
3

curl -X POST "https://api.skyvia.com/v1/workspaces/123/integrations/456/executions" \
  -H "Authorization: <access_token>" \
  -H "Content-Type: application/json" \

Get Active Integration Executions

GET /v1/workspaces/{workspaceId}/integrations/{integrationId}/executions/active

Lists active integration executions in the specified integration (having status Queued, Running, or Canceling).

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
integrationId int32 path The integration ID to retrieve active executions for.

Responses

Code Message Action
200 OK Returns a list of active integration executions.

Response Example:

1
2
3
4
5
6
7

{
  "runId": 123,
  "date": "2023-10-02T14:15:15.307Z",
  "state": "Executing",
  "successRows": 100,
  "errorRows": 0
}

Request Example

1
2

curl -X GET "https://api.skyvia.com/v1/workspaces/123/integrations/456/executions/active" \
  -H "Authorization: <access_token>"

Cancel Integration Execution

POST /v1/workspaces/{workspaceId}/integrations/{integrationId}/executions/cancel

Cancels the active execution of the specified integration.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
integrationId int32 path The integration ID for which the active execution is being canceled.

Responses

Code Message Action
200 OK The active execution is successfully canceled.

Request Example

1
2

curl -X POST "https://api.skyvia.com/v1/workspaces/123/integrations/456/executions/cancel" \
  -H "Authorization: <access_token>"

Kill Integration Execution

POST /v1/workspaces/{workspaceId}/integrations/{integrationId}/executions/kill

Forces termination of the active integration execution in the specified integration.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
integrationId int32 path The integration ID for which the active execution is being killed.

Responses

Code Message Action
200 OK The active execution is successfully killed.

Request Example

1
2

curl -X POST "https://api.skyvia.com/v1/workspaces/123/integrations/456/executions/kill" \
  -H "Authorization: <access_token>"

Get Integration Schedule Status

GET /v1/workspaces/{workspaceId}/integrations/{integrationId}/schedule

Retrieves the schedule status of the specified integration. Note that the request executes successfully only if the integration has a schedule defined whether enabled or disabled.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
integrationId int32 path The integration ID to retrieve the schedule for.

Responses

Code Message Action
200 OK Returns the schedule details of the integration.
204 No Content Schedule is not defined for the integration.

Response Example:

1
2
3

{
  "active": true
}

Request Example

1
2

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

Enable Integration Schedule

POST /v1/workspaces/{workspaceId}/integrations/{integrationId}/schedule/enable

Enables the schedule for the specified integration. A schedule must be defined for the integration; otherwise, the call results in the 404 error.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
integrationId int32 path The integration ID for which the schedule is being enabled.

Responses

Code Message Action
200 OK The schedule for the integration is enabled.
404 Not Found The schedule for the integration is not defined.

Request Example

1
2

curl -X POST "https://api.skyvia.com/v1/workspaces/123/integrations/456/schedule/enable" \
  -H "Authorization: <access_token>"

Disable Integration Schedule

POST /v1/workspaces/{workspaceId}/integrations/{integrationId}/schedule/disable

Disables the schedule for the specified integration.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
integrationId int32 path The integration ID for which the schedule is being disabled.

Responses

Code Message Action
200 OK The schedule for the integration is disabled.

Request Example

1
2

curl -X POST "https://api.skyvia.com/v1/workspaces/123/integrations/456/schedule/disable" \
  -H "Authorization: <access_token>"

On This Page