Airbyte

App · 20 actions

Run and watch your Airbyte data pipelines: start, cancel and list sync jobs, and create, update and delete sources, destinations and connections.

Actions

ActionWhat it does
Cancel jobCancel a job that is still running.
Create connectionConnect a source to a destination, syncing every stream Airbyte finds in the source, manually or on a cron schedule.
Create destinationCreate a destination of an Airbyte connector (a warehouse, a database, a lake) with that connector's settings.
Create sourceCreate a source of an Airbyte connector (a database, an app, a file store) with that connector's settings.
Delete connectionDelete a connection.
Delete destinationDelete a destination.
Delete sourceDelete a source.
Get connectionGet one connection with its status, schedule and the streams it syncs.
Get destinationGet one destination with its connector and settings (secrets hidden).
Get jobGet one job's status, duration, and the rows and bytes it synced.
Get sourceGet one source with its connector and settings (secrets hidden).
List connectionsList connections (a source synced to a destination) with their status and schedule, in one workspace or all.
List destinationsList destinations (where data is copied to), in one workspace or all.
List jobsList sync jobs with their status, duration and rows synced, filtered by connection, workspace, status, type or time.
List sourcesList sources (where data is copied from), in one workspace or all.
List workspacesList the Airbyte workspaces you can reach, with their ids.
Start syncStart a sync of a connection now, or a refresh (copy everything again) or clear (delete its synced data in the destination).
Update connectionRename, pause or resume a connection, or change its schedule, table prefix or what happens on schema changes.
Update destinationRename a destination or change some of its settings, keeping the rest.
Update sourceRename a source or change some of its settings, keeping the rest.

Cancel job

Cancel a job that is still running.

Inputs

Job IDjob_idnumberRequired
The job's number, from 'List jobs' or 'Start sync'.At least 1.

Outputs

jobobject
The job
Example output
{
  "job": {
    "bytesSynced": 52428800,
    "connectionId": "9e8d7c6b-5a49-4382-9170-6f5e4d3c2b1a",
    "duration": "PT4M31S",
    "jobId": 1234567,
    "jobType": "sync",
    "lastUpdatedAt": "2026-11-10T12:04:31Z",
    "rowsSynced": 120000,
    "startTime": "2026-11-10T12:00:00Z",
    "status": "cancelled"
  }
}

Create connection

Connect a source to a destination, syncing every stream Airbyte finds in the source, manually or on a cron schedule.

Inputs

Sourcesource_idtextRequired
The source. Pick one, or give its id from an earlier step.
Destinationdestination_idtextRequired
The destination. Pick one, or give its id from an earlier step.
Namenametext
The connection's name. Airbyte names it after the source and destination if left empty.
Scheduleschedule_typetext
Manual, or on the cron schedule given.One of: manual (Manual: only when started), cron (On a cron schedule).
Cron expressioncron_expressiontext
A Quartz cron expression in UTC, such as 0 0 12 * * ? for every day at noon. Giving one makes the schedule a cron schedule.
Statusstatustext
Active connections sync on their schedule; inactive ones are paused.One of: active, inactive (Inactive (paused)).
Destination namespacenamespace_definitiontext
Which schema or dataset the tables are written to.One of: destination (Destination default (default)), source (Same as the source), custom_format (Custom format).
Custom namespacenamespace_formattext
The schema name to write to, for a custom format, such as airbyte_sales. ${SOURCE_NAMESPACE} stands for the source's.
Table prefixprefixtext
Text put before each table's name in the destination, such as raw_.
When the source adds fieldsschema_changestext
What Airbyte does when the source gains new columns or streams.One of: ignore (Ignore: keep syncing as set up (default)), propagate_columns (Add new columns), propagate_fully (Add new columns and streams), disable_connection (Pause the connection).

Outputs

connectionobject
The connection
Example output
{
  "connection": {
    "configurations": {
      "streams": [
        {
          "cursorField": [
            "updated_at"
          ],
          "name": "orders",
          "namespace": "public",
          "primaryKey": [
            [
              "id"
            ]
          ],
          "syncMode": "incremental_append"
        }
      ]
    },
    "connectionId": "9e8d7c6b-5a49-4382-9170-6f5e4d3c2b1a",
    "createdAt": 1793000000,
    "destinationId": "4ab5c7d1-2f3e-4a6b-8c9d-0e1f2a3b4c5d",
    "name": "Sales Postgres to Snowflake",
    "namespaceDefinition": "destination",
    "namespaceFormat": "",
    "nonBreakingSchemaUpdatesBehavior": "ignore",
    "prefix": "",
    "schedule": {
      "basicTiming": "",
      "cronExpression": "0 0 12 * * ?",
      "scheduleType": "cron"
    },
    "sourceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "status": "active",
    "tags": [],
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
  }
}

Create destination

Create a destination of an Airbyte connector (a warehouse, a database, a lake) with that connector's settings.

Inputs

Workspaceworkspace_idtextRequired
The workspace to create it in. Pick one, or give its id.
NamenametextRequired
The destination's name in Airbyte.
Connectordestination_typetextRequired
The Airbyte connector, by the name in its docs address, such as bigquery, google-sheets or snowflake.
Settingsconfigurationobject
The connector's settings as keys and values, as Airbyte's docs for that connector list them (host, database, credentials...).

Outputs

destinationobject
The destination
Example output
{
  "destination": {
    "configuration": {
      "database": "RAW",
      "host": "acme.snowflakecomputing.com"
    },
    "createdAt": 1793000000,
    "definitionId": "424892c4-daac-4491-b35d-c6688ba547ba",
    "destinationId": "4ab5c7d1-2f3e-4a6b-8c9d-0e1f2a3b4c5d",
    "destinationType": "snowflake",
    "name": "Analytics Snowflake",
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
  }
}

Create source

Create a source of an Airbyte connector (a database, an app, a file store) with that connector's settings.

Inputs

Workspaceworkspace_idtextRequired
The workspace to create it in. Pick one, or give its id.
NamenametextRequired
The source's name in Airbyte.
Connectorsource_typetextRequired
The Airbyte connector, by the name in its docs address, such as postgres, google-sheets or snowflake.
Settingsconfigurationobject
The connector's settings as keys and values, as Airbyte's docs for that connector list them (host, database, credentials...).

Outputs

sourceobject
The source
Example output
{
  "source": {
    "configuration": {
      "database": "sales",
      "host": "db.example.com",
      "port": 5432
    },
    "createdAt": 1793000000,
    "definitionId": "decd338e-5647-4c0b-adf4-da0e75f5a750",
    "name": "Sales Postgres",
    "sourceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "sourceType": "postgres",
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
  }
}

Delete connection

Delete a connection. Its source and destination are kept.

Inputs

Connectionairbyte_connection_idtextRequired
The connection. Pick one, or give its id from an earlier step.

Outputs

connection_idtext
The connection deleted
deletedtrue/false
Always true once deleted
Example output
{
  "connection_id": "9e8d7c6b-5a49-4382-9170-6f5e4d3c2b1a",
  "deleted": true
}

Delete destination

Delete a destination. Airbyte deletes the connections that use it too.

Inputs

Destinationdestination_idtextRequired
The destination. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
destination_idtext
The destination deleted
Example output
{
  "deleted": true,
  "destination_id": "4ab5c7d1-2f3e-4a6b-8c9d-0e1f2a3b4c5d"
}

Delete source

Delete a source. Airbyte deletes the connections that use it too.

Inputs

Sourcesource_idtextRequired
The source. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
source_idtext
The source deleted
Example output
{
  "deleted": true,
  "source_id": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826"
}

Get connection

Get one connection with its status, schedule and the streams it syncs.

Inputs

Connectionairbyte_connection_idtextRequired
The connection. Pick one, or give its id from an earlier step.

Outputs

connectionobject
The connection
Example output
{
  "connection": {
    "configurations": {
      "streams": [
        {
          "cursorField": [
            "updated_at"
          ],
          "name": "orders",
          "namespace": "public",
          "primaryKey": [
            [
              "id"
            ]
          ],
          "syncMode": "incremental_append"
        }
      ]
    },
    "connectionId": "9e8d7c6b-5a49-4382-9170-6f5e4d3c2b1a",
    "createdAt": 1793000000,
    "destinationId": "4ab5c7d1-2f3e-4a6b-8c9d-0e1f2a3b4c5d",
    "name": "Sales Postgres to Snowflake",
    "namespaceDefinition": "destination",
    "namespaceFormat": "",
    "nonBreakingSchemaUpdatesBehavior": "ignore",
    "prefix": "",
    "schedule": {
      "basicTiming": "",
      "cronExpression": "0 0 12 * * ?",
      "scheduleType": "cron"
    },
    "sourceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "status": "active",
    "tags": [],
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
  }
}

Get destination

Get one destination with its connector and settings (secrets hidden).

Inputs

Destinationdestination_idtextRequired
The destination. Pick one, or give its id from an earlier step.

Outputs

destinationobject
The destination
Example output
{
  "destination": {
    "configuration": {
      "database": "RAW",
      "host": "acme.snowflakecomputing.com"
    },
    "createdAt": 1793000000,
    "definitionId": "424892c4-daac-4491-b35d-c6688ba547ba",
    "destinationId": "4ab5c7d1-2f3e-4a6b-8c9d-0e1f2a3b4c5d",
    "destinationType": "snowflake",
    "name": "Analytics Snowflake",
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
  }
}

Get job

Get one job's status, duration, and the rows and bytes it synced.

Inputs

Job IDjob_idnumberRequired
The job's number, from 'List jobs' or 'Start sync'.At least 1.

Outputs

jobobject
The job
Example output
{
  "job": {
    "bytesSynced": 52428800,
    "connectionId": "9e8d7c6b-5a49-4382-9170-6f5e4d3c2b1a",
    "duration": "PT4M31S",
    "jobId": 1234567,
    "jobType": "sync",
    "lastUpdatedAt": "2026-11-10T12:04:31Z",
    "rowsSynced": 120000,
    "startTime": "2026-11-10T12:00:00Z",
    "status": "succeeded"
  }
}

Get source

Get one source with its connector and settings (secrets hidden).

Inputs

Sourcesource_idtextRequired
The source. Pick one, or give its id from an earlier step.

Outputs

sourceobject
The source
Example output
{
  "source": {
    "configuration": {
      "database": "sales",
      "host": "db.example.com",
      "port": 5432
    },
    "createdAt": 1793000000,
    "definitionId": "decd338e-5647-4c0b-adf4-da0e75f5a750",
    "name": "Sales Postgres",
    "sourceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "sourceType": "postgres",
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
  }
}

List connections

List connections (a source synced to a destination) with their status and schedule, in one workspace or all.

Inputs

Workspaceworkspace_idtext
Only this workspace. Leave empty for every workspace you can see.
Include deletedinclude_deletedtrue/false
Also list ones that were deleted.
Page sizelimitnumber
How many to return, 1 to 100. Airbyte's default is 20.From 1 to 100.
Offsetoffsetnumber
How many to skip: the 'next_offset' of an earlier page.At least 0.

Outputs

connectionslist
The connections
countnumber
How many on this page
has_moretrue/false
True when another page follows
next_offsetnumber
The offset of the next page, 0 when there is none
Example output
{
  "connections": [
    {
      "configurations": {
        "streams": [
          {
            "cursorField": [
              "updated_at"
            ],
            "name": "orders",
            "namespace": "public",
            "primaryKey": [
              [
                "id"
              ]
            ],
            "syncMode": "incremental_append"
          }
        ]
      },
      "connectionId": "9e8d7c6b-5a49-4382-9170-6f5e4d3c2b1a",
      "createdAt": 1793000000,
      "destinationId": "4ab5c7d1-2f3e-4a6b-8c9d-0e1f2a3b4c5d",
      "name": "Sales Postgres to Snowflake",
      "namespaceDefinition": "destination",
      "namespaceFormat": "",
      "nonBreakingSchemaUpdatesBehavior": "ignore",
      "prefix": "",
      "schedule": {
        "basicTiming": "",
        "cronExpression": "0 0 12 * * ?",
        "scheduleType": "cron"
      },
      "sourceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
      "status": "active",
      "tags": [],
      "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_offset": 0
}

List destinations

List destinations (where data is copied to), in one workspace or all.

Inputs

Workspaceworkspace_idtext
Only this workspace. Leave empty for every workspace you can see.
Include deletedinclude_deletedtrue/false
Also list ones that were deleted.
Page sizelimitnumber
How many to return, 1 to 100. Airbyte's default is 20.From 1 to 100.
Offsetoffsetnumber
How many to skip: the 'next_offset' of an earlier page.At least 0.

Outputs

countnumber
How many on this page
destinationslist
The destinations
has_moretrue/false
True when another page follows
next_offsetnumber
The offset of the next page, 0 when there is none
Example output
{
  "count": 1,
  "destinations": [
    {
      "configuration": {
        "database": "RAW",
        "host": "acme.snowflakecomputing.com"
      },
      "createdAt": 1793000000,
      "definitionId": "424892c4-daac-4491-b35d-c6688ba547ba",
      "destinationId": "4ab5c7d1-2f3e-4a6b-8c9d-0e1f2a3b4c5d",
      "destinationType": "snowflake",
      "name": "Analytics Snowflake",
      "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
    }
  ],
  "has_more": false,
  "next_offset": 0
}

List jobs

List sync jobs with their status, duration and rows synced, filtered by connection, workspace, status, type or time.

Inputs

Connectionairbyte_connection_idtext
Only jobs of this connection.
Workspaceworkspace_idtext
Only this workspace. Leave empty for every workspace you can see.
Statusstatustext
Only jobs in this status.One of: pending, running, incomplete (Incomplete (an attempt failed, retrying)), failed, succeeded, cancelled.
Typejob_typetext
Only jobs of this type.One of: sync, refresh, clear, reset (Reset (older name for clear)).
Started aftercreated_afterdate and time
Only jobs started at or after this time.
Started beforecreated_beforedate and time
Only jobs started at or before this time.
Updated afterupdated_afterdate and time
Only jobs that changed (such as finished) after this time.
Orderorder_bytext
How to sort the jobs. Defaults to newest first.One of: createdAt|DESC (Newest first (default)), createdAt|ASC (Oldest first), updatedAt|DESC (Most recently updated first).
Page sizelimitnumber
How many to return, 1 to 100. Airbyte's default is 20.From 1 to 100.
Offsetoffsetnumber
How many to skip: the 'next_offset' of an earlier page.At least 0.

Outputs

countnumber
How many on this page
has_moretrue/false
True when another page follows
jobslist
The jobs
next_offsetnumber
The offset of the next page, 0 when there is none
Example output
{
  "count": 1,
  "has_more": false,
  "jobs": [
    {
      "bytesSynced": 52428800,
      "connectionId": "9e8d7c6b-5a49-4382-9170-6f5e4d3c2b1a",
      "duration": "PT4M31S",
      "jobId": 1234567,
      "jobType": "sync",
      "lastUpdatedAt": "2026-11-10T12:04:31Z",
      "rowsSynced": 120000,
      "startTime": "2026-11-10T12:00:00Z",
      "status": "succeeded"
    }
  ],
  "next_offset": 0
}

List sources

List sources (where data is copied from), in one workspace or all.

Inputs

Workspaceworkspace_idtext
Only this workspace. Leave empty for every workspace you can see.
Include deletedinclude_deletedtrue/false
Also list ones that were deleted.
Page sizelimitnumber
How many to return, 1 to 100. Airbyte's default is 20.From 1 to 100.
Offsetoffsetnumber
How many to skip: the 'next_offset' of an earlier page.At least 0.

Outputs

countnumber
How many on this page
has_moretrue/false
True when another page follows
next_offsetnumber
The offset of the next page, 0 when there is none
sourceslist
The sources
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "sources": [
    {
      "configuration": {
        "database": "sales",
        "host": "db.example.com",
        "port": 5432
      },
      "createdAt": 1793000000,
      "definitionId": "decd338e-5647-4c0b-adf4-da0e75f5a750",
      "name": "Sales Postgres",
      "sourceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
      "sourceType": "postgres",
      "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
    }
  ]
}

List workspaces

List the Airbyte workspaces you can reach, with their ids.

Inputs

Include deletedinclude_deletedtrue/false
Also list ones that were deleted.
Page sizelimitnumber
How many to return, 1 to 100. Airbyte's default is 20.From 1 to 100.
Offsetoffsetnumber
How many to skip: the 'next_offset' of an earlier page.At least 0.

Outputs

countnumber
How many on this page
has_moretrue/false
True when another page follows
next_offsetnumber
The offset of the next page, 0 when there is none
workspaceslist
The workspaces
Example output
{
  "count": 1,
  "has_more": false,
  "next_offset": 0,
  "workspaces": [
    {
      "dataResidency": "auto",
      "name": "Acme Data",
      "notifications": {},
      "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
    }
  ]
}

Start sync

Start a sync of a connection now, or a refresh (copy everything again) or clear (delete its synced data in the destination). Airbyte runs one job per connection at a time.

Inputs

Connectionairbyte_connection_idtextRequired
The connection. Pick one, or give its id from an earlier step.
Jobjob_typetext
What to run. Defaults to a sync.One of: sync (Sync: copy new data (default)), refresh (Refresh: copy all data again), clear (Clear: delete the synced data in the destination). Default: sync.

Outputs

jobobject
The job
Example output
{
  "job": {
    "bytesSynced": 52428800,
    "connectionId": "9e8d7c6b-5a49-4382-9170-6f5e4d3c2b1a",
    "duration": "",
    "jobId": 1234567,
    "jobType": "sync",
    "lastUpdatedAt": "2026-11-10T12:04:31Z",
    "rowsSynced": 120000,
    "startTime": "2026-11-10T12:00:00Z",
    "status": "running"
  }
}

Update connection

Rename, pause or resume a connection, or change its schedule, table prefix or what happens on schema changes.

Inputs

Connectionairbyte_connection_idtextRequired
The connection. Pick one, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Statusstatustext
Active connections sync on their schedule; inactive ones are paused.One of: active, inactive (Inactive (paused)).
Scheduleschedule_typetext
Manual, or on the cron schedule given.One of: manual (Manual: only when started), cron (On a cron schedule).
Cron expressioncron_expressiontext
A Quartz cron expression in UTC, such as 0 0 12 * * ? for every day at noon. Giving one makes the schedule a cron schedule.
Table prefixprefixtext
Text put before each table's name in the destination, such as raw_.
When the source adds fieldsschema_changestext
What Airbyte does when the source gains new columns or streams.One of: ignore (Ignore: keep syncing as set up (default)), propagate_columns (Add new columns), propagate_fully (Add new columns and streams), disable_connection (Pause the connection).

Outputs

connectionobject
The connection
Example output
{
  "connection": {
    "configurations": {
      "streams": [
        {
          "cursorField": [
            "updated_at"
          ],
          "name": "orders",
          "namespace": "public",
          "primaryKey": [
            [
              "id"
            ]
          ],
          "syncMode": "incremental_append"
        }
      ]
    },
    "connectionId": "9e8d7c6b-5a49-4382-9170-6f5e4d3c2b1a",
    "createdAt": 1793000000,
    "destinationId": "4ab5c7d1-2f3e-4a6b-8c9d-0e1f2a3b4c5d",
    "name": "Sales Postgres to Snowflake",
    "namespaceDefinition": "destination",
    "namespaceFormat": "",
    "nonBreakingSchemaUpdatesBehavior": "ignore",
    "prefix": "",
    "schedule": {
      "basicTiming": "",
      "cronExpression": "0 0 12 * * ?",
      "scheduleType": "cron"
    },
    "sourceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "status": "active",
    "tags": [],
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
  }
}

Update destination

Rename a destination or change some of its settings, keeping the rest.

Inputs

Destinationdestination_idtextRequired
The destination. Pick one, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Settings to changeconfigurationobject
Only the settings to change, as keys and values. Leave empty to keep them all.

Outputs

destinationobject
The destination
Example output
{
  "destination": {
    "configuration": {
      "database": "RAW",
      "host": "acme.snowflakecomputing.com"
    },
    "createdAt": 1793000000,
    "definitionId": "424892c4-daac-4491-b35d-c6688ba547ba",
    "destinationId": "4ab5c7d1-2f3e-4a6b-8c9d-0e1f2a3b4c5d",
    "destinationType": "snowflake",
    "name": "Analytics Snowflake",
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
  }
}

Update source

Rename a source or change some of its settings, keeping the rest.

Inputs

Sourcesource_idtextRequired
The source. Pick one, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Settings to changeconfigurationobject
Only the settings to change, as keys and values. Leave empty to keep them all.

Outputs

sourceobject
The source
Example output
{
  "source": {
    "configuration": {
      "database": "sales",
      "host": "db.example.com",
      "port": 5432
    },
    "createdAt": 1793000000,
    "definitionId": "decd338e-5647-4c0b-adf4-da0e75f5a750",
    "name": "Sales Postgres",
    "sourceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "sourceType": "postgres",
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
  }
}

On this page