Airbyte Configuration API

Airbyte Configuration API https://airbyte.io.

The Configuration API is an internal Airbyte API that is designed for communications between different Airbyte components.

WARNING

This API is a collection of 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:

Authentication (OSS):

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

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Attempt

Connection

ConnectorBuilderProject

DeclarativeSourceDefinitions

Destination

DestinationDefinition

DestinationDefinitionSpecification

DestinationOauth

Health

Internal

Jobs

Logs

Notifications

Openapi

Operation

Scheduler

Source

SourceDefinition

SourceDefinitionSpecification

SourceOauth

State

StreamStatuses

Streams

WebBackend

Workspace

Attempt

Up 
post /v1/attempt/save_stats
For worker to set sync stats of a running attempt. (saveStats)

Consumes

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

Request body

SaveStatsRequestBody SaveStatsRequestBody (required)
Body Parameter —

Return type

InternalOperationResult

Example data

Content-Type: application/json
{
  "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 InternalOperationResult
Up 
post /v1/attempt/save_sync_config
For worker to save the AttemptSyncConfig for an attempt. (saveSyncConfig)

Consumes

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

Request body

SaveAttemptSyncConfigRequestBody SaveAttemptSyncConfigRequestBody (required)
Body Parameter —

Return type

InternalOperationResult

Example data

Content-Type: application/json
{
  "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 InternalOperationResult
Up 
post /v1/attempt/set_workflow_in_attempt
For worker to register the workflow id in attempt. (setWorkflowInAttempt)

Consumes

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

Request body

SetWorkflowInAttemptRequestBody SetWorkflowInAttemptRequestBody (required)
Body Parameter —

Return type

InternalOperationResult

Example data

Content-Type: application/json
{
  "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 InternalOperationResult

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",
  "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "prefix" : "prefix",
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "resourceRequirements" : {
    "cpu_limit" : "cpu_limit",
    "memory_request" : "memory_request",
    "memory_limit" : "memory_limit",
    "cpu_request" : "cpu_request"
  },
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "breakingChange" : true,
  "notifySchemaChanges" : true,
  "notifySchemaChangesByEmail" : true,
  "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "operationIds" : [ null, null ],
  "scheduleData" : {
    "cron" : {
      "cronExpression" : "cronExpression",
      "cronTimeZone" : "cronTimeZone"
    },
    "basicSchedule" : {
      "units" : 6,
      "timeUnit" : "minutes"
    }
  },
  "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 ConnectionRead

422

Input failed validation InvalidInputExceptionInfo
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 —

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

204

The resource was deleted successfully.

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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",
  "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "prefix" : "prefix",
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "resourceRequirements" : {
    "cpu_limit" : "cpu_limit",
    "memory_request" : "memory_request",
    "memory_limit" : "memory_limit",
    "cpu_request" : "cpu_request"
  },
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "breakingChange" : true,
  "notifySchemaChanges" : true,
  "notifySchemaChangesByEmail" : true,
  "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "operationIds" : [ null, null ],
  "scheduleData" : {
    "cron" : {
      "cronExpression" : "cronExpression",
      "cronTimeZone" : "cronTimeZone"
    },
    "basicSchedule" : {
      "units" : 6,
      "timeUnit" : "minutes"
    }
  },
  "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 ConnectionRead

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/connections/list_all
Returns all connections for a workspace, including deleted connections. (listAllConnectionsForWorkspace)
List connections for workspace, including 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",
    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "prefix" : "prefix",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "resourceRequirements" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "breakingChange" : true,
    "notifySchemaChanges" : true,
    "notifySchemaChangesByEmail" : true,
    "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ],
    "scheduleData" : {
      "cron" : {
        "cronExpression" : "cronExpression",
        "cronTimeZone" : "cronTimeZone"
      },
      "basicSchedule" : {
        "units" : 6,
        "timeUnit" : "minutes"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "prefix" : "prefix",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "resourceRequirements" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "breakingChange" : true,
    "notifySchemaChanges" : true,
    "notifySchemaChangesByEmail" : true,
    "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ],
    "scheduleData" : {
      "cron" : {
        "cronExpression" : "cronExpression",
        "cronTimeZone" : "cronTimeZone"
      },
      "basicSchedule" : {
        "units" : 6,
        "timeUnit" : "minutes"
      }
    },
    "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 ConnectionReadList

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/connections/list_by_actor_definition
List all connections that use the provided actor definition (listConnectionsByActorDefinition)

Consumes

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

Request body

ActorDefinitionRequestBody ActorDefinitionRequestBody (required)
Body Parameter —

Return type

ConnectionReadList

Example data

Content-Type: application/json
{
  "connections" : [ {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "prefix" : "prefix",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "resourceRequirements" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "breakingChange" : true,
    "notifySchemaChanges" : true,
    "notifySchemaChangesByEmail" : true,
    "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ],
    "scheduleData" : {
      "cron" : {
        "cronExpression" : "cronExpression",
        "cronTimeZone" : "cronTimeZone"
      },
      "basicSchedule" : {
        "units" : 6,
        "timeUnit" : "minutes"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "prefix" : "prefix",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "resourceRequirements" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "breakingChange" : true,
    "notifySchemaChanges" : true,
    "notifySchemaChangesByEmail" : true,
    "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ],
    "scheduleData" : {
      "cron" : {
        "cronExpression" : "cronExpression",
        "cronTimeZone" : "cronTimeZone"
      },
      "basicSchedule" : {
        "units" : 6,
        "timeUnit" : "minutes"
      }
    },
    "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 ConnectionReadList

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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",
    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "prefix" : "prefix",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "resourceRequirements" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "breakingChange" : true,
    "notifySchemaChanges" : true,
    "notifySchemaChangesByEmail" : true,
    "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ],
    "scheduleData" : {
      "cron" : {
        "cronExpression" : "cronExpression",
        "cronTimeZone" : "cronTimeZone"
      },
      "basicSchedule" : {
        "units" : 6,
        "timeUnit" : "minutes"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "prefix" : "prefix",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "resourceRequirements" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "breakingChange" : true,
    "notifySchemaChanges" : true,
    "notifySchemaChangesByEmail" : true,
    "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ],
    "scheduleData" : {
      "cron" : {
        "cronExpression" : "cronExpression",
        "cronTimeZone" : "cronTimeZone"
      },
      "basicSchedule" : {
        "units" : 6,
        "timeUnit" : "minutes"
      }
    },
    "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 ConnectionReadList

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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,
    "enabledStreams" : [ {
      "name" : "name",
      "namespace" : "namespace"
    }, {
      "name" : "name",
      "namespace" : "namespace"
    } ],
    "configId" : "configId",
    "startedAt" : 5,
    "id" : 0,
    "resetConfig" : {
      "streamsToReset" : [ {
        "name" : "name",
        "namespace" : "namespace"
      }, {
        "name" : "name",
        "namespace" : "namespace"
      } ]
    },
    "updatedAt" : 1
  },
  "attempts" : [ {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/connections/reset/stream
Reset the data for a specific stream in the connection. Deletes data generated by the stream in the destination. Resets any cursors back to initial state. (resetConnectionStream)

Consumes

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

Request body

ConnectionStreamRequestBody ConnectionStreamRequestBody (required)
Body Parameter —

Return type

JobInfoRead

Example data

Content-Type: application/json
{
  "job" : {
    "createdAt" : 6,
    "enabledStreams" : [ {
      "name" : "name",
      "namespace" : "namespace"
    }, {
      "name" : "name",
      "namespace" : "namespace"
    } ],
    "configId" : "configId",
    "startedAt" : 5,
    "id" : 0,
    "resetConfig" : {
      "streamsToReset" : [ {
        "name" : "name",
        "namespace" : "namespace"
      }, {
        "name" : "name",
        "namespace" : "namespace"
      } ]
    },
    "updatedAt" : 1
  },
  "attempts" : [ {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/connections/search
Search connections (searchConnections)

Consumes

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

Request body

ConnectionSearch ConnectionSearch (required)
Body Parameter —

Return type

ConnectionReadList

Example data

Content-Type: application/json
{
  "connections" : [ {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "prefix" : "prefix",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "resourceRequirements" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "breakingChange" : true,
    "notifySchemaChanges" : true,
    "notifySchemaChangesByEmail" : true,
    "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ],
    "scheduleData" : {
      "cron" : {
        "cronExpression" : "cronExpression",
        "cronTimeZone" : "cronTimeZone"
      },
      "basicSchedule" : {
        "units" : 6,
        "timeUnit" : "minutes"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "prefix" : "prefix",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "resourceRequirements" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "breakingChange" : true,
    "notifySchemaChanges" : true,
    "notifySchemaChangesByEmail" : true,
    "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "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",
          "suggested" : true,
          "fieldSelectionEnabled" : true,
          "selectedFields" : [ {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          }, {
            "fieldPath" : [ "fieldPath", "fieldPath" ]
          } ],
          "cursorField" : [ "cursorField", "cursorField" ],
          "selected" : true,
          "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
        }
      } ]
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "namespaceFormat" : "${SOURCE_NAMESPACE}",
    "operationIds" : [ null, null ],
    "scheduleData" : {
      "cron" : {
        "cronExpression" : "cronExpression",
        "cronTimeZone" : "cronTimeZone"
      },
      "basicSchedule" : {
        "units" : 6,
        "timeUnit" : "minutes"
      }
    },
    "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 ConnectionReadList

422

Input failed validation InvalidInputExceptionInfo
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,
    "enabledStreams" : [ {
      "name" : "name",
      "namespace" : "namespace"
    }, {
      "name" : "name",
      "namespace" : "namespace"
    } ],
    "configId" : "configId",
    "startedAt" : 5,
    "id" : 0,
    "resetConfig" : {
      "streamsToReset" : [ {
        "name" : "name",
        "namespace" : "namespace"
      }, {
        "name" : "name",
        "namespace" : "namespace"
      } ]
    },
    "updatedAt" : 1
  },
  "attempts" : [ {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/connections/update
Update a connection (updateConnection)
Apply a patch-style update to a connection. Only fields present on the update request body will be updated. Note that if a catalog is present in the request body, the connection's entire catalog will be replaced with the catalog from the request. This means that to modify a single stream, the entire new catalog containing the updated stream needs to be sent.

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",
  "sourceCatalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "prefix" : "prefix",
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "resourceRequirements" : {
    "cpu_limit" : "cpu_limit",
    "memory_request" : "memory_request",
    "memory_limit" : "memory_limit",
    "cpu_request" : "cpu_request"
  },
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "breakingChange" : true,
  "notifySchemaChanges" : true,
  "notifySchemaChangesByEmail" : true,
  "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "operationIds" : [ null, null ],
  "scheduleData" : {
    "cron" : {
      "cronExpression" : "cronExpression",
      "cronTimeZone" : "cronTimeZone"
    },
    "basicSchedule" : {
      "units" : 6,
      "timeUnit" : "minutes"
    }
  },
  "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 ConnectionRead

422

Input failed validation InvalidInputExceptionInfo

ConnectorBuilderProject

Up 
post /v1/connector_builder_projects/create
Create new connector builder project (createConnectorBuilderProject)

Consumes

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

Request body

ConnectorBuilderProjectWithWorkspaceId ConnectorBuilderProjectWithWorkspaceId (required)
Body Parameter —

Return type

ConnectorBuilderProjectIdWithWorkspaceId

Example data

Content-Type: application/json
{
  "builderProjectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "version" : 0,
  "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

201

Successful operation ConnectorBuilderProjectIdWithWorkspaceId
Up 
post /v1/connector_builder_projects/delete
Deletes connector builder project (deleteConnectorBuilderProject)

Consumes

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

Request body

ConnectorBuilderProjectIdWithWorkspaceId ConnectorBuilderProjectIdWithWorkspaceId (required)
Body Parameter —

Responses

204

Successful operation
Up 
post /v1/connector_builder_projects/get_with_manifest
Get a connector builder project with draft manifest (getConnectorBuilderProject)

Consumes

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

Request body

ConnectorBuilderProjectIdWithWorkspaceId ConnectorBuilderProjectIdWithWorkspaceId (required)
Body Parameter —

Return type

ConnectorBuilderProjectRead

Example data

Content-Type: application/json
{
  "declarativeManifest" : {
    "manifest" : "{}",
    "isDraft" : true,
    "description" : "description",
    "version" : 0
  },
  "builderProject" : {
    "hasDraft" : true,
    "activeDeclarativeManifestVersion" : 0,
    "builderProjectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "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 ConnectorBuilderProjectRead
Up 
post /v1/connector_builder_projects/list
List connector builder projects for workspace (listConnectorBuilderProjects)

Consumes

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

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Return type

ConnectorBuilderProjectReadList

Example data

Content-Type: application/json
{
  "projects" : [ {
    "hasDraft" : true,
    "activeDeclarativeManifestVersion" : 0,
    "builderProjectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "hasDraft" : true,
    "activeDeclarativeManifestVersion" : 0,
    "builderProjectId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "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 ConnectorBuilderProjectReadList
Up 
post /v1/connector_builder_projects/publish
Publish a connector to the workspace (publishConnectorBuilderProject)

Consumes

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

Request body

ConnectorBuilderPublishRequestBody ConnectorBuilderPublishRequestBody (required)
Body Parameter —

Return type

SourceDefinitionIdBody

Example data

Content-Type: application/json
{
  "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 SourceDefinitionIdBody
Up 
post /v1/connector_builder_projects/update
Update connector builder project (updateConnectorBuilderProject)

Consumes

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

Request body

ExistingConnectorBuilderProjectWithWorkspaceId ExistingConnectorBuilderProjectWithWorkspaceId (required)
Body Parameter —

Responses

204

Successful operation

DeclarativeSourceDefinitions

Up 
post /v1/declarative_source_definitions/create_manifest
Create a declarative manifest to be used by the specified source definition (createDeclarativeSourceDefinitionManifest)

Consumes

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

Request body

DeclarativeSourceDefinitionCreateManifestRequestBody DeclarativeSourceDefinitionCreateManifestRequestBody (required)
Body Parameter —

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

201

Successful operation

400

Definition is not declarative source

404

Object with given id was not found. NotFoundKnownExceptionInfo

409

Version already exists for definition id
Up 
post /v1/declarative_source_definitions/list_manifests
List all available declarative manifest versions of a declarative source definition (listDeclarativeManifests)

Consumes

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

Request body

ListDeclarativeManifestsRequestBody ListDeclarativeManifestsRequestBody (required)
Body Parameter —

Return type

DeclarativeManifestsReadList

Example data

Content-Type: application/json
{
  "manifestVersions" : [ {
    "description" : "description",
    "isActive" : true,
    "version" : 0
  }, {
    "description" : "description",
    "isActive" : true,
    "version" : 0
  } ]
}

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 DeclarativeManifestsReadList

400

Definition is not declarative source

404

Object with given id was not found. NotFoundKnownExceptionInfo
Up 
post /v1/declarative_source_definitions/update_active_manifest
Update the declarative manifest version for a source (updateDeclarativeManifestVersion)

Consumes

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

Request body

UpdateActiveManifestRequestBody UpdateActiveManifestRequestBody (required)
Body Parameter —

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

204

Successful operation

404

Object with given id was not found. NotFoundKnownExceptionInfo

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,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/destinations/clone
Clone destination (cloneDestination)

Consumes

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

Request body

DestinationCloneRequestBody DestinationCloneRequestBody (required)
Body Parameter —

Return type

DestinationRead

Example data

Content-Type: application/json
{
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "destinationName" : "destinationName",
  "name" : "name",
  "icon" : "icon",
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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",
  "icon" : "icon",
  "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

Input failed validation InvalidInputExceptionInfo
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 —

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

204

The resource was deleted successfully.

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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",
  "icon" : "icon",
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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",
    "icon" : "icon",
    "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",
    "icon" : "icon",
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/destinations/partial_update
Update a destination partially (partialUpdateDestination)

Consumes

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

Request body

PartialDestinationUpdate PartialDestinationUpdate (required)
Body Parameter —

Return type

DestinationRead

Example data

Content-Type: application/json
{
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "destinationName" : "destinationName",
  "name" : "name",
  "icon" : "icon",
  "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

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/destinations/search
Search destinations (searchDestinations)

Consumes

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

Request body

DestinationSearch DestinationSearch (required)
Body Parameter —

Return type

DestinationReadList

Example data

Content-Type: application/json
{
  "destinations" : [ {
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "destinationName" : "destinationName",
    "name" : "name",
    "icon" : "icon",
    "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",
    "icon" : "icon",
    "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

422

Input failed validation InvalidInputExceptionInfo
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",
  "icon" : "icon",
  "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

Input failed validation InvalidInputExceptionInfo

DestinationDefinition

Up 
post /v1/destination_definitions/create_custom
Creates a custom destinationDefinition for the given workspace (createCustomDestinationDefinition)

Consumes

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

Request body

CustomDestinationDefinitionCreate CustomDestinationDefinitionCreate (optional)
Body Parameter —

Return type

DestinationDefinitionRead

Example data

Content-Type: application/json
{
  "resourceRequirements" : {
    "default" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "jobSpecific" : [ {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    }, {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    } ]
  },
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "releaseDate" : "2000-01-23",
  "dockerRepository" : "dockerRepository",
  "supportsDbt" : true,
  "name" : "name",
  "icon" : "icon",
  "normalizationConfig" : {
    "normalizationIntegrationType" : "normalizationIntegrationType",
    "normalizationRepository" : "normalizationRepository",
    "normalizationTag" : "normalizationTag",
    "supported" : false
  },
  "protocolVersion" : "protocolVersion",
  "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

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/destination_definitions/delete
Delete a destination definition (deleteDestinationDefinition)

Consumes

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

Request body

DestinationDefinitionIdRequestBody DestinationDefinitionIdRequestBody (required)
Body Parameter —

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

204

The resource was deleted successfully.

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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
{
  "resourceRequirements" : {
    "default" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "jobSpecific" : [ {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    }, {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    } ]
  },
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "releaseDate" : "2000-01-23",
  "dockerRepository" : "dockerRepository",
  "supportsDbt" : true,
  "name" : "name",
  "icon" : "icon",
  "normalizationConfig" : {
    "normalizationIntegrationType" : "normalizationIntegrationType",
    "normalizationRepository" : "normalizationRepository",
    "normalizationTag" : "normalizationTag",
    "supported" : false
  },
  "protocolVersion" : "protocolVersion",
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/destination_definitions/get_for_workspace
Get a destinationDefinition that is configured for the given workspace (getDestinationDefinitionForWorkspace)

Consumes

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

Request body

DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
Body Parameter —

Return type

DestinationDefinitionRead

Example data

Content-Type: application/json
{
  "resourceRequirements" : {
    "default" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "jobSpecific" : [ {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    }, {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    } ]
  },
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "releaseDate" : "2000-01-23",
  "dockerRepository" : "dockerRepository",
  "supportsDbt" : true,
  "name" : "name",
  "icon" : "icon",
  "normalizationConfig" : {
    "normalizationIntegrationType" : "normalizationIntegrationType",
    "normalizationRepository" : "normalizationRepository",
    "normalizationTag" : "normalizationTag",
    "supported" : false
  },
  "protocolVersion" : "protocolVersion",
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/destination_definitions/grant_definition
grant a private, non-custom destinationDefinition to a given workspace (grantDestinationDefinitionToWorkspace)

Consumes

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

Request body

DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
Body Parameter —

Return type

PrivateDestinationDefinitionRead

Example data

Content-Type: application/json
{
  "destinationDefinition" : {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "dockerRepository" : "dockerRepository",
    "supportsDbt" : true,
    "name" : "name",
    "icon" : "icon",
    "normalizationConfig" : {
      "normalizationIntegrationType" : "normalizationIntegrationType",
      "normalizationRepository" : "normalizationRepository",
      "normalizationTag" : "normalizationTag",
      "supported" : false
    },
    "protocolVersion" : "protocolVersion",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "granted" : 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 PrivateDestinationDefinitionRead

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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" : [ {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "dockerRepository" : "dockerRepository",
    "supportsDbt" : true,
    "name" : "name",
    "icon" : "icon",
    "normalizationConfig" : {
      "normalizationIntegrationType" : "normalizationIntegrationType",
      "normalizationRepository" : "normalizationRepository",
      "normalizationTag" : "normalizationTag",
      "supported" : false
    },
    "protocolVersion" : "protocolVersion",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "dockerRepository" : "dockerRepository",
    "supportsDbt" : true,
    "name" : "name",
    "icon" : "icon",
    "normalizationConfig" : {
      "normalizationIntegrationType" : "normalizationIntegrationType",
      "normalizationRepository" : "normalizationRepository",
      "normalizationTag" : "normalizationTag",
      "supported" : false
    },
    "protocolVersion" : "protocolVersion",
    "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_for_workspace
List all the destinationDefinitions the given workspace is configured to use (listDestinationDefinitionsForWorkspace)

Consumes

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

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
Body Parameter —

Return type

DestinationDefinitionReadList

Example data

Content-Type: application/json
{
  "destinationDefinitions" : [ {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "dockerRepository" : "dockerRepository",
    "supportsDbt" : true,
    "name" : "name",
    "icon" : "icon",
    "normalizationConfig" : {
      "normalizationIntegrationType" : "normalizationIntegrationType",
      "normalizationRepository" : "normalizationRepository",
      "normalizationTag" : "normalizationTag",
      "supported" : false
    },
    "protocolVersion" : "protocolVersion",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "dockerRepository" : "dockerRepository",
    "supportsDbt" : true,
    "name" : "name",
    "icon" : "icon",
    "normalizationConfig" : {
      "normalizationIntegrationType" : "normalizationIntegrationType",
      "normalizationRepository" : "normalizationRepository",
      "normalizationTag" : "normalizationTag",
      "supported" : false
    },
    "protocolVersion" : "protocolVersion",
    "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" : [ {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "dockerRepository" : "dockerRepository",
    "supportsDbt" : true,
    "name" : "name",
    "icon" : "icon",
    "normalizationConfig" : {
      "normalizationIntegrationType" : "normalizationIntegrationType",
      "normalizationRepository" : "normalizationRepository",
      "normalizationTag" : "normalizationTag",
      "supported" : false
    },
    "protocolVersion" : "protocolVersion",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "dockerRepository" : "dockerRepository",
    "supportsDbt" : true,
    "name" : "name",
    "icon" : "icon",
    "normalizationConfig" : {
      "normalizationIntegrationType" : "normalizationIntegrationType",
      "normalizationRepository" : "normalizationRepository",
      "normalizationTag" : "normalizationTag",
      "supported" : false
    },
    "protocolVersion" : "protocolVersion",
    "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_private
List all private, non-custom destinationDefinitions, and for each indicate whether the given workspace has a grant for using the definition. Used by admins to view and modify a given workspace's grants. (listPrivateDestinationDefinitions)

Consumes

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

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
Body Parameter —

Return type

PrivateDestinationDefinitionReadList

Example data

Content-Type: application/json
{
  "destinationDefinitions" : [ {
    "destinationDefinition" : {
      "resourceRequirements" : {
        "default" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        },
        "jobSpecific" : [ {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        }, {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        } ]
      },
      "documentationUrl" : "https://openapi-generator.tech",
      "dockerImageTag" : "dockerImageTag",
      "releaseDate" : "2000-01-23",
      "dockerRepository" : "dockerRepository",
      "supportsDbt" : true,
      "name" : "name",
      "icon" : "icon",
      "normalizationConfig" : {
        "normalizationIntegrationType" : "normalizationIntegrationType",
        "normalizationRepository" : "normalizationRepository",
        "normalizationTag" : "normalizationTag",
        "supported" : false
      },
      "protocolVersion" : "protocolVersion",
      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "granted" : true
  }, {
    "destinationDefinition" : {
      "resourceRequirements" : {
        "default" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        },
        "jobSpecific" : [ {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        }, {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        } ]
      },
      "documentationUrl" : "https://openapi-generator.tech",
      "dockerImageTag" : "dockerImageTag",
      "releaseDate" : "2000-01-23",
      "dockerRepository" : "dockerRepository",
      "supportsDbt" : true,
      "name" : "name",
      "icon" : "icon",
      "normalizationConfig" : {
        "normalizationIntegrationType" : "normalizationIntegrationType",
        "normalizationRepository" : "normalizationRepository",
        "normalizationTag" : "normalizationTag",
        "supported" : false
      },
      "protocolVersion" : "protocolVersion",
      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "granted" : 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 PrivateDestinationDefinitionReadList
Up 
post /v1/destination_definitions/revoke_definition
revoke a grant to a private, non-custom destinationDefinition from a given workspace (revokeDestinationDefinitionFromWorkspace)

Consumes

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

Request body

DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
Body Parameter —

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

204

The resource was deleted successfully.

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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
{
  "resourceRequirements" : {
    "default" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "jobSpecific" : [ {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    }, {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    } ]
  },
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "releaseDate" : "2000-01-23",
  "dockerRepository" : "dockerRepository",
  "supportsDbt" : true,
  "name" : "name",
  "icon" : "icon",
  "normalizationConfig" : {
    "normalizationIntegrationType" : "normalizationIntegrationType",
    "normalizationRepository" : "normalizationRepository",
    "normalizationTag" : "normalizationTag",
    "supported" : false
  },
  "protocolVersion" : "protocolVersion",
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

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

DestinationDefinitionIdWithWorkspaceId DestinationDefinitionIdWithWorkspaceId (required)
Body Parameter —

Return type

DestinationDefinitionSpecificationRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "documentationUrl",
  "connectionSpecification" : {
    "user" : {
      "type" : "string"
    }
  },
  "supportedDestinationSyncModes" : [ null, null ],
  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "advancedAuth" : {
    "predicateValue" : "predicateValue",
    "oauthConfigSpecification" : { },
    "predicateKey" : [ "predicateKey", "predicateKey" ],
    "authFlowType" : "oauth2.0"
  },
  "jobInfo" : {
    "createdAt" : 0,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/destination_definition_specifications/get_for_destination
Get specification for a destination (getSpecificationForDestinationId)

Consumes

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

Request body

DestinationIdRequestBody DestinationIdRequestBody (required)
Body Parameter —

Return type

DestinationDefinitionSpecificationRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "documentationUrl",
  "connectionSpecification" : {
    "user" : {
      "type" : "string"
    }
  },
  "supportedDestinationSyncModes" : [ null, null ],
  "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "advancedAuth" : {
    "predicateValue" : "predicateValue",
    "oauthConfigSpecification" : { },
    "predicateKey" : [ "predicateKey", "predicateKey" ],
    "authFlowType" : "oauth2.0"
  },
  "jobInfo" : {
    "createdAt" : 0,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

DestinationOauth

Up 
post /v1/destination_oauths/complete_oauth
Given a destination def ID generate an access/refresh token etc. (completeDestinationOAuth)

Consumes

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

Request body

CompleteDestinationOAuthRequest CompleteDestinationOAuthRequest (required)
Body Parameter —

Return type

CompleteOAuthResponse

Example data

Content-Type: application/json
{
  "auth_payload" : {
    "key" : ""
  },
  "request_error" : "request_error",
  "request_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 CompleteOAuthResponse

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/destination_oauths/get_consent_url
Given a destination connector definition ID, return the URL to the consent screen where to redirect the user to. (getDestinationOAuthConsent)

Consumes

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

Request body

DestinationOauthConsentRequest DestinationOauthConsentRequest (required)
Body Parameter —

Return type

OAuthConsentRead

Example data

Content-Type: application/json
{
  "consentUrl" : "consentUrl"
}

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 OAuthConsentRead

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/destination_oauths/oauth_params/create
Sets instancewide variables to be used for the oauth flow when creating this destination. When set, these variables will be injected into a connector's configuration before any interaction with the connector image itself. This enables running oauth flows with consistent variables e.g: the company's Google Ads developer_token, client_id, and client_secret without the user having to know about these variables. (setInstancewideDestinationOauthParams)

Consumes

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

Request body

SetInstancewideDestinationOauthParamsRequestBody SetInstancewideDestinationOauthParamsRequestBody (required)
Body Parameter —

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

400

Exception occurred; see message for details. KnownExceptionInfo

404

Object with given id was not found. NotFoundKnownExceptionInfo

Health

Up 
get /v1/health
Health Check (getHealthCheck)

Return type

HealthCheckRead

Example data

Content-Type: application/json
{
  "available" : 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

Internal

Up 
post /v1/state/create_or_update
Create or update the state for a connection. (createOrUpdateState)

Consumes

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

Request body

ConnectionStateCreateOrUpdate ConnectionStateCreateOrUpdate (required)
Body Parameter —

Return type

ConnectionState

Example data

Content-Type: application/json
{
  "globalState" : {
    "streamStates" : [ {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      }
    }, {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamState" : [ {
    "streamDescriptor" : {
      "name" : "name",
      "namespace" : "namespace"
    }
  }, {
    "streamDescriptor" : {
      "name" : "name",
      "namespace" : "namespace"
    }
  } ]
}

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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/jobs/get_normalization_status
Get normalization status to determine if we can bypass normalization phase (getAttemptNormalizationStatusesForJob)

Consumes

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

Request body

JobIdRequestBody JobIdRequestBody (optional)
Body Parameter —

Return type

AttemptNormalizationStatusReadList

Example data

Content-Type: application/json
{
  "attemptNormalizationStatuses" : [ {
    "attemptNumber" : 0,
    "recordsCommitted" : 6,
    "hasRecordsCommitted" : true,
    "hasNormalizationFailed" : true
  }, {
    "attemptNumber" : 0,
    "recordsCommitted" : 6,
    "hasRecordsCommitted" : true,
    "hasNormalizationFailed" : 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 AttemptNormalizationStatusReadList
Up 
post /v1/attempt/save_stats
For worker to set sync stats of a running attempt. (saveStats)

Consumes

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

Request body

SaveStatsRequestBody SaveStatsRequestBody (required)
Body Parameter —

Return type

InternalOperationResult

Example data

Content-Type: application/json
{
  "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 InternalOperationResult
Up 
post /v1/attempt/save_sync_config
For worker to save the AttemptSyncConfig for an attempt. (saveSyncConfig)

Consumes

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

Request body

SaveAttemptSyncConfigRequestBody SaveAttemptSyncConfigRequestBody (required)
Body Parameter —

Return type

InternalOperationResult

Example data

Content-Type: application/json
{
  "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 InternalOperationResult
Up 
post /v1/attempt/set_workflow_in_attempt
For worker to register the workflow id in attempt. (setWorkflowInAttempt)

Consumes

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

Request body

SetWorkflowInAttemptRequestBody SetWorkflowInAttemptRequestBody (required)
Body Parameter —

Return type

InternalOperationResult

Example data

Content-Type: application/json
{
  "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 InternalOperationResult
Up 
post /v1/sources/write_discover_catalog_result
Should only called from worker, to write result from discover activity back to DB. (writeDiscoverCatalogResult)

Consumes

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

Request body

SourceDiscoverSchemaWriteRequestBody SourceDiscoverSchemaWriteRequestBody (required)
Body Parameter —

Return type

DiscoverCatalogResult

Example data

Content-Type: application/json
{
  "catalogId" : "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 DiscoverCatalogResult

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,
    "enabledStreams" : [ {
      "name" : "name",
      "namespace" : "namespace"
    }, {
      "name" : "name",
      "namespace" : "namespace"
    } ],
    "configId" : "configId",
    "startedAt" : 5,
    "id" : 0,
    "resetConfig" : {
      "streamsToReset" : [ {
        "name" : "name",
        "namespace" : "namespace"
      }, {
        "name" : "name",
        "namespace" : "namespace"
      } ]
    },
    "updatedAt" : 1
  },
  "attempts" : [ {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/jobs/get_normalization_status
Get normalization status to determine if we can bypass normalization phase (getAttemptNormalizationStatusesForJob)

Consumes

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

Request body

JobIdRequestBody JobIdRequestBody (optional)
Body Parameter —

Return type

AttemptNormalizationStatusReadList

Example data

Content-Type: application/json
{
  "attemptNormalizationStatuses" : [ {
    "attemptNumber" : 0,
    "recordsCommitted" : 6,
    "hasRecordsCommitted" : true,
    "hasNormalizationFailed" : true
  }, {
    "attemptNumber" : 0,
    "recordsCommitted" : 6,
    "hasRecordsCommitted" : true,
    "hasNormalizationFailed" : 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 AttemptNormalizationStatusReadList
Up 
post /v1/jobs/get_debug_info
Gets all information needed to debug this job (getJobDebugInfo)

Consumes

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

Request body

JobIdRequestBody JobIdRequestBody (required)
Body Parameter —

Return type

JobDebugInfoRead

Example data

Content-Type: application/json
{
  "workflowState" : {
    "running" : true
  },
  "job" : {
    "configId" : "configId",
    "sourceDefinition" : {
      "resourceRequirements" : {
        "default" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        },
        "jobSpecific" : [ {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        }, {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        } ]
      },
      "documentationUrl" : "https://openapi-generator.tech",
      "dockerImageTag" : "dockerImageTag",
      "releaseDate" : "2000-01-23",
      "sourceType" : "api",
      "dockerRepository" : "dockerRepository",
      "name" : "name",
      "icon" : "icon",
      "protocolVersion" : "protocolVersion",
      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "maxSecondsBetweenMessages" : 0
    },
    "airbyteVersion" : "airbyteVersion",
    "id" : 0,
    "destinationDefinition" : {
      "resourceRequirements" : {
        "default" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        },
        "jobSpecific" : [ {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        }, {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        } ]
      },
      "documentationUrl" : "https://openapi-generator.tech",
      "dockerImageTag" : "dockerImageTag",
      "releaseDate" : "2000-01-23",
      "dockerRepository" : "dockerRepository",
      "supportsDbt" : true,
      "name" : "name",
      "icon" : "icon",
      "normalizationConfig" : {
        "normalizationIntegrationType" : "normalizationIntegrationType",
        "normalizationRepository" : "normalizationRepository",
        "normalizationTag" : "normalizationTag",
        "supported" : false
      },
      "protocolVersion" : "protocolVersion",
      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }
  },
  "attempts" : [ {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "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 JobDebugInfoRead

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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,
    "enabledStreams" : [ {
      "name" : "name",
      "namespace" : "namespace"
    }, {
      "name" : "name",
      "namespace" : "namespace"
    } ],
    "configId" : "configId",
    "startedAt" : 5,
    "id" : 0,
    "resetConfig" : {
      "streamsToReset" : [ {
        "name" : "name",
        "namespace" : "namespace"
      }, {
        "name" : "name",
        "namespace" : "namespace"
      } ]
    },
    "updatedAt" : 1
  },
  "attempts" : [ {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/jobs/get_light
Get information about a job excluding attempt info and logs (getJobInfoLight)

Consumes

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

Request body

JobIdRequestBody JobIdRequestBody (required)
Body Parameter —

Return type

JobInfoLightRead

Example data

Content-Type: application/json
{
  "job" : {
    "createdAt" : 6,
    "enabledStreams" : [ {
      "name" : "name",
      "namespace" : "namespace"
    }, {
      "name" : "name",
      "namespace" : "namespace"
    } ],
    "configId" : "configId",
    "startedAt" : 5,
    "id" : 0,
    "resetConfig" : {
      "streamsToReset" : [ {
        "name" : "name",
        "namespace" : "namespace"
      }, {
        "name" : "name",
        "namespace" : "namespace"
      } ]
    },
    "updatedAt" : 1
  }
}

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 JobInfoLightRead

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/jobs/get_without_logs
Get information about a job excluding logs (getJobInfoWithoutLogs)

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,
    "enabledStreams" : [ {
      "name" : "name",
      "namespace" : "namespace"
    }, {
      "name" : "name",
      "namespace" : "namespace"
    } ],
    "configId" : "configId",
    "startedAt" : 5,
    "id" : 0,
    "resetConfig" : {
      "streamsToReset" : [ {
        "name" : "name",
        "namespace" : "namespace"
      }, {
        "name" : "name",
        "namespace" : "namespace"
      } ]
    },
    "updatedAt" : 1
  },
  "attempts" : [ {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/jobs/get_last_replication_job
(getLastReplicationJob)

Consumes

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

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

JobOptionalRead

Example data

Content-Type: application/json
{
  "job" : {
    "createdAt" : 6,
    "enabledStreams" : [ {
      "name" : "name",
      "namespace" : "namespace"
    }, {
      "name" : "name",
      "namespace" : "namespace"
    } ],
    "configId" : "configId",
    "startedAt" : 5,
    "id" : 0,
    "resetConfig" : {
      "streamsToReset" : [ {
        "name" : "name",
        "namespace" : "namespace"
      }, {
        "name" : "name",
        "namespace" : "namespace"
      } ]
    },
    "updatedAt" : 1
  }
}

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 JobOptionalRead

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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
{
  "totalJobCount" : 0,
  "jobs" : [ {
    "job" : {
      "createdAt" : 6,
      "enabledStreams" : [ {
        "name" : "name",
        "namespace" : "namespace"
      }, {
        "name" : "name",
        "namespace" : "namespace"
      } ],
      "configId" : "configId",
      "startedAt" : 5,
      "id" : 0,
      "resetConfig" : {
        "streamsToReset" : [ {
          "name" : "name",
          "namespace" : "namespace"
        }, {
          "name" : "name",
          "namespace" : "namespace"
        } ]
      },
      "updatedAt" : 1
    },
    "attempts" : [ {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    }, {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    } ]
  }, {
    "job" : {
      "createdAt" : 6,
      "enabledStreams" : [ {
        "name" : "name",
        "namespace" : "namespace"
      }, {
        "name" : "name",
        "namespace" : "namespace"
      } ],
      "configId" : "configId",
      "startedAt" : 5,
      "id" : 0,
      "resetConfig" : {
        "streamsToReset" : [ {
          "name" : "name",
          "namespace" : "namespace"
        }, {
          "name" : "name",
          "namespace" : "namespace"
        } ]
      },
      "updatedAt" : 1
    },
    "attempts" : [ {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    }, {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 7,
        "estimatedRecords" : 6,
        "recordsEmitted" : 4,
        "bytesCommitted" : 1
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 1
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 7,
          "estimatedRecords" : 6,
          "recordsEmitted" : 4,
          "bytesCommitted" : 1
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    } ]
  } ]
}

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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

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

OperatorConfiguration OperatorConfiguration (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

Input failed validation InvalidInputExceptionInfo
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" : {
    "webhook" : {
      "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "dbtCloud" : {
        "accountId" : 0,
        "jobId" : 6
      },
      "executionUrl" : "executionUrl",
      "executionBody" : "executionBody",
      "webhookType" : "dbtCloud"
    },
    "normalization" : {
      "option" : "basic"
    },
    "dbt" : {
      "gitRepoBranch" : "gitRepoBranch",
      "dockerImage" : "dockerImage",
      "dbtArguments" : "dbtArguments",
      "gitRepoUrl" : "gitRepoUrl"
    }
  },
  "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 OperationRead

422

Input failed validation InvalidInputExceptionInfo
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 —

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

204

The resource was deleted successfully.

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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" : {
    "webhook" : {
      "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "dbtCloud" : {
        "accountId" : 0,
        "jobId" : 6
      },
      "executionUrl" : "executionUrl",
      "executionBody" : "executionBody",
      "webhookType" : "dbtCloud"
    },
    "normalization" : {
      "option" : "basic"
    },
    "dbt" : {
      "gitRepoBranch" : "gitRepoBranch",
      "dockerImage" : "dockerImage",
      "dbtArguments" : "dbtArguments",
      "gitRepoUrl" : "gitRepoUrl"
    }
  },
  "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 OperationRead

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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" : {
      "webhook" : {
        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dbtCloud" : {
          "accountId" : 0,
          "jobId" : 6
        },
        "executionUrl" : "executionUrl",
        "executionBody" : "executionBody",
        "webhookType" : "dbtCloud"
      },
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "webhook" : {
        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dbtCloud" : {
          "accountId" : 0,
          "jobId" : 6
        },
        "executionUrl" : "executionUrl",
        "executionBody" : "executionBody",
        "webhookType" : "dbtCloud"
      },
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    },
    "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 OperationReadList

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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" : {
    "webhook" : {
      "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "dbtCloud" : {
        "accountId" : 0,
        "jobId" : 6
      },
      "executionUrl" : "executionUrl",
      "executionBody" : "executionBody",
      "webhookType" : "dbtCloud"
    },
    "normalization" : {
      "option" : "basic"
    },
    "dbt" : {
      "gitRepoBranch" : "gitRepoBranch",
      "dockerImage" : "dockerImage",
      "dbtArguments" : "dbtArguments",
      "gitRepoUrl" : "gitRepoUrl"
    }
  },
  "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 OperationRead

422

Input failed validation InvalidInputExceptionInfo

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,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "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

Input failed validation InvalidInputExceptionInfo
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,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "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

Input failed validation InvalidInputExceptionInfo
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
{
  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "breakingChange" : true,
  "catalog" : {
    "streams" : [ {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "jobInfo" : {
    "createdAt" : 0,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  },
  "catalogDiff" : {
    "transforms" : [ {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      },
      "transformType" : "add_stream",
      "updateStream" : [ {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      }, {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      } ]
    }, {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      },
      "transformType" : "add_stream",
      "updateStream" : [ {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      }, {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : 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

Input failed validation InvalidInputExceptionInfo

Source

Up 
post /v1/sources/apply_schema_changes
Auto propagate the change on a catalog to a catalog saved in the DB. It will fetch all the connections linked to a source id and apply the provided diff to their catalog. (applySchemaChangeForSource)

Consumes

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

Request body

SourceAutoPropagateChange SourceAutoPropagateChange (required)
Body Parameter —

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

204

The schema was properly auto propagate

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/sources/clone
Clone source (cloneSource)

Consumes

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

Request body

SourceCloneRequestBody SourceCloneRequestBody (required)
Body Parameter —

Return type

SourceRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "name" : "name",
  "icon" : "icon",
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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",
  "icon" : "icon",
  "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

Input failed validation InvalidInputExceptionInfo
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 —

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

204

The resource was deleted successfully.

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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

SourceDiscoverSchemaRequestBody SourceDiscoverSchemaRequestBody (required)
Body Parameter —

Return type

SourceDiscoverSchemaRead

Example data

Content-Type: application/json
{
  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "breakingChange" : true,
  "catalog" : {
    "streams" : [ {
      "stream" : {
        "sourceDefinedPrimaryKey" : [ [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ], [ "sourceDefinedPrimaryKey", "sourceDefinedPrimaryKey" ] ],
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "namespace" : "namespace",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ]
      },
      "config" : {
        "aliasName" : "aliasName",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "jobInfo" : {
    "createdAt" : 0,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  },
  "catalogDiff" : {
    "transforms" : [ {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      },
      "transformType" : "add_stream",
      "updateStream" : [ {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      }, {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      } ]
    }, {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      },
      "transformType" : "add_stream",
      "updateStream" : [ {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      }, {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : 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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/sources/most_recent_source_actor_catalog
Get most recent ActorCatalog for source (getMostRecentSourceActorCatalog)

Consumes

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

Request body

SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter —

Return type

ActorCatalogWithUpdatedAt

Example data

Content-Type: application/json
{
  "catalog" : "{}",
  "updatedAt" : 0
}

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 ActorCatalogWithUpdatedAt

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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",
  "icon" : "icon",
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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",
    "icon" : "icon",
    "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",
    "icon" : "icon",
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/sources/partial_update
Partially update a source (partialUpdateSource)

Consumes

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

Request body

PartialSourceUpdate PartialSourceUpdate (required)
Body Parameter —

Return type

SourceRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "connectionConfiguration" : {
    "user" : "charles"
  },
  "name" : "name",
  "icon" : "icon",
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/sources/search
Search sources (searchSources)

Consumes

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

Request body

SourceSearch SourceSearch (required)
Body Parameter —

Return type

SourceReadList

Example data

Content-Type: application/json
{
  "sources" : [ {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "name" : "name",
    "icon" : "icon",
    "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",
    "icon" : "icon",
    "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

422

Input failed validation InvalidInputExceptionInfo
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",
  "icon" : "icon",
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/sources/write_discover_catalog_result
Should only called from worker, to write result from discover activity back to DB. (writeDiscoverCatalogResult)

Consumes

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

Request body

SourceDiscoverSchemaWriteRequestBody SourceDiscoverSchemaWriteRequestBody (required)
Body Parameter —

Return type

DiscoverCatalogResult

Example data

Content-Type: application/json
{
  "catalogId" : "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 DiscoverCatalogResult

SourceDefinition

Up 
post /v1/source_definitions/create_custom
Creates a custom sourceDefinition for the given workspace (createCustomSourceDefinition)

Consumes

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

Request body

CustomSourceDefinitionCreate CustomSourceDefinitionCreate (optional)
Body Parameter —

Return type

SourceDefinitionRead

Example data

Content-Type: application/json
{
  "resourceRequirements" : {
    "default" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "jobSpecific" : [ {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    }, {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    } ]
  },
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "releaseDate" : "2000-01-23",
  "sourceType" : "api",
  "dockerRepository" : "dockerRepository",
  "name" : "name",
  "icon" : "icon",
  "protocolVersion" : "protocolVersion",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "maxSecondsBetweenMessages" : 0
}

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

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/source_definitions/delete
Delete a source definition (deleteSourceDefinition)

Consumes

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

Request body

SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
Body Parameter —

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

204

The resource was deleted successfully.

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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
{
  "resourceRequirements" : {
    "default" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "jobSpecific" : [ {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    }, {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    } ]
  },
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "releaseDate" : "2000-01-23",
  "sourceType" : "api",
  "dockerRepository" : "dockerRepository",
  "name" : "name",
  "icon" : "icon",
  "protocolVersion" : "protocolVersion",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "maxSecondsBetweenMessages" : 0
}

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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/source_definitions/get_for_workspace
Get a sourceDefinition that is configured for the given workspace (getSourceDefinitionForWorkspace)

Consumes

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

Request body

SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
Body Parameter —

Return type

SourceDefinitionRead

Example data

Content-Type: application/json
{
  "resourceRequirements" : {
    "default" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "jobSpecific" : [ {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    }, {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    } ]
  },
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "releaseDate" : "2000-01-23",
  "sourceType" : "api",
  "dockerRepository" : "dockerRepository",
  "name" : "name",
  "icon" : "icon",
  "protocolVersion" : "protocolVersion",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "maxSecondsBetweenMessages" : 0
}

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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/source_definitions/grant_definition
grant a private, non-custom sourceDefinition to a given workspace (grantSourceDefinitionToWorkspace)

Consumes

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

Request body

SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
Body Parameter —

Return type

PrivateSourceDefinitionRead

Example data

Content-Type: application/json
{
  "sourceDefinition" : {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "sourceType" : "api",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "protocolVersion" : "protocolVersion",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "maxSecondsBetweenMessages" : 0
  },
  "granted" : 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 PrivateSourceDefinitionRead

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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" : [ {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "sourceType" : "api",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "protocolVersion" : "protocolVersion",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "maxSecondsBetweenMessages" : 0
  }, {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "sourceType" : "api",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "protocolVersion" : "protocolVersion",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "maxSecondsBetweenMessages" : 0
  } ]
}

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_private
List all private, non-custom sourceDefinitions, and for each indicate whether the given workspace has a grant for using the definition. Used by admins to view and modify a given workspace's grants. (listPrivateSourceDefinitions)

Consumes

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

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
Body Parameter —

Return type

PrivateSourceDefinitionReadList

Example data

Content-Type: application/json
{
  "sourceDefinitions" : [ {
    "sourceDefinition" : {
      "resourceRequirements" : {
        "default" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        },
        "jobSpecific" : [ {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        }, {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        } ]
      },
      "documentationUrl" : "https://openapi-generator.tech",
      "dockerImageTag" : "dockerImageTag",
      "releaseDate" : "2000-01-23",
      "sourceType" : "api",
      "dockerRepository" : "dockerRepository",
      "name" : "name",
      "icon" : "icon",
      "protocolVersion" : "protocolVersion",
      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "maxSecondsBetweenMessages" : 0
    },
    "granted" : true
  }, {
    "sourceDefinition" : {
      "resourceRequirements" : {
        "default" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        },
        "jobSpecific" : [ {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        }, {
          "resourceRequirements" : {
            "cpu_limit" : "cpu_limit",
            "memory_request" : "memory_request",
            "memory_limit" : "memory_limit",
            "cpu_request" : "cpu_request"
          }
        } ]
      },
      "documentationUrl" : "https://openapi-generator.tech",
      "dockerImageTag" : "dockerImageTag",
      "releaseDate" : "2000-01-23",
      "sourceType" : "api",
      "dockerRepository" : "dockerRepository",
      "name" : "name",
      "icon" : "icon",
      "protocolVersion" : "protocolVersion",
      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "maxSecondsBetweenMessages" : 0
    },
    "granted" : 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 PrivateSourceDefinitionReadList
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" : [ {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "sourceType" : "api",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "protocolVersion" : "protocolVersion",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "maxSecondsBetweenMessages" : 0
  }, {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "sourceType" : "api",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "protocolVersion" : "protocolVersion",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "maxSecondsBetweenMessages" : 0
  } ]
}

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_for_workspace
List all the sourceDefinitions the given workspace is configured to use (listSourceDefinitionsForWorkspace)

Consumes

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

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (optional)
Body Parameter —

Return type

SourceDefinitionReadList

Example data

Content-Type: application/json
{
  "sourceDefinitions" : [ {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "sourceType" : "api",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "protocolVersion" : "protocolVersion",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "maxSecondsBetweenMessages" : 0
  }, {
    "resourceRequirements" : {
      "default" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      },
      "jobSpecific" : [ {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      }, {
        "resourceRequirements" : {
          "cpu_limit" : "cpu_limit",
          "memory_request" : "memory_request",
          "memory_limit" : "memory_limit",
          "cpu_request" : "cpu_request"
        }
      } ]
    },
    "documentationUrl" : "https://openapi-generator.tech",
    "dockerImageTag" : "dockerImageTag",
    "releaseDate" : "2000-01-23",
    "sourceType" : "api",
    "dockerRepository" : "dockerRepository",
    "name" : "name",
    "icon" : "icon",
    "protocolVersion" : "protocolVersion",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "maxSecondsBetweenMessages" : 0
  } ]
}

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/revoke_definition
revoke a grant to a private, non-custom sourceDefinition from a given workspace (revokeSourceDefinitionFromWorkspace)

Consumes

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

Request body

SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
Body Parameter —

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

204

The resource was deleted successfully.

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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
{
  "resourceRequirements" : {
    "default" : {
      "cpu_limit" : "cpu_limit",
      "memory_request" : "memory_request",
      "memory_limit" : "memory_limit",
      "cpu_request" : "cpu_request"
    },
    "jobSpecific" : [ {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    }, {
      "resourceRequirements" : {
        "cpu_limit" : "cpu_limit",
        "memory_request" : "memory_request",
        "memory_limit" : "memory_limit",
        "cpu_request" : "cpu_request"
      }
    } ]
  },
  "documentationUrl" : "https://openapi-generator.tech",
  "dockerImageTag" : "dockerImageTag",
  "releaseDate" : "2000-01-23",
  "sourceType" : "api",
  "dockerRepository" : "dockerRepository",
  "name" : "name",
  "icon" : "icon",
  "protocolVersion" : "protocolVersion",
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "maxSecondsBetweenMessages" : 0
}

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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

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

SourceDefinitionIdWithWorkspaceId SourceDefinitionIdWithWorkspaceId (required)
Body Parameter —

Return type

SourceDefinitionSpecificationRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "documentationUrl",
  "connectionSpecification" : {
    "user" : {
      "type" : "string"
    }
  },
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "advancedAuth" : {
    "predicateValue" : "predicateValue",
    "oauthConfigSpecification" : { },
    "predicateKey" : [ "predicateKey", "predicateKey" ],
    "authFlowType" : "oauth2.0"
  },
  "jobInfo" : {
    "createdAt" : 0,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/source_definition_specifications/get_for_source
Get specification for a source. (getSpecificationForSourceId)

Consumes

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

Request body

SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter —

Return type

SourceDefinitionSpecificationRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "documentationUrl",
  "connectionSpecification" : {
    "user" : {
      "type" : "string"
    }
  },
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "advancedAuth" : {
    "predicateValue" : "predicateValue",
    "oauthConfigSpecification" : { },
    "predicateKey" : [ "predicateKey", "predicateKey" ],
    "authFlowType" : "oauth2.0"
  },
  "jobInfo" : {
    "createdAt" : 0,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "failureReason" : {
      "retryable" : true,
      "stacktrace" : "stacktrace",
      "internalMessage" : "internalMessage",
      "externalMessage" : "externalMessage",
      "timestamp" : 1
    },
    "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

SourceOauth

Up 
post /v1/source_oauths/complete_oauth
Given a source def ID generate an access/refresh token etc. (completeSourceOAuth)

Consumes

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

Request body

CompleteSourceOauthRequest CompleteSourceOauthRequest (required)
Body Parameter —

Return type

CompleteOAuthResponse

Example data

Content-Type: application/json
{
  "auth_payload" : {
    "key" : ""
  },
  "request_error" : "request_error",
  "request_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 CompleteOAuthResponse

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/source_oauths/get_consent_url
Given a source connector definition ID, return the URL to the consent screen where to redirect the user to. (getSourceOAuthConsent)

Consumes

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

Request body

SourceOauthConsentRequest SourceOauthConsentRequest (required)
Body Parameter —

Return type

OAuthConsentRead

Example data

Content-Type: application/json
{
  "consentUrl" : "consentUrl"
}

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 OAuthConsentRead

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/source_oauths/revoke
Given a source definition ID and workspace ID revoke access/refresh token etc. (revokeSourceOAuthTokens)

Consumes

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

Request body

RevokeSourceOauthTokensRequest RevokeSourceOauthTokensRequest (required)
Body Parameter —

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

400

Exception occurred; see message for details. KnownExceptionInfo

404

Object with given id was not found. NotFoundKnownExceptionInfo
Up 
post /v1/source_oauths/oauth_params/create
Sets instancewide variables to be used for the oauth flow when creating this source. When set, these variables will be injected into a connector's configuration before any interaction with the connector image itself. This enables running oauth flows with consistent variables e.g: the company's Google Ads developer_token, client_id, and client_secret without the user having to know about these variables. (setInstancewideSourceOauthParams)

Consumes

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

Request body

SetInstancewideSourceOauthParamsRequestBody SetInstancewideSourceOauthParamsRequestBody (required)
Body Parameter —

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

400

Exception occurred; see message for details. KnownExceptionInfo

404

Object with given id was not found. NotFoundKnownExceptionInfo

State

Up 
post /v1/state/create_or_update
Create or update the state for a connection. (createOrUpdateState)

Consumes

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

Request body

ConnectionStateCreateOrUpdate ConnectionStateCreateOrUpdate (required)
Body Parameter —

Return type

ConnectionState

Example data

Content-Type: application/json
{
  "globalState" : {
    "streamStates" : [ {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      }
    }, {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamState" : [ {
    "streamDescriptor" : {
      "name" : "name",
      "namespace" : "namespace"
    }
  }, {
    "streamDescriptor" : {
      "name" : "name",
      "namespace" : "namespace"
    }
  } ]
}

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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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
{
  "globalState" : {
    "streamStates" : [ {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      }
    }, {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamState" : [ {
    "streamDescriptor" : {
      "name" : "name",
      "namespace" : "namespace"
    }
  }, {
    "streamDescriptor" : {
      "name" : "name",
      "namespace" : "namespace"
    }
  } ]
}

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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

StreamStatuses

Up 
post /v1/stream_statuses/create
Creates a stream status. (createStreamStatus)

Consumes

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

Request body

StreamStatusCreateRequestBody StreamStatusCreateRequestBody (optional)
Body Parameter —

Return type

StreamStatusRead

Example data

Content-Type: application/json
{
  "attemptNumber" : 0,
  "jobId" : 6,
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamNamespace" : "streamNamespace",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamName" : "streamName",
  "transitionedAt" : 1,
  "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

201

Successfully created stream status. StreamStatusRead
Up 
post /v1/stream_statuses/list
Gets a list of stream statuses filtered by parameters (with AND semantics). (getStreamStatuses)

Consumes

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

Request body

StreamStatusListRequestBody StreamStatusListRequestBody (optional)
Body Parameter —

Return type

StreamStatusReadList

Example data

Content-Type: application/json
{
  "streamStatuses" : [ {
    "attemptNumber" : 0,
    "jobId" : 6,
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "streamNamespace" : "streamNamespace",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "streamName" : "streamName",
    "transitionedAt" : 1,
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "attemptNumber" : 0,
    "jobId" : 6,
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "streamNamespace" : "streamNamespace",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "streamName" : "streamName",
    "transitionedAt" : 1,
    "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

Successfully queried stream statuses. StreamStatusReadList
Up 
post /v1/stream_statuses/update
Updates a stream status. (updateStreamStatus)

Consumes

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

Request body

StreamStatusUpdateRequestBody StreamStatusUpdateRequestBody (optional)
Body Parameter —

Return type

StreamStatusRead

Example data

Content-Type: application/json
{
  "attemptNumber" : 0,
  "jobId" : 6,
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamNamespace" : "streamNamespace",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamName" : "streamName",
  "transitionedAt" : 1,
  "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

201

Successfully created stream status. StreamStatusRead

200

Successfully updated stream status. StreamStatusRead

Streams

Up 
post /v1/stream_statuses/create
Creates a stream status. (createStreamStatus)

Consumes

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

Request body

StreamStatusCreateRequestBody StreamStatusCreateRequestBody (optional)
Body Parameter —

Return type

StreamStatusRead

Example data

Content-Type: application/json
{
  "attemptNumber" : 0,
  "jobId" : 6,
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamNamespace" : "streamNamespace",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamName" : "streamName",
  "transitionedAt" : 1,
  "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

201

Successfully created stream status. StreamStatusRead
Up 
post /v1/stream_statuses/list
Gets a list of stream statuses filtered by parameters (with AND semantics). (getStreamStatuses)

Consumes

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

Request body

StreamStatusListRequestBody StreamStatusListRequestBody (optional)
Body Parameter —

Return type

StreamStatusReadList

Example data

Content-Type: application/json
{
  "streamStatuses" : [ {
    "attemptNumber" : 0,
    "jobId" : 6,
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "streamNamespace" : "streamNamespace",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "streamName" : "streamName",
    "transitionedAt" : 1,
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "attemptNumber" : 0,
    "jobId" : 6,
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "streamNamespace" : "streamNamespace",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "streamName" : "streamName",
    "transitionedAt" : 1,
    "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

Successfully queried stream statuses. StreamStatusReadList
Up 
post /v1/stream_statuses/update
Updates a stream status. (updateStreamStatus)

Consumes

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

Request body

StreamStatusUpdateRequestBody StreamStatusUpdateRequestBody (optional)
Body Parameter —

Return type

StreamStatusRead

Example data

Content-Type: application/json
{
  "attemptNumber" : 0,
  "jobId" : 6,
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamNamespace" : "streamNamespace",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "streamName" : "streamName",
  "transitionedAt" : 1,
  "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

201

Successfully created stream status. StreamStatusRead

200

Successfully updated stream status. StreamStatusRead

WebBackend

Up 
post /v1/web_backend/state/get_type
Fetch the current state type for a connection. (getStateType)

Consumes

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

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

ConnectionStateType

Example data

Content-Type: application/json
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 ConnectionStateType

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/web_backend/check_updates
Returns a summary of source and destination definitions that could be updated. (webBackendCheckUpdates)

Return type

WebBackendCheckUpdatesRead

Example data

Content-Type: application/json
{
  "destinationDefinitions" : 0,
  "sourceDefinitions" : 6
}

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 WebBackendCheckUpdatesRead
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",
    "icon" : "icon",
    "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",
    "icon" : "icon",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceName" : "sourceName",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "catalogDiff" : {
    "transforms" : [ {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      },
      "transformType" : "add_stream",
      "updateStream" : [ {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      }, {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      } ]
    }, {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      },
      "transformType" : "add_stream",
      "updateStream" : [ {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      }, {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      } ]
    } ]
  },
  "operations" : [ {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "webhook" : {
        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dbtCloud" : {
          "accountId" : 0,
          "jobId" : 6
        },
        "executionUrl" : "executionUrl",
        "executionBody" : "executionBody",
        "webhookType" : "dbtCloud"
      },
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "webhook" : {
        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dbtCloud" : {
          "accountId" : 0,
          "jobId" : 6
        },
        "executionUrl" : "executionUrl",
        "executionBody" : "executionBody",
        "webhookType" : "dbtCloud"
      },
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "notifySchemaChanges" : true,
  "notifySchemaChangesByEmail" : true,
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "scheduleData" : {
    "cron" : {
      "cronExpression" : "cronExpression",
      "cronTimeZone" : "cronTimeZone"
    },
    "basicSchedule" : {
      "units" : 6,
      "timeUnit" : "minutes"
    }
  },
  "resourceRequirements" : {
    "cpu_limit" : "cpu_limit",
    "memory_request" : "memory_request",
    "memory_limit" : "memory_limit",
    "cpu_request" : "cpu_request"
  },
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "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

Input failed validation InvalidInputExceptionInfo
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",
    "icon" : "icon",
    "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",
    "icon" : "icon",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceName" : "sourceName",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "catalogDiff" : {
    "transforms" : [ {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      },
      "transformType" : "add_stream",
      "updateStream" : [ {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      }, {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      } ]
    }, {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      },
      "transformType" : "add_stream",
      "updateStream" : [ {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      }, {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      } ]
    } ]
  },
  "operations" : [ {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "webhook" : {
        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dbtCloud" : {
          "accountId" : 0,
          "jobId" : 6
        },
        "executionUrl" : "executionUrl",
        "executionBody" : "executionBody",
        "webhookType" : "dbtCloud"
      },
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "webhook" : {
        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dbtCloud" : {
          "accountId" : 0,
          "jobId" : 6
        },
        "executionUrl" : "executionUrl",
        "executionBody" : "executionBody",
        "webhookType" : "dbtCloud"
      },
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "notifySchemaChanges" : true,
  "notifySchemaChangesByEmail" : true,
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "scheduleData" : {
    "cron" : {
      "cronExpression" : "cronExpression",
      "cronTimeZone" : "cronTimeZone"
    },
    "basicSchedule" : {
      "units" : 6,
      "timeUnit" : "minutes"
    }
  },
  "resourceRequirements" : {
    "cpu_limit" : "cpu_limit",
    "memory_request" : "memory_request",
    "memory_limit" : "memory_limit",
    "cpu_request" : "cpu_request"
  },
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/web_backend/workspace/state
Returns the current state of a workspace (webBackendGetWorkspaceState)

Consumes

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

Request body

WebBackendWorkspaceState WebBackendWorkspaceState (optional)
Body Parameter —

Return type

WebBackendWorkspaceStateResult

Example data

Content-Type: application/json
{
  "hasDestinations" : true,
  "hasConnections" : true,
  "hasSources" : 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 WebBackendWorkspaceStateResult

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/web_backend/connections/list
Returns all non-deleted connections for a workspace. (webBackendListConnectionsForWorkspace)

Consumes

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

Request body

WebBackendConnectionListRequestBody WebBackendConnectionListRequestBody (required)
Body Parameter —

Return type

WebBackendConnectionReadList

Example data

Content-Type: application/json
{
  "connections" : [ {
    "latestSyncJobCreatedAt" : 0,
    "name" : "name",
    "destination" : {
      "destinationName" : "destinationName",
      "name" : "name",
      "icon" : "icon",
      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isSyncing" : true,
    "source" : {
      "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "name" : "name",
      "icon" : "icon",
      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "sourceName" : "sourceName"
    },
    "scheduleData" : {
      "cron" : {
        "cronExpression" : "cronExpression",
        "cronTimeZone" : "cronTimeZone"
      },
      "basicSchedule" : {
        "units" : 6,
        "timeUnit" : "minutes"
      }
    }
  }, {
    "latestSyncJobCreatedAt" : 0,
    "name" : "name",
    "destination" : {
      "destinationName" : "destinationName",
      "name" : "name",
      "icon" : "icon",
      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isSyncing" : true,
    "source" : {
      "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "name" : "name",
      "icon" : "icon",
      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "sourceName" : "sourceName"
    },
    "scheduleData" : {
      "cron" : {
        "cronExpression" : "cronExpression",
        "cronTimeZone" : "cronTimeZone"
      },
      "basicSchedule" : {
        "units" : 6,
        "timeUnit" : "minutes"
      }
    }
  } ]
}

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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/web_backend/geographies/list
Returns available geographies can be selected to run data syncs in a particular geography. The 'auto' entry indicates that the sync will be automatically assigned to a geography according to the platform default behavior. Entries other than 'auto' are two-letter country codes that follow the ISO 3166-1 alpha-2 standard. (webBackendListGeographies)
Returns all available geographies in which a data sync can run.

Return type

WebBackendGeographiesListResult

Example data

Content-Type: application/json
{
  "geographies" : [ 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 WebBackendGeographiesListResult
Up 
post /v1/web_backend/connections/update
Update a connection (webBackendUpdateConnection)
Apply a patch-style update to a connection. Only fields present on the update request body will be updated. Any operations that lack an ID will be created. Then, the newly created operationId will be applied to the connection along with the rest of the operationIds in the request body. Apply a patch-style update to a connection. Only fields present on the update request body will be updated. Note that if a catalog is present in the request body, the connection's entire catalog will be replaced with the catalog from the request. This means that to modify a single stream, the entire new catalog containing the updated stream needs to be sent.

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",
    "icon" : "icon",
    "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",
    "icon" : "icon",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceName" : "sourceName",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "catalogDiff" : {
    "transforms" : [ {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      },
      "transformType" : "add_stream",
      "updateStream" : [ {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      }, {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      } ]
    }, {
      "streamDescriptor" : {
        "name" : "name",
        "namespace" : "namespace"
      },
      "transformType" : "add_stream",
      "updateStream" : [ {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      }, {
        "updateFieldSchema" : { },
        "fieldName" : [ "fieldName", "fieldName" ],
        "addField" : { },
        "transformType" : "add_field",
        "removeField" : { },
        "breaking" : true
      } ]
    } ]
  },
  "operations" : [ {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "webhook" : {
        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dbtCloud" : {
          "accountId" : 0,
          "jobId" : 6
        },
        "executionUrl" : "executionUrl",
        "executionBody" : "executionBody",
        "webhookType" : "dbtCloud"
      },
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "operationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "operatorConfiguration" : {
      "webhook" : {
        "webhookConfigId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "dbtCloud" : {
          "accountId" : 0,
          "jobId" : 6
        },
        "executionUrl" : "executionUrl",
        "executionBody" : "executionBody",
        "webhookType" : "dbtCloud"
      },
      "normalization" : {
        "option" : "basic"
      },
      "dbt" : {
        "gitRepoBranch" : "gitRepoBranch",
        "dockerImage" : "dockerImage",
        "dbtArguments" : "dbtArguments",
        "gitRepoUrl" : "gitRepoUrl"
      }
    },
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "catalogId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "notifySchemaChanges" : true,
  "notifySchemaChangesByEmail" : true,
  "namespaceFormat" : "${SOURCE_NAMESPACE}",
  "scheduleData" : {
    "cron" : {
      "cronExpression" : "cronExpression",
      "cronTimeZone" : "cronTimeZone"
    },
    "basicSchedule" : {
      "units" : 6,
      "timeUnit" : "minutes"
    }
  },
  "resourceRequirements" : {
    "cpu_limit" : "cpu_limit",
    "memory_request" : "memory_request",
    "memory_limit" : "memory_limit",
    "cpu_request" : "cpu_request"
  },
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "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",
        "suggested" : true,
        "fieldSelectionEnabled" : true,
        "selectedFields" : [ {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        }, {
          "fieldPath" : [ "fieldPath", "fieldPath" ]
        } ],
        "cursorField" : [ "cursorField", "cursorField" ],
        "selected" : true,
        "primaryKey" : [ [ "primaryKey", "primaryKey" ], [ "primaryKey", "primaryKey" ] ]
      }
    } ]
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "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

Input failed validation InvalidInputExceptionInfo

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
{
  "news" : true,
  "webhookConfigs" : [ {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "notificationSettings" : {
    "sendOnConnectionUpdateActionRequired" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabledWarning" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSuccess" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnFailure" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnConnectionUpdate" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabled" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    }
  },
  "displaySetupWizard" : true,
  "initialSetupComplete" : true,
  "anonymousDataCollection" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "firstCompletedSync" : true,
  "feedbackDone" : true,
  "email" : "email",
  "slug" : "slug",
  "securityUpdates" : true,
  "notifications" : [ {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  }, {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  } ],
  "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

Input failed validation InvalidInputExceptionInfo
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 —

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

204

The resource was deleted successfully.

404

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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
{
  "news" : true,
  "webhookConfigs" : [ {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "notificationSettings" : {
    "sendOnConnectionUpdateActionRequired" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabledWarning" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSuccess" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnFailure" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnConnectionUpdate" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabled" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    }
  },
  "displaySetupWizard" : true,
  "initialSetupComplete" : true,
  "anonymousDataCollection" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "firstCompletedSync" : true,
  "feedbackDone" : true,
  "email" : "email",
  "slug" : "slug",
  "securityUpdates" : true,
  "notifications" : [ {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  }, {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  } ],
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/workspaces/get_by_connection_id
Find workspace by connection id (getWorkspaceByConnectionId)

Consumes

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

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

WorkspaceRead

Example data

Content-Type: application/json
{
  "news" : true,
  "webhookConfigs" : [ {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "notificationSettings" : {
    "sendOnConnectionUpdateActionRequired" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabledWarning" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSuccess" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnFailure" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnConnectionUpdate" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabled" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    }
  },
  "displaySetupWizard" : true,
  "initialSetupComplete" : true,
  "anonymousDataCollection" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "firstCompletedSync" : true,
  "feedbackDone" : true,
  "email" : "email",
  "slug" : "slug",
  "securityUpdates" : true,
  "notifications" : [ {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  }, {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  } ],
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
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
{
  "news" : true,
  "webhookConfigs" : [ {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "notificationSettings" : {
    "sendOnConnectionUpdateActionRequired" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabledWarning" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSuccess" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnFailure" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnConnectionUpdate" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabled" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    }
  },
  "displaySetupWizard" : true,
  "initialSetupComplete" : true,
  "anonymousDataCollection" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "firstCompletedSync" : true,
  "feedbackDone" : true,
  "email" : "email",
  "slug" : "slug",
  "securityUpdates" : true,
  "notifications" : [ {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  }, {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  } ],
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/workspaces/list
List all workspaces registered in the current Airbyte deployment (listWorkspaces)

Return type

WorkspaceReadList

Example data

Content-Type: application/json
{
  "workspaces" : [ {
    "news" : true,
    "webhookConfigs" : [ {
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ],
    "notificationSettings" : {
      "sendOnConnectionUpdateActionRequired" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      },
      "sendOnSyncDisabledWarning" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      },
      "sendOnSuccess" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      },
      "sendOnFailure" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      },
      "sendOnConnectionUpdate" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      },
      "sendOnSyncDisabled" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      }
    },
    "displaySetupWizard" : true,
    "initialSetupComplete" : true,
    "anonymousDataCollection" : true,
    "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "firstCompletedSync" : true,
    "feedbackDone" : true,
    "email" : "email",
    "slug" : "slug",
    "securityUpdates" : true,
    "notifications" : [ {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "sendOnSuccess" : false,
      "sendOnFailure" : true,
      "customerioConfiguration" : "{}"
    }, {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "sendOnSuccess" : false,
      "sendOnFailure" : true,
      "customerioConfiguration" : "{}"
    } ],
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "news" : true,
    "webhookConfigs" : [ {
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "name" : "name",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ],
    "notificationSettings" : {
      "sendOnConnectionUpdateActionRequired" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      },
      "sendOnSyncDisabledWarning" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      },
      "sendOnSuccess" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      },
      "sendOnFailure" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      },
      "sendOnConnectionUpdate" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      },
      "sendOnSyncDisabled" : {
        "slackConfiguration" : {
          "webhook" : "webhook"
        },
        "customerioConfiguration" : "{}",
        "notificationType" : [ null, null ]
      }
    },
    "displaySetupWizard" : true,
    "initialSetupComplete" : true,
    "anonymousDataCollection" : true,
    "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "firstCompletedSync" : true,
    "feedbackDone" : true,
    "email" : "email",
    "slug" : "slug",
    "securityUpdates" : true,
    "notifications" : [ {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "sendOnSuccess" : false,
      "sendOnFailure" : true,
      "customerioConfiguration" : "{}"
    }, {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "sendOnSuccess" : false,
      "sendOnFailure" : true,
      "customerioConfiguration" : "{}"
    } ],
    "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 WorkspaceReadList
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
{
  "news" : true,
  "webhookConfigs" : [ {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "notificationSettings" : {
    "sendOnConnectionUpdateActionRequired" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabledWarning" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSuccess" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnFailure" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnConnectionUpdate" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabled" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    }
  },
  "displaySetupWizard" : true,
  "initialSetupComplete" : true,
  "anonymousDataCollection" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "firstCompletedSync" : true,
  "feedbackDone" : true,
  "email" : "email",
  "slug" : "slug",
  "securityUpdates" : true,
  "notifications" : [ {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  }, {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  } ],
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo
Up 
post /v1/workspaces/tag_feedback_status_as_done
Update workspace feedback state (updateWorkspaceFeedback)

Consumes

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

Request body

WorkspaceGiveFeedback WorkspaceGiveFeedback (required)
Body Parameter —

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

204

The feedback state has been properly updated

404

Object with given id was not found. NotFoundKnownExceptionInfo
Up 
post /v1/workspaces/update_name
Update workspace name (updateWorkspaceName)

Consumes

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

Request body

WorkspaceUpdateName WorkspaceUpdateName (required)
Body Parameter —

Return type

WorkspaceRead

Example data

Content-Type: application/json
{
  "news" : true,
  "webhookConfigs" : [ {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "name" : "name",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ],
  "notificationSettings" : {
    "sendOnConnectionUpdateActionRequired" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabledWarning" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSuccess" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnFailure" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnConnectionUpdate" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    },
    "sendOnSyncDisabled" : {
      "slackConfiguration" : {
        "webhook" : "webhook"
      },
      "customerioConfiguration" : "{}",
      "notificationType" : [ null, null ]
    }
  },
  "displaySetupWizard" : true,
  "initialSetupComplete" : true,
  "anonymousDataCollection" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "firstCompletedSync" : true,
  "feedbackDone" : true,
  "email" : "email",
  "slug" : "slug",
  "securityUpdates" : true,
  "notifications" : [ {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  }, {
    "slackConfiguration" : {
      "webhook" : "webhook"
    },
    "sendOnSuccess" : false,
    "sendOnFailure" : true,
    "customerioConfiguration" : "{}"
  } ],
  "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

Object with given id was not found. NotFoundKnownExceptionInfo

422

Input failed validation InvalidInputExceptionInfo

Models

[ Jump to Methods ]

Table of Contents

  1. ActorCatalogWithUpdatedAt -
  2. ActorDefinitionRequestBody -
  3. ActorDefinitionResourceRequirements -
  4. ActorType -
  5. AdvancedAuth -
  6. AirbyteCatalog -
  7. AirbyteStream -
  8. AirbyteStreamAndConfiguration -
  9. AirbyteStreamConfiguration -
  10. AttemptFailureSummary -
  11. AttemptInfoRead -
  12. AttemptNormalizationStatusRead -
  13. AttemptNormalizationStatusReadList -
  14. AttemptRead -
  15. AttemptStats -
  16. AttemptStatus -
  17. AttemptStreamStats -
  18. AttemptSyncConfig -
  19. CatalogDiff -
  20. CheckConnectionRead -
  21. CheckOperationRead -
  22. CompleteDestinationOAuthRequest -
  23. CompleteOAuthResponse -
  24. CompleteSourceOauthRequest -
  25. ConnectionCreate -
  26. ConnectionIdRequestBody -
  27. ConnectionRead -
  28. ConnectionReadList -
  29. ConnectionSchedule -
  30. ConnectionScheduleData -
  31. ConnectionScheduleData_basicSchedule -
  32. ConnectionScheduleData_cron -
  33. ConnectionScheduleType -
  34. ConnectionSearch -
  35. ConnectionState -
  36. ConnectionStateCreateOrUpdate -
  37. ConnectionStateType -
  38. ConnectionStatus -
  39. ConnectionStream -
  40. ConnectionStreamRequestBody -
  41. ConnectionUpdate -
  42. ConnectorBuilderProjectDetails -
  43. ConnectorBuilderProjectDetailsRead -
  44. ConnectorBuilderProjectIdWithWorkspaceId -
  45. ConnectorBuilderProjectRead -
  46. ConnectorBuilderProjectReadList -
  47. ConnectorBuilderProjectWithWorkspaceId -
  48. ConnectorBuilderPublishRequestBody -
  49. CustomDestinationDefinitionCreate -
  50. CustomSourceDefinitionCreate -
  51. DataType -
  52. DbMigrationExecutionRead -
  53. DbMigrationRead -
  54. DbMigrationReadList -
  55. DbMigrationRequestBody -
  56. DbMigrationState -
  57. DeclarativeManifestRead -
  58. DeclarativeManifestVersionRead -
  59. DeclarativeManifestsReadList -
  60. DeclarativeSourceDefinitionCreateManifestRequestBody -
  61. DeclarativeSourceManifest -
  62. DestinationCloneConfiguration -
  63. DestinationCloneRequestBody -
  64. DestinationCoreConfig -
  65. DestinationCreate -
  66. DestinationDefinitionCreate -
  67. DestinationDefinitionIdRequestBody -
  68. DestinationDefinitionIdWithWorkspaceId -
  69. DestinationDefinitionRead -
  70. DestinationDefinitionReadList -
  71. DestinationDefinitionSpecificationRead -
  72. DestinationDefinitionUpdate -
  73. DestinationIdRequestBody -
  74. DestinationOauthConsentRequest -
  75. DestinationRead -
  76. DestinationReadList -
  77. DestinationSearch -
  78. DestinationSnippetRead -
  79. DestinationSyncMode -
  80. DestinationUpdate -
  81. DiscoverCatalogResult -
  82. ExistingConnectorBuilderProjectWithWorkspaceId -
  83. FailureOrigin -
  84. FailureReason -
  85. FailureType -
  86. FieldAdd -
  87. FieldRemove -
  88. FieldSchemaUpdate -
  89. FieldTransform -
  90. Geography -
  91. GlobalState -
  92. HealthCheckRead -
  93. ImportRead -
  94. ImportRequestBody -
  95. InternalOperationResult -
  96. InvalidInputExceptionInfo -
  97. InvalidInputProperty -
  98. JobConfigType -
  99. JobDebugInfoRead -
  100. JobDebugRead -
  101. JobIdRequestBody -
  102. JobInfoLightRead -
  103. JobInfoRead -
  104. JobListRequestBody -
  105. JobOptionalRead -
  106. JobRead -
  107. JobReadList -
  108. JobStatus -
  109. JobType -
  110. JobTypeResourceLimit -
  111. JobWithAttemptsRead -
  112. KnownExceptionInfo -
  113. ListConnectionsForWorkspacesRequestBody -
  114. ListDeclarativeManifestsRequestBody -
  115. ListResourcesForWorkspacesRequestBody -
  116. LogRead -
  117. LogType -
  118. LogsRequestBody -
  119. NamespaceDefinitionType -
  120. NonBreakingChangesPreference -
  121. NormalizationDestinationDefinitionConfig -
  122. NotFoundKnownExceptionInfo -
  123. Notification -
  124. NotificationItem -
  125. NotificationRead -
  126. NotificationSettings -
  127. NotificationType -
  128. OAuthConfigSpecification -
  129. OAuthConsentRead -
  130. OperationCreate -
  131. OperationIdRequestBody -
  132. OperationRead -
  133. OperationReadList -
  134. OperationUpdate -
  135. OperatorConfiguration -
  136. OperatorDbt -
  137. OperatorNormalization -
  138. OperatorType -
  139. OperatorWebhook -
  140. OperatorWebhook_dbtCloud -
  141. Pagination -
  142. PartialDestinationUpdate -
  143. PartialSourceUpdate -
  144. PrivateDestinationDefinitionRead -
  145. PrivateDestinationDefinitionReadList -
  146. PrivateSourceDefinitionRead -
  147. PrivateSourceDefinitionReadList -
  148. ReleaseStage -
  149. ResetConfig -
  150. ResourceRequirements -
  151. RevokeSourceOauthTokensRequest -
  152. SaveAttemptSyncConfigRequestBody -
  153. SaveStatsRequestBody -
  154. SchemaChange -
  155. SelectedFieldInfo -
  156. SetInstancewideDestinationOauthParamsRequestBody -
  157. SetInstancewideSourceOauthParamsRequestBody -
  158. SetWorkflowInAttemptRequestBody -
  159. SlackNotificationConfiguration -
  160. SlugRequestBody -
  161. SourceAutoPropagateChange -
  162. SourceCloneConfiguration -
  163. SourceCloneRequestBody -
  164. SourceCoreConfig -
  165. SourceCreate -
  166. SourceDefinitionCreate -
  167. SourceDefinitionIdBody -
  168. SourceDefinitionIdRequestBody -
  169. SourceDefinitionIdWithWorkspaceId -
  170. SourceDefinitionRead -
  171. SourceDefinitionReadList -
  172. SourceDefinitionSpecificationRead -
  173. SourceDefinitionUpdate -
  174. SourceDiscoverSchemaRead -
  175. SourceDiscoverSchemaRequestBody -
  176. SourceDiscoverSchemaWriteRequestBody -
  177. SourceIdRequestBody -
  178. SourceOauthConsentRequest -
  179. SourceRead -
  180. SourceReadList -
  181. SourceSearch -
  182. SourceSnippetRead -
  183. SourceUpdate -
  184. StreamDescriptor -
  185. StreamState -
  186. StreamStatusCreateRequestBody -
  187. StreamStatusIncompleteRunCause -
  188. StreamStatusJobType -
  189. StreamStatusListRequestBody -
  190. StreamStatusRead -
  191. StreamStatusReadList -
  192. StreamStatusRunState -
  193. StreamStatusUpdateRequestBody -
  194. StreamTransform -
  195. SyncMode -
  196. SynchronousJobRead -
  197. UpdateActiveManifestRequestBody -
  198. UploadRead -
  199. WebBackendCheckUpdatesRead -
  200. WebBackendConnectionCreate -
  201. WebBackendConnectionListItem -
  202. WebBackendConnectionListRequestBody -
  203. WebBackendConnectionRead -
  204. WebBackendConnectionReadList -
  205. WebBackendConnectionRequestBody -
  206. WebBackendConnectionUpdate -
  207. WebBackendGeographiesListResult -
  208. WebBackendOperationCreateOrUpdate -
  209. WebBackendWorkspaceState -
  210. WebBackendWorkspaceStateResult -
  211. WebhookConfigRead -
  212. WebhookConfigWrite -
  213. WorkflowStateRead -
  214. WorkspaceCreate -
  215. WorkspaceGiveFeedback -
  216. WorkspaceIdRequestBody -
  217. WorkspaceOverrideOauthParamsRequestBody -
  218. WorkspaceRead -
  219. WorkspaceReadList -
  220. WorkspaceUpdate -
  221. WorkspaceUpdateName -

ActorCatalogWithUpdatedAt - Up

A source actor catalog with the timestamp it was mostly recently updated
updatedAt (optional)
Long format: int64
catalog (optional)
Object

ActorDefinitionRequestBody - Up

actorDefinitionId
UUID format: uuid
actorType
ActorType

ActorDefinitionResourceRequirements - Up

actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
default (optional)
ResourceRequirements
jobSpecific (optional)
array[JobTypeResourceLimit]

ActorType - Up

AdvancedAuth - Up

authFlowType (optional)
String
Enum:
oauth2.0
oauth1.0
predicateKey (optional)
array[String] Json Path to a field in the connectorSpecification that should exist for the advanced auth to be applicable.
predicateValue (optional)
String Value of the predicate_key fields for the advanced auth to be applicable.
oauthConfigSpecification (optional)
OAuthConfigSpecification

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 If this is true, the stream is selected with all of its properties. For new connections, this considers if the stream is suggested or not
suggested (optional)
Boolean Does the connector suggest that this stream be enabled by default?
fieldSelectionEnabled (optional)
Boolean Whether field selection should be enabled. If this is true, only the properties in selectedFields will be included.
selectedFields (optional)
array[SelectedFieldInfo] Paths to the fields that will be included in the configured catalog. This must be set if fieldSelectedEnabled is set. An empty list indicates that no properties will be included.

AttemptFailureSummary - Up

failures
array[FailureReason]
partialSuccess (optional)
Boolean True if the number of committed records for this attempt was greater than 0. False if 0 records were committed. If not set, the number of committed records is unknown.

AttemptInfoRead - Up

attempt
AttemptRead
logs
LogRead

AttemptNormalizationStatusRead - Up

attemptNumber (optional)
Integer format: int32
hasRecordsCommitted (optional)
Boolean
recordsCommitted (optional)
Long format: int64
hasNormalizationFailed (optional)
Boolean

AttemptNormalizationStatusReadList - Up

attemptNormalizationStatuses (optional)
array[AttemptNormalizationStatusRead]

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
totalStats (optional)
AttemptStats
streamStats (optional)
array[AttemptStreamStats]
failureSummary (optional)
AttemptFailureSummary

AttemptStats - Up

recordsEmitted (optional)
Long format: int64
bytesEmitted (optional)
Long format: int64
stateMessagesEmitted (optional)
Long format: int64
bytesCommitted (optional)
Long format: int64
recordsCommitted (optional)
Long format: int64
estimatedRecords (optional)
Long format: int64
estimatedBytes (optional)
Long format: int64

AttemptStatus - Up

AttemptStreamStats - Up

streamName
String
streamNamespace (optional)
String
stats
AttemptStats

AttemptSyncConfig - Up

sourceConfiguration
SourceConfiguration
destinationConfiguration
DestinationConfiguration
state (optional)
ConnectionState

CatalogDiff - Up

Describes the difference between two Airbyte catalogs.
transforms
array[StreamTransform] list of stream transformations. order does not matter.

CheckConnectionRead - Up

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

CheckOperationRead - Up

status
String
Enum:
succeeded
failed
message (optional)
String

CompleteDestinationOAuthRequest - Up

destinationDefinitionId
UUID format: uuid
workspaceId
UUID format: uuid
redirectUrl (optional)
String When completing OAuth flow to gain an access token, some API sometimes requires to verify that the app re-send the redirectUrl that was used when consent was given.
queryParams (optional)
map[String, oas_any_type_not_mapped] The query parameters present in the redirect URL after a user granted consent e.g auth code
oAuthInputConfiguration (optional)
OAuthConfiguration
destinationId (optional)
UUID format: uuid

CompleteOAuthResponse - Up

request_succeeded
Boolean
request_error (optional)
String
auth_payload
map[String, oas_any_type_not_mapped]

CompleteSourceOauthRequest - Up

sourceDefinitionId
UUID format: uuid
workspaceId
UUID format: uuid
redirectUrl (optional)
String When completing OAuth flow to gain an access token, some API sometimes requires to verify that the app re-send the redirectUrl that was used when consent was given.
queryParams (optional)
map[String, oas_any_type_not_mapped] The query parameters present in the redirect URL after a user granted consent e.g auth code
oAuthInputConfiguration (optional)
OAuthConfiguration
returnSecretCoordinate (optional)
Boolean If set to true, returns a secret coordinate which references the stored tokens. By default, returns raw tokens.
sourceId (optional)
UUID format: uuid

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
scheduleType (optional)
ConnectionScheduleType
scheduleData (optional)
ConnectionScheduleData
status
ConnectionStatus
resourceRequirements (optional)
ResourceRequirements
sourceCatalogId (optional)
UUID format: uuid
geography (optional)
Geography
notifySchemaChanges (optional)
Boolean
notifySchemaChangesByEmail (optional)
Boolean
nonBreakingChangesPreference (optional)
NonBreakingChangesPreference

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
scheduleType (optional)
ConnectionScheduleType
scheduleData (optional)
ConnectionScheduleData
status
ConnectionStatus
resourceRequirements (optional)
ResourceRequirements
sourceCatalogId (optional)
UUID format: uuid
geography (optional)
Geography
breakingChange
Boolean
notifySchemaChanges (optional)
Boolean
notifySchemaChangesByEmail (optional)
Boolean
nonBreakingChangesPreference (optional)
NonBreakingChangesPreference
workspaceId (optional)
UUID format: uuid

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

ConnectionScheduleData - Up

schedule for when the the connection should run, per the schedule type
basicSchedule (optional)
ConnectionScheduleData_basicSchedule
cron (optional)
ConnectionScheduleData_cron

ConnectionScheduleData_basicSchedule - Up

timeUnit
String
Enum:
minutes
hours
days
weeks
months
units
Long format: int64

ConnectionScheduleData_cron - Up

cronExpression
String
cronTimeZone
String

ConnectionScheduleType - Up

determine how the schedule data should be interpreted

ConnectionSearch - Up

connectionId (optional)
UUID format: uuid
name (optional)
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 (optional)
UUID format: uuid
destinationId (optional)
UUID format: uuid
schedule (optional)
ConnectionSchedule
scheduleType (optional)
ConnectionScheduleType
scheduleData (optional)
ConnectionScheduleData
status (optional)
ConnectionStatus
source (optional)
SourceSearch
destination (optional)
DestinationSearch

ConnectionState - Up

Contains the state for a connection. The stateType field identifies what type of state it is. Only the field corresponding to that type will be set, the rest will be null. If stateType=not_set, then none of the fields will be set.
stateType
ConnectionStateType
connectionId
UUID format: uuid
state (optional)
StateBlob
streamState (optional)
array[StreamState]
globalState (optional)
GlobalState

ConnectionStateCreateOrUpdate - Up

connectionId
UUID format: uuid
connectionState
ConnectionState

ConnectionStateType - Up

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.

ConnectionStream - Up

streamName
String
streamNamespace
String

ConnectionStreamRequestBody - Up

connectionId
UUID format: uuid
streams
array[ConnectionStream]

ConnectionUpdate - Up

Used to apply a patch-style update to a connection, which means that null properties remain unchanged
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'.
name (optional)
String Name that will be set to this connection
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 (optional)
AirbyteCatalog
schedule (optional)
ConnectionSchedule
scheduleType (optional)
ConnectionScheduleType
scheduleData (optional)
ConnectionScheduleData
status (optional)
ConnectionStatus
resourceRequirements (optional)
ResourceRequirements
sourceCatalogId (optional)
UUID format: uuid
geography (optional)
Geography
notifySchemaChanges (optional)
Boolean
notifySchemaChangesByEmail (optional)
Boolean
nonBreakingChangesPreference (optional)
NonBreakingChangesPreference
breakingChange (optional)
Boolean

ConnectorBuilderProjectDetails - Up

name
String
draftManifest (optional)
Object Low code CDK manifest JSON object

ConnectorBuilderProjectDetailsRead - Up

name
String
builderProjectId
UUID format: uuid
sourceDefinitionId (optional)
UUID format: uuid
activeDeclarativeManifestVersion (optional)
Long format: int64
hasDraft
Boolean

ConnectorBuilderProjectIdWithWorkspaceId - Up

workspaceId
UUID format: uuid
builderProjectId
UUID format: uuid
version (optional)
Long format: int64

ConnectorBuilderProjectRead - Up

builderProject
ConnectorBuilderProjectDetailsRead
declarativeManifest (optional)
DeclarativeManifestRead

ConnectorBuilderProjectReadList - Up

projects
array[ConnectorBuilderProjectDetailsRead]

ConnectorBuilderProjectWithWorkspaceId - Up

workspaceId
UUID format: uuid
builderProject
ConnectorBuilderProjectDetails

ConnectorBuilderPublishRequestBody - Up

workspaceId
UUID format: uuid
builderProjectId
UUID format: uuid
name
String
initialDeclarativeManifest
DeclarativeSourceManifest

CustomDestinationDefinitionCreate - Up

workspaceId
UUID format: uuid
destinationDefinition
DestinationDefinitionCreate

CustomSourceDefinitionCreate - Up

workspaceId
UUID format: uuid
sourceDefinition
SourceDefinitionCreate

DataType - Up

DbMigrationExecutionRead - Up

initialVersion (optional)
String
targetVersion (optional)
String
executedMigrations (optional)
array[DbMigrationRead]

DbMigrationRead - Up

migrationType
String
migrationVersion
String
migrationDescription
String
migrationState (optional)
DbMigrationState
migratedBy (optional)
String
migratedAt (optional)
Long format: int64
migrationScript (optional)
String

DbMigrationReadList - Up

migrations (optional)
array[DbMigrationRead]

DbMigrationRequestBody - Up

database
String

DbMigrationState - Up

DeclarativeManifestRead - Up

manifest (optional)
Object Low code CDK manifest JSON object
isDraft (optional)
Boolean
version (optional)
Long format: int64
description (optional)
String

DeclarativeManifestVersionRead - Up

version
Long format: int64
isActive
Boolean
description
String

DeclarativeManifestsReadList - Up

manifestVersions
array[DeclarativeManifestVersionRead]

DeclarativeSourceDefinitionCreateManifestRequestBody - Up

workspaceId
UUID format: uuid
sourceDefinitionId
UUID format: uuid
setAsActiveManifest
Boolean
declarativeManifest
DeclarativeSourceManifest

DeclarativeSourceManifest - Up

description
String
manifest
Object Low code CDK manifest JSON object
spec
SourceDefinitionSpecification
version
Long format: int64

DestinationCloneConfiguration - Up

connectionConfiguration (optional)
DestinationConfiguration
name (optional)
String

DestinationCloneRequestBody - Up

The values required to configure the destination. The schema for this should have an id of the existing destination along with the configuration you want to change in case.
destinationCloneId
UUID format: uuid
destinationConfiguration (optional)
DestinationCloneConfiguration

DestinationCoreConfig - Up

destinationId (optional)
UUID format: uuid
destinationDefinitionId
UUID format: uuid
connectionConfiguration
DestinationConfiguration
workspaceId
UUID format: uuid

DestinationCreate - Up

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

DestinationDefinitionCreate - Up

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

DestinationDefinitionIdRequestBody - Up

destinationDefinitionId
UUID format: uuid

DestinationDefinitionIdWithWorkspaceId - Up

destinationDefinitionId
UUID format: uuid
workspaceId
UUID format: uuid

DestinationDefinitionRead - Up

destinationDefinitionId
UUID format: uuid
name
String
dockerRepository
String
dockerImageTag
String
documentationUrl
URI format: uri
icon (optional)
String
protocolVersion (optional)
String The Airbyte Protocol version supported by the connector
releaseStage (optional)
ReleaseStage
releaseDate (optional)
date The date when this connector was first released, in yyyy-mm-dd format. format: date
resourceRequirements (optional)
ActorDefinitionResourceRequirements
supportsDbt
Boolean an optional flag indicating whether DBT is used in the normalization. If the flag value is NULL - DBT is not used.
normalizationConfig
NormalizationDestinationDefinitionConfig

DestinationDefinitionReadList - Up

destinationDefinitions
array[DestinationDefinitionRead]

DestinationDefinitionSpecificationRead - Up

destinationDefinitionId
UUID format: uuid
documentationUrl (optional)
String
connectionSpecification (optional)
DestinationDefinitionSpecification
advancedAuth (optional)
AdvancedAuth
jobInfo
SynchronousJobRead
supportedDestinationSyncModes (optional)
array[DestinationSyncMode]

DestinationDefinitionUpdate - Up

destinationDefinitionId
UUID format: uuid
dockerImageTag (optional)
String
resourceRequirements (optional)
ActorDefinitionResourceRequirements

DestinationIdRequestBody - Up

destinationId
UUID format: uuid

DestinationOauthConsentRequest - Up

destinationDefinitionId
UUID format: uuid
workspaceId
UUID format: uuid
redirectUrl
String The url to redirect to after getting the user consent
oAuthInputConfiguration (optional)
OAuthConfiguration
destinationId (optional)
UUID format: uuid

DestinationRead - Up

destinationDefinitionId
UUID format: uuid
destinationId
UUID format: uuid
workspaceId
UUID format: uuid
connectionConfiguration
DestinationConfiguration
name
String
destinationName
String
icon (optional)
String

DestinationReadList - Up

destinations
array[DestinationRead]

DestinationSearch - Up

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

DestinationSnippetRead - Up

destinationId
UUID format: uuid
name
String
destinationDefinitionId
UUID format: uuid
destinationName
String
icon (optional)
String

DestinationSyncMode - Up

DestinationUpdate - Up

destinationId
UUID format: uuid
connectionConfiguration
DestinationConfiguration
name
String

DiscoverCatalogResult - Up

catalogId
UUID format: uuid

ExistingConnectorBuilderProjectWithWorkspaceId - Up

workspaceId
UUID format: uuid
builderProjectId
UUID format: uuid
builderProject
ConnectorBuilderProjectDetails

FailureOrigin - Up

Indicates where the error originated. If not set, the origin of error is not well known.

FailureReason - Up

failureOrigin (optional)
FailureOrigin
failureType (optional)
FailureType
externalMessage (optional)
String
internalMessage (optional)
String
stacktrace (optional)
String
retryable (optional)
Boolean True if it is known that retrying may succeed, e.g. for a transient failure. False if it is known that a retry will not succeed, e.g. for a configuration issue. If not set, retryable status is not well known.
timestamp
Long format: int64

FailureType - Up

Categorizes well known errors into types for programmatic handling. If not set, the type of error is not well known.

FieldAdd - Up

schema (optional)
FieldSchema

FieldRemove - Up

schema (optional)
FieldSchema

FieldSchemaUpdate - Up

oldSchema
FieldSchema
newSchema
FieldSchema

FieldTransform - Up

Describes the difference between two Streams.
transformType
String
Enum:
add_field
remove_field
update_field_schema
fieldName
array[String] A field name is a list of strings that form the path to the field.
breaking
Boolean
addField (optional)
FieldAdd
removeField (optional)
FieldRemove
updateFieldSchema (optional)
FieldSchemaUpdate

Geography - Up

GlobalState - Up

shared_state (optional)
StateBlob
streamStates
array[StreamState]

HealthCheckRead - Up

available
Boolean

ImportRead - Up

status
String
Enum:
succeeded
failed
reason (optional)
String

ImportRequestBody - Up

resourceId
UUID format: uuid
workspaceId
UUID format: uuid

InternalOperationResult - Up

succeeded
Boolean

InvalidInputExceptionInfo - Up

message
String
exceptionClassName (optional)
String
exceptionStack (optional)
array[String]
validationErrors
array[InvalidInputProperty]

InvalidInputProperty - Up

propertyPath
String
invalidValue (optional)
String
message (optional)
String

JobConfigType - Up

JobDebugInfoRead - Up

job
JobDebugRead
attempts
array[AttemptInfoRead]
workflowState (optional)
WorkflowStateRead

JobDebugRead - Up

id
Long format: int64
configType
JobConfigType
configId
String
status
JobStatus
airbyteVersion
String
sourceDefinition
SourceDefinitionRead
destinationDefinition
DestinationDefinitionRead

JobIdRequestBody - Up

id
Long format: int64

JobInfoLightRead - Up

job
JobRead

JobInfoRead - Up

job
JobRead
attempts
array[AttemptInfoRead]

JobListRequestBody - Up

configTypes
array[JobConfigType]
configId
String
includingJobId (optional)
Long format: int64
pagination (optional)
Pagination

JobOptionalRead - Up

job (optional)
JobRead

JobRead - Up

id
Long format: int64
configType
JobConfigType
configId
String
enabledStreams (optional)
array[StreamDescriptor]
createdAt
Long format: int64
updatedAt
Long format: int64
startedAt (optional)
Long format: int64
status
JobStatus
resetConfig (optional)
ResetConfig

JobReadList - Up

jobs
array[JobWithAttemptsRead]
totalJobCount
Long the total count of jobs for the specified connection format: int64

JobStatus - Up

JobType - Up

enum that describes the different types of jobs that the platform runs.

JobTypeResourceLimit - Up

sets resource requirements for a specific job type for an actor definition. these values override the default, if both are set.
jobType
JobType
resourceRequirements
ResourceRequirements

JobWithAttemptsRead - Up

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

KnownExceptionInfo - Up

message
String
exceptionClassName (optional)
String
exceptionStack (optional)
array[String]
rootCauseExceptionClassName (optional)
String
rootCauseExceptionStack (optional)
array[String]

ListConnectionsForWorkspacesRequestBody - Up

workspaceIds
array[UUID] format: uuid
userId
UUID format: uuid
pagination (optional)
Pagination
includeDeleted (optional)
Boolean

ListDeclarativeManifestsRequestBody - Up

workspaceId
UUID format: uuid
sourceDefinitionId
UUID format: uuid

ListResourcesForWorkspacesRequestBody - Up

workspaceIds
array[UUID] format: uuid
includeDeleted (optional)
Boolean
pagination (optional)
Pagination

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

NonBreakingChangesPreference - Up

NormalizationDestinationDefinitionConfig - Up

describes a normalization config for destination definition
supported
Boolean whether the destination definition supports normalization.
normalizationRepository (optional)
String a field indicating the name of the repository to be used for normalization. If the value of the flag is NULL - normalization is not used.
normalizationTag (optional)
String a field indicating the tag of the docker repository to be used for normalization.
normalizationIntegrationType (optional)
String a field indicating the type of integration dialect to use for normalization.

NotFoundKnownExceptionInfo - Up

id (optional)
String
message
String
exceptionClassName (optional)
String
exceptionStack (optional)
array[String]
rootCauseExceptionClassName (optional)
String
rootCauseExceptionStack (optional)
array[String]

Notification - Up

notificationType
NotificationType
sendOnSuccess
Boolean
sendOnFailure
Boolean
slackConfiguration (optional)
SlackNotificationConfiguration
customerioConfiguration (optional)
Object

NotificationItem - Up

notificationType (optional)
array[NotificationType]
slackConfiguration (optional)
SlackNotificationConfiguration
customerioConfiguration (optional)
Object

NotificationRead - Up

status
String
Enum:
succeeded
failed
message (optional)
String

NotificationSettings - Up

sendOnSuccess (optional)
NotificationItem
sendOnFailure (optional)
NotificationItem
sendOnSyncDisabled (optional)
NotificationItem
sendOnSyncDisabledWarning (optional)
NotificationItem
sendOnConnectionUpdate (optional)
NotificationItem
sendOnConnectionUpdateActionRequired (optional)
NotificationItem

NotificationType - Up

OAuthConfigSpecification - Up

oauthUserInputFromConnectorConfigSpecification (optional)
OAuthConfiguration
completeOAuthOutputSpecification (optional)
OAuthConfiguration
completeOAuthServerInputSpecification (optional)
OAuthConfiguration
completeOAuthServerOutputSpecification (optional)
OAuthConfiguration

OAuthConsentRead - Up

consentUrl
String

OperationCreate - Up

workspaceId
UUID format: uuid
name
String
operatorConfiguration
OperatorConfiguration

OperationIdRequestBody - Up

operationId
UUID format: uuid

OperationRead - Up

workspaceId
UUID format: uuid
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
webhook (optional)
OperatorWebhook

OperatorDbt - Up

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

OperatorNormalization - Up

option (optional)
String
Enum:
basic

OperatorType - Up

OperatorWebhook - Up

webhookConfigId (optional)
UUID The id of the webhook configs to use from the workspace. format: uuid
webhookType (optional)
String
Enum:
dbtCloud
dbtCloud (optional)
OperatorWebhook_dbtCloud
executionUrl (optional)
String DEPRECATED. Populate dbtCloud instead.
executionBody (optional)
String DEPRECATED. Populate dbtCloud instead.

OperatorWebhook_dbtCloud - Up

accountId
Integer The account id associated with the job
jobId
Integer The job id associated with the job

Pagination - Up

pageSize (optional)
Integer
rowOffset (optional)
Integer

PartialDestinationUpdate - Up

destinationId (optional)
UUID format: uuid
connectionConfiguration (optional)
DestinationConfiguration
name (optional)
String

PartialSourceUpdate - Up

sourceId
UUID format: uuid
connectionConfiguration (optional)
SourceConfiguration
name (optional)
String
secretId (optional)
String

PrivateDestinationDefinitionRead - Up

destinationDefinition
DestinationDefinitionRead
granted
Boolean

PrivateDestinationDefinitionReadList - Up

destinationDefinitions
array[PrivateDestinationDefinitionRead]

PrivateSourceDefinitionRead - Up

sourceDefinition
SourceDefinitionRead
granted
Boolean

PrivateSourceDefinitionReadList - Up

sourceDefinitions
array[PrivateSourceDefinitionRead]

ReleaseStage - Up

ResetConfig - Up

contains information about how a reset was configured. only populated if the job was a reset.
streamsToReset (optional)
array[StreamDescriptor]

ResourceRequirements - Up

optional resource requirements to run workers (blank for unbounded allocations)
cpu_request (optional)
String
cpu_limit (optional)
String
memory_request (optional)
String
memory_limit (optional)
String

RevokeSourceOauthTokensRequest - Up

workspaceId
UUID format: uuid
sourceId
UUID format: uuid
sourceDefinitionId
UUID format: uuid

SaveAttemptSyncConfigRequestBody - Up

jobId
Long format: int64
attemptNumber
Integer format: int32
syncConfig
AttemptSyncConfig

SaveStatsRequestBody - Up

jobId
Long format: int64
attemptNumber
Integer format: int32
stats
AttemptStats
streamStats (optional)
array[AttemptStreamStats]

SchemaChange - Up

SelectedFieldInfo - Up

Path to a field/column/property in a stream to be selected. For example, if the field to be selected is a database column called "foo", this will be ["foo"]. Use multiple path elements for nested schemas.
fieldPath (optional)
array[String]

SetInstancewideDestinationOauthParamsRequestBody - Up

destinationDefinitionId
UUID format: uuid
params
map[String, oas_any_type_not_mapped]

SetInstancewideSourceOauthParamsRequestBody - Up

sourceDefinitionId
UUID format: uuid
params
map[String, oas_any_type_not_mapped]

SetWorkflowInAttemptRequestBody - Up

jobId
Long format: int64
attemptNumber
Integer format: int32
workflowId
String
processingTaskQueue (optional)
String

SlackNotificationConfiguration - Up

webhook
String

SlugRequestBody - Up

slug
String

SourceAutoPropagateChange - Up

Input of the source propagation, it contains the discovered catalog and a list of diff that need to be applied to the existing catalog.
catalog
AirbyteCatalog
catalogId
UUID format: uuid
sourceId
UUID format: uuid
workspaceId
UUID format: uuid

SourceCloneConfiguration - Up

connectionConfiguration (optional)
SourceConfiguration
name (optional)
String

SourceCloneRequestBody - Up

The values required to configure the source. The schema for this should have an id of the existing source along with the configuration you want to change in case.
sourceCloneId
UUID format: uuid
sourceConfiguration (optional)
SourceCloneConfiguration

SourceCoreConfig - Up

sourceId (optional)
UUID format: uuid
sourceDefinitionId
UUID format: uuid
connectionConfiguration
SourceConfiguration
workspaceId
UUID format: uuid

SourceCreate - Up

sourceDefinitionId
UUID format: uuid
connectionConfiguration
SourceConfiguration
workspaceId
UUID format: uuid
name
String
secretId (optional)
String

SourceDefinitionCreate - Up

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

SourceDefinitionIdBody - Up

sourceDefinitionId
UUID format: uuid

SourceDefinitionIdRequestBody - Up

sourceDefinitionId
UUID format: uuid

SourceDefinitionIdWithWorkspaceId - Up

sourceDefinitionId
UUID format: uuid
workspaceId
UUID format: uuid

SourceDefinitionRead - Up

sourceDefinitionId
UUID format: uuid
name
String
dockerRepository
String
dockerImageTag
String
documentationUrl (optional)
URI format: uri
icon (optional)
String
protocolVersion (optional)
String The Airbyte Protocol version supported by the connector
releaseStage (optional)
ReleaseStage
releaseDate (optional)
date The date when this connector was first released, in yyyy-mm-dd format. format: date
sourceType (optional)
String
Enum:
api
file
database
custom
resourceRequirements (optional)
ActorDefinitionResourceRequirements
maxSecondsBetweenMessages (optional)
Long Number of seconds allowed between 2 airbyte protocol messages. The source will timeout if this delay is reach format: int64

SourceDefinitionReadList - Up

sourceDefinitions
array[SourceDefinitionRead]

SourceDefinitionSpecificationRead - Up

sourceDefinitionId
UUID format: uuid
documentationUrl (optional)
String
connectionSpecification (optional)
SourceDefinitionSpecification
advancedAuth (optional)
AdvancedAuth
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
resourceRequirements (optional)
ActorDefinitionResourceRequirements

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
catalogId (optional)
UUID format: uuid
catalogDiff (optional)
CatalogDiff
breakingChange (optional)
Boolean
connectionStatus (optional)
ConnectionStatus

SourceDiscoverSchemaRequestBody - Up

sourceId
UUID format: uuid
connectionId (optional)
UUID format: uuid
disable_cache (optional)
Boolean
notifySchemaChange (optional)
Boolean

SourceDiscoverSchemaWriteRequestBody - Up

to write this requested object to database.
catalog
AirbyteCatalog
sourceId (optional)
UUID format: uuid
connectorVersion (optional)
String
configurationHash (optional)
String

SourceIdRequestBody - Up

sourceId
UUID format: uuid

SourceOauthConsentRequest - Up

sourceDefinitionId
UUID format: uuid
workspaceId
UUID format: uuid
redirectUrl
String The url to redirect to after getting the user consent
oAuthInputConfiguration (optional)
OAuthConfiguration
sourceId (optional)
UUID format: uuid

SourceRead - Up

sourceDefinitionId
UUID format: uuid
sourceId
UUID format: uuid
workspaceId
UUID format: uuid
connectionConfiguration
SourceConfiguration
name
String
sourceName
String
icon (optional)
String

SourceReadList - Up

sources
array[SourceRead]

SourceSearch - Up

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

SourceSnippetRead - Up

sourceId
UUID format: uuid
name
String
sourceDefinitionId
UUID format: uuid
sourceName
String
icon (optional)
String

SourceUpdate - Up

sourceId
UUID format: uuid
connectionConfiguration
SourceConfiguration
name
String
secretId (optional)
String

StreamDescriptor - Up

name
String
namespace (optional)
String

StreamState - Up

streamDescriptor
StreamDescriptor
streamState (optional)
StateBlob

StreamStatusCreateRequestBody - Up

attemptNumber
Integer format: int32
connectionId
UUID format: uuid
jobId
Long format: int64
incompleteRunCause (optional)
StreamStatusIncompleteRunCause
jobType
StreamStatusJobType
runState
StreamStatusRunState
streamName
String
streamNamespace (optional)
String
transitionedAt
Long format: int64
workspaceId
UUID format: uuid

StreamStatusIncompleteRunCause - Up

Values:

StreamStatusJobType - Up

StreamStatusListRequestBody - Up

attemptNumber (optional)
Integer format: int32
connectionId (optional)
UUID format: uuid
jobId (optional)
Long format: int64
jobType (optional)
StreamStatusJobType
pagination
Pagination
streamName (optional)
String
streamNamespace (optional)
String
workspaceId
UUID format: uuid

StreamStatusRead - Up

attemptNumber
Integer format: int32
connectionId
UUID format: uuid
id
UUID format: uuid
jobId
Long format: int64
incompleteRunCause (optional)
StreamStatusIncompleteRunCause
jobType
StreamStatusJobType
runState
StreamStatusRunState
streamName
String
streamNamespace
String
transitionedAt
Long format: int64
workspaceId
UUID format: uuid

StreamStatusReadList - Up

streamStatuses (optional)
array[StreamStatusRead]

StreamStatusRunState - Up

Values:

StreamStatusUpdateRequestBody - Up

id
UUID format: uuid
attemptNumber
Integer format: int32
connectionId
UUID format: uuid
jobId
Long format: int64
incompleteRunCause (optional)
StreamStatusIncompleteRunCause
jobType
StreamStatusJobType
runState
StreamStatusRunState
streamName
String
streamNamespace (optional)
String
transitionedAt
Long format: int64
workspaceId
UUID format: uuid

StreamTransform - Up

transformType
String
Enum:
add_stream
remove_stream
update_stream
streamDescriptor
StreamDescriptor
updateStream (optional)
array[FieldTransform] list of field transformations. order does not matter.

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
connectorConfigurationUpdated (optional)
Boolean
logs (optional)
LogRead
failureReason (optional)
FailureReason

UpdateActiveManifestRequestBody - Up

workspaceId
UUID format: uuid
sourceDefinitionId
UUID format: uuid
version
Long format: int64

UploadRead - Up

status
String
Enum:
succeeded
failed
resourceId (optional)
UUID format: uuid

WebBackendCheckUpdatesRead - Up

Summary of source and destination definitions that could be updated
destinationDefinitions
Integer
sourceDefinitions
Integer

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
scheduleType (optional)
ConnectionScheduleType
scheduleData (optional)
ConnectionScheduleData
status
ConnectionStatus
resourceRequirements (optional)
ResourceRequirements
operations (optional)
array[OperationCreate]
sourceCatalogId (optional)
UUID format: uuid
geography (optional)
Geography
nonBreakingChangesPreference (optional)
NonBreakingChangesPreference

WebBackendConnectionListItem - Up

Information about a connection that shows up in the connection list view.
connectionId
UUID format: uuid
name
String
scheduleType (optional)
ConnectionScheduleType
scheduleData (optional)
ConnectionScheduleData
status
ConnectionStatus
source
SourceSnippetRead
destination
DestinationSnippetRead
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
schemaChange
SchemaChange

WebBackendConnectionListRequestBody - Up

workspaceId
UUID format: uuid
sourceId (optional)
array[UUID] format: uuid
destinationId (optional)
array[UUID] format: uuid

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
scheduleType (optional)
ConnectionScheduleType
scheduleData (optional)
ConnectionScheduleData
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
resourceRequirements (optional)
ResourceRequirements
catalogId (optional)
UUID format: uuid
catalogDiff (optional)
CatalogDiff
geography (optional)
Geography
schemaChange
SchemaChange
notifySchemaChanges
Boolean
notifySchemaChangesByEmail
Boolean
nonBreakingChangesPreference
NonBreakingChangesPreference

WebBackendConnectionReadList - Up

connections
array[WebBackendConnectionListItem]

WebBackendConnectionRequestBody - Up

withRefreshedCatalog (optional)
Boolean
connectionId
UUID format: uuid

WebBackendConnectionUpdate - Up

Used to apply a patch-style update to a connection, which means that null properties remain unchanged
name (optional)
String Name that will be set to the connection
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.
syncCatalog (optional)
AirbyteCatalog
schedule (optional)
ConnectionSchedule
scheduleType (optional)
ConnectionScheduleType
scheduleData (optional)
ConnectionScheduleData
status (optional)
ConnectionStatus
resourceRequirements (optional)
ResourceRequirements
skipReset (optional)
Boolean
operations (optional)
array[WebBackendOperationCreateOrUpdate]
sourceCatalogId (optional)
UUID format: uuid
geography (optional)
Geography
notifySchemaChanges (optional)
Boolean
notifySchemaChangesByEmail (optional)
Boolean
nonBreakingChangesPreference (optional)
NonBreakingChangesPreference

WebBackendGeographiesListResult - Up

geographies
array[Geography]

WebBackendOperationCreateOrUpdate - Up

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

WebBackendWorkspaceState - Up

workspaceId
UUID format: uuid

WebBackendWorkspaceStateResult - Up

hasConnections
Boolean
hasSources
Boolean
hasDestinations
Boolean

WebhookConfigRead - Up

the readable info for a webhook config; omits sensitive info e.g. auth token
id
UUID format: uuid
name (optional)
String human-readable name e.g. for display in UI

WebhookConfigWrite - Up

name (optional)
String human readable name for this webhook e.g. for UI display.
authToken (optional)
String an auth token, to be passed as the value for an HTTP Authorization header.
validationUrl (optional)
String if supplied, the webhook config will be validated by checking that this URL returns a 2xx response.

WorkflowStateRead - Up

running
Boolean

WorkspaceCreate - Up

email (optional)
String format: email
anonymousDataCollection (optional)
Boolean
name
String
news (optional)
Boolean
securityUpdates (optional)
Boolean
notifications (optional)
array[Notification]
notificationSettings (optional)
NotificationSettings
displaySetupWizard (optional)
Boolean
defaultGeography (optional)
Geography
webhookConfigs (optional)
array[WebhookConfigWrite]

WorkspaceGiveFeedback - Up

workspaceId
UUID format: uuid

WorkspaceIdRequestBody - Up

workspaceId
UUID format: uuid

WorkspaceOverrideOauthParamsRequestBody - Up

definitionId
UUID format: uuid
params
map[String, oas_any_type_not_mapped]
workspaceId
UUID format: uuid
actorType
ActorType

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]
notificationSettings (optional)
NotificationSettings
firstCompletedSync (optional)
Boolean
feedbackDone (optional)
Boolean
defaultGeography (optional)
Geography
webhookConfigs (optional)
array[WebhookConfigRead]

WorkspaceReadList - Up

workspaces
array[WorkspaceRead]

WorkspaceUpdate - Up

Used to apply a patch-style update to a workspace, which means that null properties remain unchanged
workspaceId
UUID format: uuid
email (optional)
String format: email
initialSetupComplete (optional)
Boolean
displaySetupWizard (optional)
Boolean
anonymousDataCollection (optional)
Boolean
news (optional)
Boolean
securityUpdates (optional)
Boolean
notifications (optional)
array[Notification]
notificationSettings (optional)
NotificationSettings
defaultGeography (optional)
Geography
webhookConfigs (optional)
array[WebhookConfigWrite]

WorkspaceUpdateName - Up

workspaceId
UUID format: uuid
name
String