Automations

List Automations

GET /v1/workspaces/{workspaceId}/automations

Lists all automations within the specified workspace. This endpoint supports pagination to retrieve a subset of automations based on the query parameters provided.

Parameters

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

Responses

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

Response Example:

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

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "triggerType": "Manual",
      "created": "2023-10-02T14:15:15.307Z",
      "modified": "2023-10-02T14:15:15.307Z"
    }
  ],
  "hasMore": true
}

Request Example

1
2

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

Get Automation Details

GET /v1/workspaces/{workspaceId}/automations/{automationId}

Retrieves the details of a specific automation in a workspace, identified by automationId.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
automationId int32 path The automation ID to retrieve details for.

Responses

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

Response Example:

1
2
3
4
5
6
7

{
  "id": 0,
  "name": "string",
  "triggerType": "Manual",
  "created": "2023-10-02T14:15:15.307Z",
  "modified": "2023-10-02T14:15:15.307Z"
}

Request Example

1
2

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

Enable Automation

POST /v1/workspaces/{workspaceId}/automations/{automationId}/enable

Enables the specified automation in a workspace, making it active.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
automationId int32 path The automation ID to enable.

Responses

Code Message Action
200 OK Confirms that the automation was enabled.

Request Example

1
2

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

Disable Automation

POST /v1/workspaces/{workspaceId}/automations/{automationId}/disable

Disables the specified automation in a workspace, making it inactive.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
automationId int32 path The automation ID to disable.

Responses

Code Message Action
200 OK Confirms that the automation was disabled.

Request Example

1
2

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

List Automation Executions

GET /v1/workspaces/{workspaceId}/automations/{automationId}/executions

Lists finished executions of a specified automation. Supports filtering by date range and execution status and sorting.

Parameters

NAME TYPE IN DESCRIPTION DEFAULT VALUE
workspaceId int32 path The workspace ID. None
automationId int32 path The automation ID. None
startDate string query The start date for filtering executions (ISO 8601 format). None
endDate string query The end date for filtering executions (ISO 8601 format). None
failed boolean query Whether to filter by failed executions only. None
take int32 query The number of executions to return in the response. 20
skip int32 query The number of executions to skip before returning results. 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 ‘date’ and ‘executionId’ (without quotes). date

Responses

Code Message Action
200 OK Returns a list of execution logs for the automation.

Response Example:

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

{
  "data": [
    {
      "executionId": 123456,
      "state": "Succeeded",
      "date": "2023-10-02T14:15:15.307Z",
      "billedTasks": 100,
      "testMode": false
    }
  ],
  "hasMore": true
}

Request Example

1
2

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

Get Automation Execution Details

GET /v1/workspaces/{workspaceId}/automations/{automationId}/executions/{executionId}

Retrieves detailed information of a specific automation execution.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
automationId int32 path The automation ID.
executionId int64 path The execution ID to retrieve details for.

Responses

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

Response Example:

1
2
3
4
5
6
7
8
9
10
11

{
  "executionId": 123456,
  "state": "Succeeded",
  "version": 1,
  "testMode": false,
  "comment": "Execution completed successfully.",
  "started": "2023-10-02T14:15:15.307Z",
  "executed": "2023-10-02T14:30:15.307Z",
  "billedTasks": 100,
  "result": "Data processed successfully."
}

Request Example

1
2

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

Get Automation State

GET /v1/workspaces/{workspaceId}/automations/{automationId}/state

Retrieves the current state of the specified automation, including the execution status and queue information.

Parameters

NAME TYPE IN DESCRIPTION
workspaceId int32 path The workspace ID.
automationId int32 path The automation ID to retrieve state for.

Responses

Code Message Action
200 OK Returns the current state of the automation.

Response Example:

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

{
  "trigger": {
    "enabled": true
  },
  "queue": {
    "queuedCount": 5
  },
  "executing": {
    "executionId": 789,
    "date": "2023-10-02T14:15:15.307Z",
    "state": "Executing",
    "testMode": false
  },
  "testMode": false
}

Request Example

1
2

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

On This Page