Airbyte Configuration API

Airbyte Configuration API https://airbyte.io.

This API is a collection HTTP RPC-style methods. While it is not a REST API, those familiar with REST should find the conventions of this API recognizable.

Here are some conventions that this API follows:

Change Management:

More information: https://openapi-generator.tech
Contact Info: contact@airbyte.io
Version: 1.0.0-oas3
BasePath:/api
MIT
https://opensource.org/licenses/MIT

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Connection

Deployment

Destination

DestinationDefinition

DestinationDefinitionSpecification

Health

Jobs

Logs

Notifications

Openapi

Operation

Scheduler

Source

SourceDefinition

SourceDefinitionSpecification

WebBackend

Workspace

Connection

Up 
post /v1/connections/create
Create a connection between a source and a destination (createConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConnectionCreate ConnectionCreate (required)
Body Parameter —

Return type

ConnectionRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "prefix" : "prefix",
  "name" : "name",
  "syncCatalog" : {
    "streams" : [ {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    }, {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "operationIds" : [ null, null ],
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation ConnectionRead

422

Invalid Input
Up 
post /v1/connections/delete
Delete a connection (deleteConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Responses

204

The resource was deleted successfully.

404

Connection not found

422

Invalid Input
Up 
post /v1/connections/get
Get a connection (getConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

ConnectionRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "prefix" : "prefix",
  "name" : "name",
  "syncCatalog" : {
    "streams" : [ {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    }, {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "operationIds" : [ null, null ],
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation ConnectionRead

404

Connection not found

422

Invalid Input
Up 
post /v1/state/get
Fetch the current state for a connection. (getState)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

ConnectionState

Example data

Content-Type: application/json
{
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation ConnectionState

404

Connection not found

422

Invalid Input
Up 
post /v1/connections/list
Returns all connections for a workspace. (listConnectionsForWorkspace)
List connections for workspace. Does not return deleted connections.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Return type

ConnectionReadList

Example data

Content-Type: application/json
{
  "connections" : [ {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "prefix" : "prefix",
    "name" : "name",
    "syncCatalog" : {
      "streams" : [ {
        "stream" : {
          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
          "supportedSyncModes" : [ null, null ],
          "sourceDefinedCursor" : true,
          "name" : "name",
          "namespace" : "namespace",
          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
        },
        "config" : {
          "aliasName" : "aliasName",
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      }, {
        "stream" : {
          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
          "supportedSyncModes" : [ null, null ],
          "sourceDefinedCursor" : true,
          "name" : "name",
          "namespace" : "namespace",
          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
        },
        "config" : {
          "aliasName" : "aliasName",
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ],
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "prefix" : "prefix",
    "name" : "name",
    "syncCatalog" : {
      "streams" : [ {
        "stream" : {
          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
          "supportedSyncModes" : [ null, null ],
          "sourceDefinedCursor" : true,
          "name" : "name",
          "namespace" : "namespace",
          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
        },
        "config" : {
          "aliasName" : "aliasName",
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      }, {
        "stream" : {
          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
          "supportedSyncModes" : [ null, null ],
          "sourceDefinedCursor" : true,
          "name" : "name",
          "namespace" : "namespace",
          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
        },
        "config" : {
          "aliasName" : "aliasName",
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ],
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation ConnectionReadList

404

Workspace not found

422

Invalid Input
Up 
post /v1/connections/reset
Reset the data for the connection. Deletes data generated by the connection in the destination. Resets any cursors back to initial state. (resetConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

JobInfoRead

Example data

Content-Type: application/json
{
  "job" : {
    "createdAt" : 6,
    "configId" : "configId",
    "id" : 0,
    "updatedAt" : 1
  },
  "attempts" : [ {
    "attempt" : {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation JobInfoRead

404

Connection not found

422

Invalid Input
Up 
post /v1/connections/sync
Trigger a manual sync of the connection (syncConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

JobInfoRead

Example data

Content-Type: application/json
{
  "job" : {
    "createdAt" : 6,
    "configId" : "configId",
    "id" : 0,
    "updatedAt" : 1
  },
  "attempts" : [ {
    "attempt" : {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation JobInfoRead

404

Connection not found

422

Invalid Input
Up 
post /v1/connections/update
Update a connection (updateConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConnectionUpdate ConnectionUpdate (required)
Body Parameter —

Return type

ConnectionRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "prefix" : "prefix",
  "name" : "name",
  "syncCatalog" : {
    "streams" : [ {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    }, {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "operationIds" : [ null, null ],
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation ConnectionRead

422

Invalid Input

Deployment

Up 
post /v1/deployment/export
Export Airbyte Configuration and Data Archive (exportArchive)

Return type

File

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation File
Up 
post /v1/deployment/import
Import Airbyte Configuration and Data Archive (importArchive)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body file (required)
Body Parameter —

Return type

ImportRead

Example data

Content-Type: application/json
{
  "reason" : "reason",
  "status" : "succeeded"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation ImportRead

Destination

Up 
post /v1/destinations/check_connection
Check connection to the destination (checkConnectionToDestination)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationIdRequestBody DestinationIdRequestBody (required)
Body Parameter —

Return type

CheckConnectionRead

Example data

Content-Type: application/json
{
  "message" : "message",
  "jobInfo" : {
    "createdAt" : 0,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  },
  "status" : "succeeded"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation CheckConnectionRead

404

Destination not found

422

Invalid Input
Up 
post /v1/destinations/check_connection_for_update
Check connection for a proposed update to a destination (checkConnectionToDestinationForUpdate)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationUpdate DestinationUpdate (required)
Body Parameter —

Return type

CheckConnectionRead

Example data

Content-Type: application/json
{
  "message" : "message",
  "jobInfo" : {
    "createdAt" : 0,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  },
  "status" : "succeeded"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation CheckConnectionRead

404

Destination not found

422

Invalid Input
Up 
post /v1/destinations/create
Create a destination (createDestination)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationCreate DestinationCreate (required)
Body Parameter —

Return type

DestinationRead

Example data

Content-Type: application/json
{
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "destinationName" : "destinationName",
  "name" : "name",
  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationRead

422

Invalid Input
Up 
post /v1/destinations/delete
Delete the destination (deleteDestination)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationIdRequestBody DestinationIdRequestBody (required)
Body Parameter —

Responses

204

The resource was deleted successfully.

404

Destination not found

422

Invalid Input
Up 
post /v1/destinations/get
Get configured destination (getDestination)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationIdRequestBody DestinationIdRequestBody (required)
Body Parameter —

Return type

DestinationRead

Example data

Content-Type: application/json
{
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "destinationName" : "destinationName",
  "name" : "name",
  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationRead

404

Destination not found

422

Invalid Input
Up 
post /v1/destinations/list
List configured destinations for a workspace (listDestinationsForWorkspace)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Return type

DestinationReadList

Example data

Content-Type: application/json
{
  "destinations" : [ {
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "destinationName" : "destinationName",
    "name" : "name",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "destinationName" : "destinationName",
    "name" : "name",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationReadList

404

Workspace not found

422

Invalid Input
Up 
post /v1/destinations/update
Update a destination (updateDestination)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationUpdate DestinationUpdate (required)
Body Parameter —

Return type

DestinationRead

Example data

Content-Type: application/json
{
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "destinationName" : "destinationName",
  "name" : "name",
  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationRead

422

Invalid Input

DestinationDefinition

Up 
post /v1/destination_definitions/create
Creates a destinationsDefinition (createDestinationDefinition)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationDefinitionCreate DestinationDefinitionCreate (optional)
Body Parameter —

Return type

DestinationDefinitionRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "dockerRepository" : "dockerRepository",
  "name" : "name",
  "icon" : "icon",
  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationDefinitionRead

422

Invalid Input
Up 
post /v1/destination_definitions/get
Get destinationDefinition (getDestinationDefinition)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationDefinitionIdRequestBody DestinationDefinitionIdRequestBody (required)
Body Parameter —

Return type

DestinationDefinitionRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "dockerRepository" : "dockerRepository",
  "name" : "name",
  "icon" : "icon",
  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationDefinitionRead

404

DestinationDefinition not found

422

Invalid Input
Up 
post /v1/destination_definitions/list
List all the destinationDefinitions the current Airbyte deployment is configured to use (listDestinationDefinitions)

Return type

DestinationDefinitionReadList

Example data

Content-Type: application/json
{
  "destinationDefinitions" : [ {
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationDefinitionReadList
Up 
post /v1/destination_definitions/list_latest
List the latest destinationDefinitions Airbyte supports (listLatestDestinationDefinitions)
Guaranteed to retrieve the latest information on supported destinations.

Return type

DestinationDefinitionReadList

Example data

Content-Type: application/json
{
  "destinationDefinitions" : [ {
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationDefinitionReadList
Up 
post /v1/destination_definitions/update
Update destinationDefinition (updateDestinationDefinition)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationDefinitionUpdate DestinationDefinitionUpdate (required)
Body Parameter —

Return type

DestinationDefinitionRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "dockerRepository" : "dockerRepository",
  "name" : "name",
  "icon" : "icon",
  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationDefinitionRead

404

DestinationDefinition not found

422

Invalid Input

DestinationDefinitionSpecification

Up 
post /v1/destination_definition_specifications/get
Get specification for a destinationDefinition (getDestinationDefinitionSpecification)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationDefinitionIdRequestBody DestinationDefinitionIdRequestBody (required)
Body Parameter —

Return type

DestinationDefinitionSpecificationRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "documentationUrl",
  "supportsNormalization" : true,
  "connectionSpecification" : {
    "user" : {
      "type" : "string"
    }
  },
  "supportedDestinationSyncModes" : [ null, null ],
  "supportsDbt" : true,
  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "jobInfo" : {
    "createdAt" : 0,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationDefinitionSpecificationRead

404

DestinationDefinition not found

422

Invalid Input

Health

Up 
get /v1/health
Health Check (getHealthCheck)

Return type

HealthCheckRead

Example data

Content-Type: application/json
{
  "db" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation HealthCheckRead

Jobs

Up 
post /v1/jobs/cancel
Cancels a job (cancelJob)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

JobIdRequestBody JobIdRequestBody (required)
Body Parameter —

Return type

JobInfoRead

Example data

Content-Type: application/json
{
  "job" : {
    "createdAt" : 6,
    "configId" : "configId",
    "id" : 0,
    "updatedAt" : 1
  },
  "attempts" : [ {
    "attempt" : {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation JobInfoRead

404

Job not found

422

Invalid Input
Up 
post /v1/jobs/get
Get information about a job (getJobInfo)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

JobIdRequestBody JobIdRequestBody (required)
Body Parameter —

Return type

JobInfoRead

Example data

Content-Type: application/json
{
  "job" : {
    "createdAt" : 6,
    "configId" : "configId",
    "id" : 0,
    "updatedAt" : 1
  },
  "attempts" : [ {
    "attempt" : {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation JobInfoRead

404

Job not found

422

Invalid Input
Up 
post /v1/jobs/list
Returns recent jobs for a connection. Jobs are returned in descending order by createdAt. (listJobsFor)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

JobListRequestBody JobListRequestBody (required)
Body Parameter —

Return type

JobReadList

Example data

Content-Type: application/json
{
  "jobs" : [ {
    "job" : {
      "createdAt" : 6,
      "configId" : "configId",
      "id" : 0,
      "updatedAt" : 1
    },
    "attempts" : [ {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    }, {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    } ]
  }, {
    "job" : {
      "createdAt" : 6,
      "configId" : "configId",
      "id" : 0,
      "updatedAt" : 1
    },
    "attempts" : [ {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    }, {
      "createdAt" : 5,
      "bytesSynced" : 9,
      "endedAt" : 7,
      "id" : 5,
      "recordsSynced" : 3,
      "updatedAt" : 2
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation JobReadList

404

Connection not found

422

Invalid Input

Logs

Up 
post /v1/logs/get
Get logs (getLogs)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

LogsRequestBody LogsRequestBody (required)
Body Parameter —

Return type

File

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns the log file File

404

Logs not found

422

Invalid Input

Notifications

Up 
post /v1/notifications/try
Try sending a notifications (tryNotificationConfig)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Notification Notification (required)
Body Parameter —

Return type

NotificationRead

Example data

Content-Type: application/json
{
  "message" : "message",
  "status" : "succeeded"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation NotificationRead

404

Notification Client not found

422

Invalid Input

Openapi

Up 
get /v1/openapi
Returns the openapi specification (getOpenApiSpec)

Return type

File

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Returns the openapi specification file File

Operation

Up 
post /v1/operations/check
Check if an operation to be created is valid (checkOperation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OperationCreateOrUpdate OperationCreateOrUpdate (required)
Body Parameter —

Return type

CheckOperationRead

Example data

Content-Type: application/json
{
  "message" : "message",
  "status" : "succeeded"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation CheckOperationRead

422

Invalid Input
Up 
post /v1/operations/create
Create an operation to be applied as part of a connection pipeline (createOperation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OperationCreate OperationCreate (required)
Body Parameter —

Return type

OperationRead

Example data

Content-Type: application/json
{
  "name" : "name",
  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "operatorConfiguration" : {
    "normalization" : {
      "option" : "basic"
    },
    "dbt" : {
      "gitRepoBranch" : "gitRepoBranch",
      "dockerImage" : "dockerImage",
      "dbtArguments" : "dbtArguments",
      "gitRepoUrl" : "gitRepoUrl"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation OperationRead

422

Invalid Input
Up 
post /v1/operations/delete
Delete an operation (deleteOperation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OperationIdRequestBody OperationIdRequestBody (required)
Body Parameter —

Responses

204

The resource was deleted successfully.

404

Operation not found

422

Invalid Input
Up 
post /v1/operations/get
Returns an operation (getOperation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OperationIdRequestBody OperationIdRequestBody (required)
Body Parameter —

Return type

OperationRead

Example data

Content-Type: application/json
{
  "name" : "name",
  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "operatorConfiguration" : {
    "normalization" : {
      "option" : "basic"
    },
    "dbt" : {
      "gitRepoBranch" : "gitRepoBranch",
      "dockerImage" : "dockerImage",
      "dbtArguments" : "dbtArguments",
      "gitRepoUrl" : "gitRepoUrl"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation OperationRead

404

Operation not found

422

Invalid Input
Up 
post /v1/operations/list
Returns all operations for a connection. (listOperationsForConnection)
List operations for connection.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

OperationReadList

Example data

Content-Type: application/json
{
  "operations" : [ {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    }
  }, {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation OperationReadList

404

Connection not found

422

Invalid Input
Up 
post /v1/operations/update
Update an operation (updateOperation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

OperationUpdate OperationUpdate (required)
Body Parameter —

Return type

OperationRead

Example data

Content-Type: application/json
{
  "name" : "name",
  "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "operatorConfiguration" : {
    "normalization" : {
      "option" : "basic"
    },
    "dbt" : {
      "gitRepoBranch" : "gitRepoBranch",
      "dockerImage" : "dockerImage",
      "dbtArguments" : "dbtArguments",
      "gitRepoUrl" : "gitRepoUrl"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation OperationRead

422

Invalid Input

Scheduler

Up 
post /v1/scheduler/destinations/check_connection
Run check connection for a given destination configuration (executeDestinationCheckConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationCoreConfig DestinationCoreConfig (required)
Body Parameter —

Return type

CheckConnectionRead

Example data

Content-Type: application/json
{
  "message" : "message",
  "jobInfo" : {
    "createdAt" : 0,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  },
  "status" : "succeeded"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation CheckConnectionRead

422

Invalid Input
Up 
post /v1/scheduler/sources/check_connection
Run check connection for a given source configuration (executeSourceCheckConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceCoreConfig SourceCoreConfig (required)
Body Parameter —

Return type

CheckConnectionRead

Example data

Content-Type: application/json
{
  "message" : "message",
  "jobInfo" : {
    "createdAt" : 0,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  },
  "status" : "succeeded"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation CheckConnectionRead

422

Invalid Input
Up 
post /v1/scheduler/sources/discover_schema
Run discover schema for a given source a source configuration (executeSourceDiscoverSchema)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceCoreConfig SourceCoreConfig (required)
Body Parameter —

Return type

SourceDiscoverSchemaRead

Example data

Content-Type: application/json
{
  "catalog" : {
    "streams" : [ {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    }, {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "jobInfo" : {
    "createdAt" : 0,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceDiscoverSchemaRead

422

Invalid Input

Source

Up 
post /v1/sources/check_connection
Check connection to the source (checkConnectionToSource)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter —

Return type

CheckConnectionRead

Example data

Content-Type: application/json
{
  "message" : "message",
  "jobInfo" : {
    "createdAt" : 0,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  },
  "status" : "succeeded"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation CheckConnectionRead

404

Source not found

422

Invalid Input
Up 
post /v1/sources/check_connection_for_update
Check connection for a proposed update to a source (checkConnectionToSourceForUpdate)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceUpdate SourceUpdate (required)
Body Parameter —

Return type

CheckConnectionRead

Example data

Content-Type: application/json
{
  "message" : "message",
  "jobInfo" : {
    "createdAt" : 0,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  },
  "status" : "succeeded"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation CheckConnectionRead

404

Source not found

422

Invalid Input
Up 
post /v1/sources/create
Create a source (createSource)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceCreate SourceCreate (required)
Body Parameter —

Return type

SourceRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "name" : "name",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "sourceName" : "sourceName",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceRead

422

Invalid Input
Up 
post /v1/sources/delete
Delete a source (deleteSource)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter —

Responses

204

The resource was deleted successfully.

404

Source not found

422

Invalid Input
Up 
post /v1/sources/discover_schema
Discover the schema catalog of the source (discoverSchemaForSource)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter —

Return type

SourceDiscoverSchemaRead

Example data

Content-Type: application/json
{
  "catalog" : {
    "streams" : [ {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    }, {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "jobInfo" : {
    "createdAt" : 0,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceDiscoverSchemaRead

404

Source not found

422

Invalid Input
Up 
post /v1/sources/get
Get source (getSource)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter —

Return type

SourceRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "name" : "name",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "sourceName" : "sourceName",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceRead

404

Source not found

422

Invalid Input
Up 
post /v1/sources/list
List sources for workspace (listSourcesForWorkspace)
List sources for workspace. Does not return deleted sources.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Return type

SourceReadList

Example data

Content-Type: application/json
{
  "sources" : [ {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "name" : "name",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceName" : "sourceName",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "name" : "name",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceName" : "sourceName",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceReadList

404

Workspace not found

422

Invalid Input
Up 
post /v1/sources/update
Update a source (updateSource)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceUpdate SourceUpdate (required)
Body Parameter —

Return type

SourceRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "name" : "name",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "sourceName" : "sourceName",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceRead

404

Source not found

422

Invalid Input

SourceDefinition

Up 
post /v1/source_definitions/create
Creates a sourceDefinition (createSourceDefinition)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceDefinitionCreate SourceDefinitionCreate (optional)
Body Parameter —

Return type

SourceDefinitionRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "dockerRepository" : "dockerRepository",
  "name" : "name",
  "icon" : "icon",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceDefinitionRead

422

Invalid Input
Up 
post /v1/source_definitions/get
Get source (getSourceDefinition)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
Body Parameter —

Return type

SourceDefinitionRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "dockerRepository" : "dockerRepository",
  "name" : "name",
  "icon" : "icon",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceDefinitionRead

404

SourceDefinition not found

422

Invalid Input
Up 
post /v1/source_definitions/list_latest
List the latest sourceDefinitions Airbyte supports (listLatestSourceDefinitions)
Guaranteed to retrieve the latest information on supported sources.

Return type

SourceDefinitionReadList

Example data

Content-Type: application/json
{
  "sourceDefinitions" : [ {
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceDefinitionReadList
Up 
post /v1/source_definitions/list
List all the sourceDefinitions the current Airbyte deployment is configured to use (listSourceDefinitions)

Return type

SourceDefinitionReadList

Example data

Content-Type: application/json
{
  "sourceDefinitions" : [ {
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceDefinitionReadList
Up 
post /v1/source_definitions/update
Update a sourceDefinition (updateSourceDefinition)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceDefinitionUpdate SourceDefinitionUpdate (optional)
Body Parameter —

Return type

SourceDefinitionRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "dockerRepository" : "dockerRepository",
  "name" : "name",
  "icon" : "icon",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceDefinitionRead

404

SourceDefinition not found

422

Invalid Input

SourceDefinitionSpecification

Up 
post /v1/source_definition_specifications/get
Get specification for a SourceDefinition. (getSourceDefinitionSpecification)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
Body Parameter —

Return type

SourceDefinitionSpecificationRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "documentationUrl",
  "connectionSpecification" : {
    "user" : {
      "type" : "string"
    }
  },
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "jobInfo" : {
    "createdAt" : 0,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceDefinitionSpecificationRead

404

SourceDefinition not found

422

Invalid Input

WebBackend

Up 
post /v1/web_backend/connections/create
Create a connection (webBackendCreateConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WebBackendConnectionCreate WebBackendConnectionCreate (required)
Body Parameter —

Return type

WebBackendConnectionRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "latestSyncJobCreatedAt" : 0,
  "prefix" : "prefix",
  "destination" : {
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "destinationName" : "destinationName",
    "name" : "name",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "isSyncing" : true,
  "source" : {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "name" : "name",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceName" : "sourceName",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "operations" : [ {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    }
  }, {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    }
  } ],
  "name" : "name",
  "syncCatalog" : {
    "streams" : [ {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    }, {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "operationIds" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation WebBackendConnectionRead

422

Invalid Input
Up 
post /v1/web_backend/connections/get
Get a connection (webBackendGetConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WebBackendConnectionRequestBody WebBackendConnectionRequestBody (required)
Body Parameter —

Return type

WebBackendConnectionRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "latestSyncJobCreatedAt" : 0,
  "prefix" : "prefix",
  "destination" : {
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "destinationName" : "destinationName",
    "name" : "name",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "isSyncing" : true,
  "source" : {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "name" : "name",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceName" : "sourceName",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "operations" : [ {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    }
  }, {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    }
  } ],
  "name" : "name",
  "syncCatalog" : {
    "streams" : [ {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    }, {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "operationIds" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation WebBackendConnectionRead

404

Connection not found

422

Invalid Input
Up 
post /v1/web_backend/connections/list
Returns all connections for a workspace. (webBackendListConnectionsForWorkspace)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Return type

WebBackendConnectionReadList

Example data

Content-Type: application/json
{
  "connections" : [ {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "latestSyncJobCreatedAt" : 0,
    "prefix" : "prefix",
    "destination" : {
      "connectionConfiguration" : {
        "user" : "charles"
      },
      "destinationName" : "destinationName",
      "name" : "name",
      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "isSyncing" : true,
    "source" : {
      "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "connectionConfiguration" : {
        "user" : "charles"
      },
      "name" : "name",
      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "sourceName" : "sourceName",
      "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "operations" : [ {
      "name" : "name",
      "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "operatorConfiguration" : {
        "normalization" : {
          "option" : "basic"
        },
        "dbt" : {
          "gitRepoBranch" : "gitRepoBranch",
          "dockerImage" : "dockerImage",
          "dbtArguments" : "dbtArguments",
          "gitRepoUrl" : "gitRepoUrl"
        }
      }
    }, {
      "name" : "name",
      "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "operatorConfiguration" : {
        "normalization" : {
          "option" : "basic"
        },
        "dbt" : {
          "gitRepoBranch" : "gitRepoBranch",
          "dockerImage" : "dockerImage",
          "dbtArguments" : "dbtArguments",
          "gitRepoUrl" : "gitRepoUrl"
        }
      }
    } ],
    "name" : "name",
    "syncCatalog" : {
      "streams" : [ {
        "stream" : {
          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
          "supportedSyncModes" : [ null, null ],
          "sourceDefinedCursor" : true,
          "name" : "name",
          "namespace" : "namespace",
          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
        },
        "config" : {
          "aliasName" : "aliasName",
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      }, {
        "stream" : {
          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
          "supportedSyncModes" : [ null, null ],
          "sourceDefinedCursor" : true,
          "name" : "name",
          "namespace" : "namespace",
          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
        },
        "config" : {
          "aliasName" : "aliasName",
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ]
  }, {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "latestSyncJobCreatedAt" : 0,
    "prefix" : "prefix",
    "destination" : {
      "connectionConfiguration" : {
        "user" : "charles"
      },
      "destinationName" : "destinationName",
      "name" : "name",
      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "isSyncing" : true,
    "source" : {
      "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "connectionConfiguration" : {
        "user" : "charles"
      },
      "name" : "name",
      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "sourceName" : "sourceName",
      "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "operations" : [ {
      "name" : "name",
      "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "operatorConfiguration" : {
        "normalization" : {
          "option" : "basic"
        },
        "dbt" : {
          "gitRepoBranch" : "gitRepoBranch",
          "dockerImage" : "dockerImage",
          "dbtArguments" : "dbtArguments",
          "gitRepoUrl" : "gitRepoUrl"
        }
      }
    }, {
      "name" : "name",
      "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "operatorConfiguration" : {
        "normalization" : {
          "option" : "basic"
        },
        "dbt" : {
          "gitRepoBranch" : "gitRepoBranch",
          "dockerImage" : "dockerImage",
          "dbtArguments" : "dbtArguments",
          "gitRepoUrl" : "gitRepoUrl"
        }
      }
    } ],
    "name" : "name",
    "syncCatalog" : {
      "streams" : [ {
        "stream" : {
          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
          "supportedSyncModes" : [ null, null ],
          "sourceDefinedCursor" : true,
          "name" : "name",
          "namespace" : "namespace",
          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
        },
        "config" : {
          "aliasName" : "aliasName",
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      }, {
        "stream" : {
          "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
          "supportedSyncModes" : [ null, null ],
          "sourceDefinedCursor" : true,
          "name" : "name",
          "namespace" : "namespace",
          "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
        },
        "config" : {
          "aliasName" : "aliasName",
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation WebBackendConnectionReadList

404

Workspace not found

422

Invalid Input
Up 
post /v1/web_backend/destinations/recreate
Recreate a destination (webBackendRecreateDestination)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

DestinationRecreate DestinationRecreate (required)
Body Parameter —

Return type

DestinationRead

Example data

Content-Type: application/json
{
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "destinationName" : "destinationName",
  "name" : "name",
  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation DestinationRead

422

Invalid Input
Up 
post /v1/web_backend/sources/recreate
Recreate a source (webBackendRecreateSource)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SourceRecreate SourceRecreate (required)
Body Parameter —

Return type

SourceRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "name" : "name",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "sourceName" : "sourceName",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation SourceRead

422

Invalid Input
Up 
post /v1/web_backend/connections/update
Update a connection (webBackendUpdateConnection)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WebBackendConnectionUpdate WebBackendConnectionUpdate (required)
Body Parameter —

Return type

WebBackendConnectionRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "latestSyncJobCreatedAt" : 0,
  "prefix" : "prefix",
  "destination" : {
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "destinationName" : "destinationName",
    "name" : "name",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "isSyncing" : true,
  "source" : {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "name" : "name",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceName" : "sourceName",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "operations" : [ {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    }
  }, {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    }
  } ],
  "name" : "name",
  "syncCatalog" : {
    "streams" : [ {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    }, {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "operationIds" : [ null, null ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation WebBackendConnectionRead

422

Invalid Input

Workspace

Up 
post /v1/workspaces/create
Creates a workspace (createWorkspace)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WorkspaceCreate WorkspaceCreate (required)
Body Parameter —

Return type

WorkspaceRead

Example data

Content-Type: application/json
{
  "displaySetupWizard" : true,
  "news" : true,
  "initialSetupComplete" : true,
  "anonymousDataCollection" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "email" : "email",
  "slug" : "slug",
  "securityUpdates" : true,
  "notifications" : [ {
    "slackConfiguration" : {
      "webhook" : "webhook"
    }
  }, {
    "slackConfiguration" : {
      "webhook" : "webhook"
    }
  } ],
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation WorkspaceRead

422

Invalid Input
Up 
post /v1/workspaces/delete
Deletes a workspace (deleteWorkspace)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Responses

204

The resource was deleted successfully.

404

Source not found

422

Invalid Input
Up 
post /v1/workspaces/get
Find workspace by ID (getWorkspace)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Return type

WorkspaceRead

Example data

Content-Type: application/json
{
  "displaySetupWizard" : true,
  "news" : true,
  "initialSetupComplete" : true,
  "anonymousDataCollection" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "email" : "email",
  "slug" : "slug",
  "securityUpdates" : true,
  "notifications" : [ {
    "slackConfiguration" : {
      "webhook" : "webhook"
    }
  }, {
    "slackConfiguration" : {
      "webhook" : "webhook"
    }
  } ],
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation WorkspaceRead

404

Workspace not found

422

Invalid Input
Up 
post /v1/workspaces/get_by_slug
Find workspace by slug (getWorkspaceBySlug)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

SlugRequestBody SlugRequestBody (required)
Body Parameter —

Return type

WorkspaceRead

Example data

Content-Type: application/json
{
  "displaySetupWizard" : true,
  "news" : true,
  "initialSetupComplete" : true,
  "anonymousDataCollection" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "email" : "email",
  "slug" : "slug",
  "securityUpdates" : true,
  "notifications" : [ {
    "slackConfiguration" : {
      "webhook" : "webhook"
    }
  }, {
    "slackConfiguration" : {
      "webhook" : "webhook"
    }
  } ],
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation WorkspaceRead

404

Workspace not found

422

Invalid Input
Up 
post /v1/workspaces/update
Update workspace state (updateWorkspace)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WorkspaceUpdate WorkspaceUpdate (required)
Body Parameter —

Return type

WorkspaceRead

Example data

Content-Type: application/json
{
  "displaySetupWizard" : true,
  "news" : true,
  "initialSetupComplete" : true,
  "anonymousDataCollection" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "email" : "email",
  "slug" : "slug",
  "securityUpdates" : true,
  "notifications" : [ {
    "slackConfiguration" : {
      "webhook" : "webhook"
    }
  }, {
    "slackConfiguration" : {
      "webhook" : "webhook"
    }
  } ],
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation WorkspaceRead

404

Workspace not found

422

Invalid Input

Models

[ Jump to Methods ]

Table of Contents

  1. AirbyteCatalog -
  2. AirbyteStream -
  3. AirbyteStreamAndConfiguration -
  4. AirbyteStreamConfiguration -
  5. AttemptInfoRead -
  6. AttemptRead -
  7. AttemptStatus -
  8. CheckConnectionRead -
  9. CheckOperationRead -
  10. ConnectionCreate -
  11. ConnectionIdRequestBody -
  12. ConnectionRead -
  13. ConnectionReadList -
  14. ConnectionSchedule -
  15. ConnectionState -
  16. ConnectionStatus -
  17. ConnectionUpdate -
  18. DataType -
  19. DestinationCoreConfig -
  20. DestinationCreate -
  21. DestinationDefinitionCreate -
  22. DestinationDefinitionIdRequestBody -
  23. DestinationDefinitionRead -
  24. DestinationDefinitionReadList -
  25. DestinationDefinitionSpecificationRead -
  26. DestinationDefinitionUpdate -
  27. DestinationIdRequestBody -
  28. DestinationRead -
  29. DestinationReadList -
  30. DestinationRecreate -
  31. DestinationSyncMode -
  32. DestinationUpdate -
  33. HealthCheckRead -
  34. ImportRead -
  35. JobConfigType -
  36. JobIdRequestBody -
  37. JobInfoRead -
  38. JobListRequestBody -
  39. JobRead -
  40. JobReadList -
  41. JobStatus -
  42. JobWithAttemptsRead -
  43. LogRead -
  44. LogType -
  45. LogsRequestBody -
  46. NamespaceDefinitionType -
  47. Notification -
  48. NotificationRead -
  49. NotificationType -
  50. OperationCreate -
  51. OperationCreateOrUpdate -
  52. OperationIdRequestBody -
  53. OperationRead -
  54. OperationReadList -
  55. OperationUpdate -
  56. OperatorConfiguration -
  57. OperatorDbt -
  58. OperatorNormalization -
  59. OperatorType -
  60. SlackNotificationConfiguration -
  61. SlugRequestBody -
  62. SourceCoreConfig -
  63. SourceCreate -
  64. SourceCreate_allOf -
  65. SourceDefinitionCreate -
  66. SourceDefinitionIdRequestBody -
  67. SourceDefinitionRead -
  68. SourceDefinitionReadList -
  69. SourceDefinitionSpecificationRead -
  70. SourceDefinitionUpdate -
  71. SourceDiscoverSchemaRead -
  72. SourceIdRequestBody -
  73. SourceRead -
  74. SourceReadList -
  75. SourceRecreate -
  76. SourceUpdate -
  77. SyncMode -
  78. SynchronousJobRead -
  79. WebBackendConnectionCreate -
  80. WebBackendConnectionCreate_allOf -
  81. WebBackendConnectionRead -
  82. WebBackendConnectionReadList -
  83. WebBackendConnectionRequestBody -
  84. WebBackendConnectionUpdate -
  85. WebBackendConnectionUpdate_allOf -
  86. WorkspaceCreate -
  87. WorkspaceIdRequestBody -
  88. WorkspaceRead -
  89. WorkspaceUpdate -

AirbyteCatalog - Up

describes the available schema (catalog).
streams
array[AirbyteStreamAndConfiguration]

AirbyteStream - Up

the immutable schema defined by the source
name
String Stream's name.
jsonSchema (optional)
StreamJsonSchema
supportedSyncModes (optional)
array[SyncMode]
sourceDefinedCursor (optional)
Boolean If the source defines the cursor field, then any other cursor field inputs will be ignored. If it does not, either the user_provided one is used, or the default one is used as a backup.
defaultCursorField (optional)
array[String] Path to the field that will be used to determine if a record is new or modified since the last sync. If not provided by the source, the end user will have to specify the comparable themselves.
sourceDefinedPrimaryKey (optional)
array[array[String]] If the source defines the primary key, paths to the fields that will be used as a primary key. If not provided by the source, the end user will have to specify the primary key themselves.
namespace (optional)
String Optional Source-defined namespace. Airbyte streams from the same sources should have the same namespace. Currently only used by JDBC destinations to determine what schema to write to.

AirbyteStreamAndConfiguration - Up

each stream is split in two parts; the immutable schema from source and mutable configuration for destination
stream (optional)
AirbyteStream
config (optional)
AirbyteStreamConfiguration

AirbyteStreamConfiguration - Up

the mutable part of the stream to configure the destination
syncMode
SyncMode
cursorField (optional)
array[String] Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if sync_mode is incremental. Otherwise it is ignored.
destinationSyncMode
DestinationSyncMode
primaryKey (optional)
array[array[String]] Paths to the fields that will be used as primary key. This field is REQUIRED if destination_sync_mode is *_dedup. Otherwise it is ignored.
aliasName (optional)
String Alias name to the stream to be used in the destination
selected (optional)
Boolean

AttemptInfoRead - Up

attempt
AttemptRead
logs
LogRead

AttemptRead - Up

id
Long format: int64
status
AttemptStatus
createdAt
Long format: int64
updatedAt
Long format: int64
endedAt (optional)
Long format: int64
bytesSynced (optional)
Long format: int64
recordsSynced (optional)
Long format: int64

AttemptStatus - Up

CheckConnectionRead - Up

status
String
Enum:
succeeded
failed
message (optional)
String
jobInfo
SynchronousJobRead

CheckOperationRead - Up

status
String
Enum:
succeeded
failed
message (optional)
String

ConnectionCreate - Up

name (optional)
String Optional name of the connection
namespaceDefinition (optional)
NamespaceDefinitionType
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
sourceId
UUID format: uuid
destinationId
UUID format: uuid
operationIds (optional)
array[UUID] format: uuid
syncCatalog (optional)
AirbyteCatalog
schedule (optional)
ConnectionSchedule
status
ConnectionStatus

ConnectionIdRequestBody - Up

connectionId
UUID format: uuid

ConnectionRead - Up

connectionId
UUID format: uuid
name
String
namespaceDefinition (optional)
NamespaceDefinitionType
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
sourceId
UUID format: uuid
destinationId
UUID format: uuid
operationIds (optional)
array[UUID] format: uuid
syncCatalog
AirbyteCatalog
schedule (optional)
ConnectionSchedule
status
ConnectionStatus

ConnectionReadList - Up

connections
array[ConnectionRead]

ConnectionSchedule - Up

if null, then no schedule is set.
units
Long format: int64
timeUnit
String
Enum:
minutes
hours
days
weeks
months

ConnectionState - Up

connectionId
UUID format: uuid
state (optional)
ConnectionStateObject

ConnectionStatus - Up

Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced.

ConnectionUpdate - Up

connectionId
UUID format: uuid
namespaceDefinition (optional)
NamespaceDefinitionType
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
operationIds (optional)
array[UUID] format: uuid
syncCatalog
AirbyteCatalog
schedule (optional)
ConnectionSchedule
status
ConnectionStatus

DataType - Up

DestinationCoreConfig - Up

destinationDefinitionId
UUID format: uuid
connectionConfiguration
DestinationConfiguration

DestinationCreate - Up

destinationDefinitionId
UUID format: uuid
connectionConfiguration
DestinationConfiguration
workspaceId
UUID format: uuid
name
String

DestinationDefinitionCreate - Up

name
String
dockerRepository
String
dockerImageTag
String
documentationUrl
URI format: uri
icon (optional)
String

DestinationDefinitionIdRequestBody - Up

destinationDefinitionId
UUID format: uuid

DestinationDefinitionRead - Up

destinationDefinitionId
UUID format: uuid
name
String
dockerRepository
String
dockerImageTag
String
documentationUrl
URI format: uri
icon (optional)
String

DestinationDefinitionReadList - Up

destinationDefinitions
array[DestinationDefinitionRead]

DestinationDefinitionSpecificationRead - Up

destinationDefinitionId
UUID format: uuid
documentationUrl (optional)
String
connectionSpecification (optional)
DestinationDefinitionSpecification
jobInfo
SynchronousJobRead
supportedDestinationSyncModes (optional)
array[DestinationSyncMode]
supportsDbt (optional)
Boolean
supportsNormalization (optional)
Boolean

DestinationDefinitionUpdate - Up

destinationDefinitionId
UUID format: uuid
dockerImageTag (optional)
String

DestinationIdRequestBody - Up

destinationId
UUID format: uuid

DestinationRead - Up

destinationDefinitionId
UUID format: uuid
destinationId
UUID format: uuid
workspaceId
UUID format: uuid
connectionConfiguration
DestinationConfiguration
name
String
destinationName
String

DestinationReadList - Up

destinations
array[DestinationRead]

DestinationRecreate - Up

destinationDefinitionId
UUID format: uuid
destinationId
UUID format: uuid
workspaceId
UUID format: uuid
connectionConfiguration
DestinationConfiguration
name
String

DestinationSyncMode - Up

DestinationUpdate - Up

destinationId
UUID format: uuid
connectionConfiguration
DestinationConfiguration
name
String

HealthCheckRead - Up

db
Boolean

ImportRead - Up

status
String
Enum:
succeeded
failed
reason (optional)
String

JobConfigType - Up

JobIdRequestBody - Up

id
Long format: int64

JobInfoRead - Up

job
JobRead
attempts
array[AttemptInfoRead]

JobListRequestBody - Up

configTypes
array[JobConfigType]
configId
String

JobRead - Up

id
Long format: int64
configType
JobConfigType
configId
String
createdAt
Long format: int64
updatedAt
Long format: int64
status
JobStatus

JobReadList - Up

jobs
array[JobWithAttemptsRead]

JobStatus - Up

JobWithAttemptsRead - Up

job (optional)
JobRead
attempts (optional)
array[AttemptRead]

LogRead - Up

logLines
array[String]

LogType - Up

type/source of logs produced

LogsRequestBody - Up

logType
LogType

NamespaceDefinitionType - Up

Method used for computing final namespace in destination

Notification - Up

notificationType
NotificationType
slackConfiguration (optional)
SlackNotificationConfiguration

NotificationRead - Up

status
String
Enum:
succeeded
failed
message (optional)
String

NotificationType - Up

OperationCreate - Up

name
String
operatorConfiguration
OperatorConfiguration

OperationCreateOrUpdate - Up

operationId (optional)
UUID format: uuid
name
String
operatorConfiguration
OperatorConfiguration

OperationIdRequestBody - Up

OperationId
UUID format: uuid

OperationRead - Up

operationId
UUID format: uuid
name
String
operatorConfiguration
OperatorConfiguration

OperationReadList - Up

operations
array[OperationRead]

OperationUpdate - Up

operationId
UUID format: uuid
name
String
operatorConfiguration
OperatorConfiguration

OperatorConfiguration - Up

operatorType
OperatorType
normalization (optional)
OperatorNormalization
dbt (optional)
OperatorDbt

OperatorDbt - Up

gitRepoUrl
String
gitRepoBranch (optional)
String
dockerImage (optional)
String
dbtArguments (optional)
String

OperatorNormalization - Up

option (optional)
String
Enum:
basic

OperatorType - Up

SlackNotificationConfiguration - Up

webhook
String

SlugRequestBody - Up

slug
String

SourceCoreConfig - Up

sourceDefinitionId
UUID format: uuid
connectionConfiguration
SourceConfiguration

SourceCreate - Up

sourceDefinitionId
UUID format: uuid
connectionConfiguration
SourceConfiguration
workspaceId
UUID format: uuid
name
String

SourceCreate_allOf - Up

workspaceId
UUID format: uuid
name
String

SourceDefinitionCreate - Up

name
String
dockerRepository
String
dockerImageTag
String
documentationUrl
URI format: uri
icon (optional)
String

SourceDefinitionIdRequestBody - Up

sourceDefinitionId
UUID format: uuid

SourceDefinitionRead - Up

sourceDefinitionId
UUID format: uuid
name
String
dockerRepository
String
dockerImageTag
String
documentationUrl (optional)
URI format: uri
icon (optional)
String

SourceDefinitionReadList - Up

sourceDefinitions
array[SourceDefinitionRead]

SourceDefinitionSpecificationRead - Up

sourceDefinitionId
UUID format: uuid
documentationUrl (optional)
String
connectionSpecification (optional)
SourceDefinitionSpecification
jobInfo
SynchronousJobRead

SourceDefinitionUpdate - Up

Update the SourceDefinition. Currently, the only allowed attribute to update is the default docker image version.
sourceDefinitionId
UUID format: uuid
dockerImageTag
String

SourceDiscoverSchemaRead - Up

Returns the results of a discover catalog job. If the job was not successful, the catalog field will not be present. jobInfo will aways be present and its status be used to determine if the job was successful or not.
catalog (optional)
AirbyteCatalog
jobInfo
SynchronousJobRead

SourceIdRequestBody - Up

sourceId
UUID format: uuid

SourceRead - Up

sourceDefinitionId
UUID format: uuid
sourceId
UUID format: uuid
workspaceId
UUID format: uuid
connectionConfiguration
SourceConfiguration
name
String
sourceName
String

SourceReadList - Up

sources
array[SourceRead]

SourceRecreate - Up

sourceDefinitionId
UUID format: uuid
sourceId
UUID format: uuid
workspaceId
UUID format: uuid
connectionConfiguration
SourceConfiguration
name
String

SourceUpdate - Up

sourceId
UUID format: uuid
connectionConfiguration
SourceConfiguration
name
String

SyncMode - Up

SynchronousJobRead - Up

id
UUID format: uuid
configType
JobConfigType
configId (optional)
String only present if a config id was provided.
createdAt
Long format: int64
endedAt
Long format: int64
succeeded
Boolean
logs (optional)
LogRead

WebBackendConnectionCreate - Up

name (optional)
String Optional name of the connection
namespaceDefinition (optional)
NamespaceDefinitionType
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
sourceId
UUID format: uuid
destinationId
UUID format: uuid
operationIds (optional)
array[UUID] format: uuid
syncCatalog (optional)
AirbyteCatalog
schedule (optional)
ConnectionSchedule
status
ConnectionStatus
operations (optional)
array[OperationCreate]

WebBackendConnectionCreate_allOf - Up

operations (optional)
array[OperationCreate]

WebBackendConnectionRead - Up

connectionId
UUID format: uuid
name
String
namespaceDefinition (optional)
NamespaceDefinitionType
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
sourceId
UUID format: uuid
destinationId
UUID format: uuid
syncCatalog
AirbyteCatalog
schedule (optional)
ConnectionSchedule
status
ConnectionStatus
operationIds (optional)
array[UUID] format: uuid
source
SourceRead
destination
DestinationRead
operations (optional)
array[OperationRead]
latestSyncJobCreatedAt (optional)
Long epoch time of the latest sync job. null if no sync job has taken place. format: int64
latestSyncJobStatus (optional)
JobStatus
isSyncing
Boolean

WebBackendConnectionReadList - Up

connections
array[WebBackendConnectionRead]

WebBackendConnectionRequestBody - Up

withRefreshedCatalog (optional)
Boolean
connectionId
UUID format: uuid

WebBackendConnectionUpdate - Up

connectionId
UUID format: uuid
namespaceDefinition (optional)
NamespaceDefinitionType
namespaceFormat (optional)
String Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
prefix (optional)
String Prefix that will be prepended to the name of each stream when it is written to the destination.
operationIds (optional)
array[UUID] format: uuid
syncCatalog
AirbyteCatalog
schedule (optional)
ConnectionSchedule
status
ConnectionStatus
withRefreshedCatalog (optional)
Boolean
operations (optional)
array[OperationCreateOrUpdate]

WebBackendConnectionUpdate_allOf - Up

withRefreshedCatalog (optional)
Boolean
operations (optional)
array[OperationCreateOrUpdate]

WorkspaceCreate - Up

email (optional)
String format: email
anonymousDataCollection (optional)
Boolean
name
String
news (optional)
Boolean
securityUpdates (optional)
Boolean
notifications (optional)
array[Notification]

WorkspaceIdRequestBody - Up

workspaceId
UUID format: uuid

WorkspaceRead - Up

workspaceId
UUID format: uuid
customerId
UUID format: uuid
email (optional)
String format: email
name
String
slug
String
initialSetupComplete
Boolean
displaySetupWizard (optional)
Boolean
anonymousDataCollection (optional)
Boolean
news (optional)
Boolean
securityUpdates (optional)
Boolean
notifications (optional)
array[Notification]

WorkspaceUpdate - Up

workspaceId
UUID format: uuid
email (optional)
String format: email
initialSetupComplete
Boolean
displaySetupWizard (optional)
Boolean
anonymousDataCollection
Boolean
news
Boolean
securityUpdates
Boolean
notifications (optional)
array[Notification]