Airbyte - Stackone

Getting Started

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

OAuth 2.0 · Connector Profile

Uses the client ID and secret of an Airbyte application, which acts as the user who created it with that user’s roles. A…

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

OAuth 2.0 · Link Account

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

93 actions

Action

Description

List Applications

List the API applications belonging to the connected user

Get Application

Get one API application by id

Create Application

Create an API application for the connected user

Delete Application

Delete an API application

List Connections

List the Airbyte connections

Get Connection

Get one Airbyte connection by id

Create Connection

Create a connection between an Airbyte source and destination

Update Connection

Update an Airbyte connection

Delete Connection

Delete an Airbyte connection

List Connector Definitions

List the connector definitions available for sources or destinations

List Declarative Source Definitions

List the no-code declarative source definitions in a workspace

Get Declarative Source Definition

Get one declarative source definition by id

Create Declarative Source Definition

Create a no-code declarative source definition in a workspace

Update Declarative Source Definition

Update a declarative source definition manifest

Delete Declarative Source Definition

Delete a declarative source definition

List Destination Definitions

List the destination connector definitions available in a workspace

Get Destination Definition

Get one destination connector definition by id

Create Destination Definition

Update Destination Definition

Update a custom destination connector definition

Delete Destination Definition

Delete a custom destination connector definition

List Destinations

List the configured Airbyte destinations

Get Destination

Get one Airbyte destination by id

Create Destination

Create a destination in an Airbyte workspace

Update Destination

Partially update an Airbyte destination

Replace Destination

Replace an Airbyte destination in full

Delete Destination

Delete an Airbyte destination

Get Embedded Widget Token

Get a short-lived token for the Airbyte Embedded widget

Get Health Check

Check that the Airbyte API is reachable

Get Unified Credentials

Get the current Airbyte connection’s unified credentials and identity.

List Unified Groups

List unified groups in an Airbyte organization.

Get Unified Group

Get a unified Airbyte group by ID.

List Unified Organizations

List unified organizations in Airbyte.

Get Unified Organization

Get a unified Airbyte organization by ID.

List Unified Roles

List unified roles (Airbyte permission types) in Airbyte.

Get Unified Role

Get a unified Airbyte permission type by ID.

List Unified Users

List unified users in an Airbyte organization.

Get Unified User

Get a unified Airbyte user by ID.

List Jobs

List Airbyte sync and reset jobs

Get Job

Get one Airbyte job by id

Trigger Job

Trigger a sync, reset, refresh or clear job on a connection

Cancel Job

Cancel a running Airbyte job

List Organizations

List the Airbyte organizations the connected user belongs to

Set Organization OAuth Credentials

Override the OAuth app credentials used by a connector type across an organization

Delete Organization OAuth Credentials

Remove an organization OAuth credential override

List Permissions

List the role permissions held by an Airbyte user

Get Permission

Get one Airbyte permission by id

Create Permission

Grant an Airbyte user a role in an organization or workspace

Update Permission

Change the role on an existing Airbyte permission

Delete Permission

Revoke an Airbyte permission

List Regions

List the regions available to an Airbyte organization

List SCIM Users

List the SCIM user mappings in the organization

Get SCIM User

Get one SCIM user mapping by id

Create SCIM User

Provision a new user into the organization over SCIM

Replace SCIM User

Replace a SCIM user mapping in full

Patch SCIM User

Apply partial SCIM changes to a user

Delete SCIM User

Deprovision a user over SCIM

List SCIM Groups

List the SCIM groups in the organization

Get SCIM Group

Get one SCIM group by id

Create SCIM Group

Create a SCIM group in the organization

Replace SCIM Group

Replace a SCIM group in full

Patch SCIM Group

Apply partial SCIM changes to a group

Delete SCIM Group

Delete a SCIM group

List SCIM Resource Types

List the resource types the SCIM service supports

Get SCIM Resource Type

Get one SCIM resource type by id

List SCIM Schemas

List the SCIM schemas the service supports

Get SCIM Schema

Get one SCIM schema by URN

Get SCIM Service Provider Config

Get the SCIM features this Airbyte organization supports

List Source Definitions

List the source connector definitions available in a workspace

Get Source Definition

Get one source connector definition by id

Create Source Definition

Update Source Definition

Update a custom source connector definition

Delete Source Definition

Delete a custom source connector definition

List Sources

List the configured Airbyte sources

Get Source

Get one Airbyte source by id

Create Source

Create a source in an Airbyte workspace

Update Source

Partially update an Airbyte source

Replace Source

Replace an Airbyte source in full

Delete Source

Delete an Airbyte source

Initiate Source OAuth

Start the OAuth consent flow for a source connector

Get Stream Properties

Discover the streams a source exposes and the sync modes they support

List Tags

List the connection tags in a workspace

Get Tag

Get one connection tag by id

Create Tag

Create a connection tag in a workspace

Update Tag

Update a connection tag

Delete Tag

Delete a connection tag

List Users

List the members of an Airbyte organization

List Workspaces

List the Airbyte workspaces the connected user can access

Get Workspace

Get one Airbyte workspace by id

Create Workspace

Create an Airbyte workspace

Update Workspace

Update an Airbyte workspace

Delete Workspace

Delete an Airbyte workspace

Set Workspace OAuth Credentials

Override the OAuth app credentials used by a connector type in a workspace

Delete Workspace OAuth Credentials

Remove a workspace OAuth credential override

Events

3 events

Event

Description

​Getting Started

OAuth 2.0 · Connector Profile

OAuth 2.0 · Link Account

​Actions

​Events

Getting Started

Actions

Events