Airbyte Configuration API

Airbyte Configuration API https://airbyte.io.

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

Destination

DestinationDefinition

DestinationDefinitionSpecification

DestinationOauth

Health

Internal

Jobs

Logs

Notifications

Openapi

Operation

Scheduler

Source

SourceDefinition

SourceDefinitionSpecification

SourceOauth

State

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,
  "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"
    }
  }
}

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,
  "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"
    }
  }
}

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,
    "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"
      }
    }
  }, {
    "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,
    "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"
      }
    }
  } ]
}

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,
    "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"
      }
    }
  }, {
    "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,
    "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"
      }
    }
  } ]
}

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

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

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

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,
    "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,
    "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/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"
  },
  "authSpecification" : {
    "auth_type" : "oauth2.0",
    "oauth2Specification" : {
      "oauthFlowOutputParameters" : [ [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ], [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ] ],
      "rootObject" : [ "path", 1 ],
      "oauthFlowInitParameters" : [ [ "oauthFlowInitParameters", "oauthFlowInitParameters" ], [ "oauthFlowInitParameters", "oauthFlowInitParameters" ] ]
    }
  },
  "jobInfo" : {
    "createdAt" : 0,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  }
}

Produces

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

Responses

200

Successful operation DestinationDefinitionSpecificationRead

404

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

map[String, oas_any_type_not_mapped]

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

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,
    "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" : 6,
        "estimatedRecords" : 1,
        "recordsEmitted" : 4
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 6,
        "estimatedRecords" : 1,
        "recordsEmitted" : 4
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "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"
    },
    "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" : 6,
        "estimatedRecords" : 1,
        "recordsEmitted" : 4
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 6,
        "estimatedRecords" : 1,
        "recordsEmitted" : 4
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "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,
    "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" : 6,
        "estimatedRecords" : 1,
        "recordsEmitted" : 4
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    },
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    }
  }, {
    "attempt" : {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 6,
        "estimatedRecords" : 1,
        "recordsEmitted" : 4
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "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,
    "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_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,
    "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,
      "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" : 6,
        "estimatedRecords" : 1,
        "recordsEmitted" : 4
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    }, {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 6,
        "estimatedRecords" : 1,
        "recordsEmitted" : 4
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    } ]
  }, {
    "job" : {
      "createdAt" : 6,
      "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" : 6,
        "estimatedRecords" : 1,
        "recordsEmitted" : 4
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      } ],
      "id" : 5,
      "recordsSynced" : 2,
      "updatedAt" : 7
    }, {
      "totalStats" : {
        "stateMessagesEmitted" : 1,
        "recordsCommitted" : 1,
        "bytesEmitted" : 7,
        "estimatedBytes" : 6,
        "estimatedRecords" : 1,
        "recordsEmitted" : 4
      },
      "failureSummary" : {
        "failures" : [ {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        }, {
          "retryable" : true,
          "stacktrace" : "stacktrace",
          "internalMessage" : "internalMessage",
          "externalMessage" : "externalMessage",
          "timestamp" : 7
        } ],
        "partialSuccess" : true
      },
      "createdAt" : 2,
      "bytesSynced" : 3,
      "endedAt" : 9,
      "streamStats" : [ {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "streamNamespace" : "streamNamespace",
        "streamName" : "streamName"
      }, {
        "stats" : {
          "stateMessagesEmitted" : 1,
          "recordsCommitted" : 1,
          "bytesEmitted" : 7,
          "estimatedBytes" : 6,
          "estimatedRecords" : 1,
          "recordsEmitted" : 4
        },
        "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,
    "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,
    "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,
    "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/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,
    "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,
    "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,
    "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/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"
}

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"
}

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"
}

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"
  },
  "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"
  }, {
    "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"
  } ]
}

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"
    },
    "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"
    },
    "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"
  }, {
    "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"
  } ]
}

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"
  }, {
    "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"
  } ]
}

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"
}

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"
  },
  "authSpecification" : {
    "auth_type" : "oauth2.0",
    "oauth2Specification" : {
      "oauthFlowOutputParameters" : [ [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ], [ "oauthFlowOutputParameters", "oauthFlowOutputParameters" ] ],
      "rootObject" : [ "path", 1 ],
      "oauthFlowInitParameters" : [ [ "oauthFlowInitParameters", "oauthFlowInitParameters" ], [ "oauthFlowInitParameters", "oauthFlowInitParameters" ] ]
    }
  },
  "jobInfo" : {
    "createdAt" : 0,
    "connectorConfigurationUpdated" : false,
    "configId" : "configId",
    "endedAt" : 6,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "logs" : {
      "logLines" : [ "logLines", "logLines" ]
    },
    "succeeded" : true
  }
}

Produces

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

Responses

200

Successful operation SourceDefinitionSpecificationRead

404

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

map[String, oas_any_type_not_mapped]

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

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/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

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,
  "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,
  "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,
  "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"
  } ],
  "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"
  } ],
  "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"
  } ],
  "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"
  } ],
  "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"
    } ],
    "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"
    } ],
    "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"
  } ],
  "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"
  } ],
  "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. ActorDefinitionResourceRequirements -
  3. AdvancedAuth -
  4. AirbyteCatalog -
  5. AirbyteStream -
  6. AirbyteStreamAndConfiguration -
  7. AirbyteStreamConfiguration -
  8. AttemptFailureOrigin -
  9. AttemptFailureReason -
  10. AttemptFailureSummary -
  11. AttemptFailureType -
  12. AttemptInfoRead -
  13. AttemptNormalizationStatusRead -
  14. AttemptNormalizationStatusReadList -
  15. AttemptRead -
  16. AttemptStats -
  17. AttemptStatus -
  18. AttemptStreamStats -
  19. AttemptSyncConfig -
  20. AuthSpecification -
  21. CatalogDiff -
  22. CheckConnectionRead -
  23. CheckOperationRead -
  24. CompleteDestinationOAuthRequest -
  25. CompleteSourceOauthRequest -
  26. ConnectionCreate -
  27. ConnectionIdRequestBody -
  28. ConnectionRead -
  29. ConnectionReadList -
  30. ConnectionSchedule -
  31. ConnectionScheduleData -
  32. ConnectionScheduleData_basicSchedule -
  33. ConnectionScheduleData_cron -
  34. ConnectionScheduleType -
  35. ConnectionSearch -
  36. ConnectionState -
  37. ConnectionStateCreateOrUpdate -
  38. ConnectionStateType -
  39. ConnectionStatus -
  40. ConnectionUpdate -
  41. CustomDestinationDefinitionCreate -
  42. CustomSourceDefinitionCreate -
  43. DataType -
  44. DbMigrationExecutionRead -
  45. DbMigrationRead -
  46. DbMigrationReadList -
  47. DbMigrationRequestBody -
  48. DbMigrationState -
  49. DestinationCloneConfiguration -
  50. DestinationCloneRequestBody -
  51. DestinationCoreConfig -
  52. DestinationCreate -
  53. DestinationDefinitionCreate -
  54. DestinationDefinitionIdRequestBody -
  55. DestinationDefinitionIdWithWorkspaceId -
  56. DestinationDefinitionRead -
  57. DestinationDefinitionReadList -
  58. DestinationDefinitionSpecificationRead -
  59. DestinationDefinitionUpdate -
  60. DestinationIdRequestBody -
  61. DestinationOauthConsentRequest -
  62. DestinationRead -
  63. DestinationReadList -
  64. DestinationSearch -
  65. DestinationSnippetRead -
  66. DestinationSyncMode -
  67. DestinationUpdate -
  68. DiscoverCatalogResult -
  69. FieldAdd -
  70. FieldRemove -
  71. FieldSchemaUpdate -
  72. FieldTransform -
  73. Geography -
  74. GlobalState -
  75. HealthCheckRead -
  76. ImportRead -
  77. ImportRequestBody -
  78. InternalOperationResult -
  79. InvalidInputExceptionInfo -
  80. InvalidInputProperty -
  81. JobConfigType -
  82. JobDebugInfoRead -
  83. JobDebugRead -
  84. JobIdRequestBody -
  85. JobInfoLightRead -
  86. JobInfoRead -
  87. JobListRequestBody -
  88. JobOptionalRead -
  89. JobRead -
  90. JobReadList -
  91. JobStatus -
  92. JobType -
  93. JobTypeResourceLimit -
  94. JobWithAttemptsRead -
  95. KnownExceptionInfo -
  96. LogRead -
  97. LogType -
  98. LogsRequestBody -
  99. NamespaceDefinitionType -
  100. NonBreakingChangesPreference -
  101. NormalizationDestinationDefinitionConfig -
  102. NotFoundKnownExceptionInfo -
  103. Notification -
  104. NotificationRead -
  105. NotificationType -
  106. OAuth2Specification -
  107. OAuthConfigSpecification -
  108. OAuthConsentRead -
  109. OperationCreate -
  110. OperationIdRequestBody -
  111. OperationRead -
  112. OperationReadList -
  113. OperationUpdate -
  114. OperatorConfiguration -
  115. OperatorDbt -
  116. OperatorNormalization -
  117. OperatorType -
  118. OperatorWebhook -
  119. OperatorWebhook_dbtCloud -
  120. Pagination -
  121. PrivateDestinationDefinitionRead -
  122. PrivateDestinationDefinitionReadList -
  123. PrivateSourceDefinitionRead -
  124. PrivateSourceDefinitionReadList -
  125. ReleaseStage -
  126. ResetConfig -
  127. ResourceRequirements -
  128. SaveAttemptSyncConfigRequestBody -
  129. SaveStatsRequestBody -
  130. SchemaChange -
  131. SelectedFieldInfo -
  132. SetInstancewideDestinationOauthParamsRequestBody -
  133. SetInstancewideSourceOauthParamsRequestBody -
  134. SetWorkflowInAttemptRequestBody -
  135. SlackNotificationConfiguration -
  136. SlugRequestBody -
  137. SourceCloneConfiguration -
  138. SourceCloneRequestBody -
  139. SourceCoreConfig -
  140. SourceCreate -
  141. SourceDefinitionCreate -
  142. SourceDefinitionIdRequestBody -
  143. SourceDefinitionIdWithWorkspaceId -
  144. SourceDefinitionRead -
  145. SourceDefinitionReadList -
  146. SourceDefinitionSpecificationRead -
  147. SourceDefinitionUpdate -
  148. SourceDiscoverSchemaRead -
  149. SourceDiscoverSchemaRequestBody -
  150. SourceDiscoverSchemaWriteRequestBody -
  151. SourceIdRequestBody -
  152. SourceOauthConsentRequest -
  153. SourceRead -
  154. SourceReadList -
  155. SourceSearch -
  156. SourceSnippetRead -
  157. SourceUpdate -
  158. StreamDescriptor -
  159. StreamState -
  160. StreamTransform -
  161. SyncMode -
  162. SynchronousJobRead -
  163. UploadRead -
  164. WebBackendCheckUpdatesRead -
  165. WebBackendConnectionCreate -
  166. WebBackendConnectionListItem -
  167. WebBackendConnectionListRequestBody -
  168. WebBackendConnectionRead -
  169. WebBackendConnectionReadList -
  170. WebBackendConnectionRequestBody -
  171. WebBackendConnectionUpdate -
  172. WebBackendGeographiesListResult -
  173. WebBackendOperationCreateOrUpdate -
  174. WebBackendWorkspaceState -
  175. WebBackendWorkspaceStateResult -
  176. WebhookConfigRead -
  177. WebhookConfigWrite -
  178. WorkflowStateRead -
  179. WorkspaceCreate -
  180. WorkspaceGiveFeedback -
  181. WorkspaceIdRequestBody -
  182. WorkspaceRead -
  183. WorkspaceReadList -
  184. WorkspaceUpdate -
  185. WorkspaceUpdateName -

ActorCatalogWithUpdatedAt - Up

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

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)
jobSpecific (optional)

AdvancedAuth - Up

authFlowType (optional)
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)

AirbyteCatalog - Up

describes the available schema (catalog).
streams

AirbyteStream - Up

the immutable schema defined by the source
name
String Stream's name.
jsonSchema (optional)
supportedSyncModes (optional)
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)
config (optional)

AirbyteStreamConfiguration - Up

the mutable part of the stream to configure the destination
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
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.

AttemptFailureOrigin - Up

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

AttemptFailureReason - Up

failureOrigin (optional)
failureType (optional)
externalMessage (optional)
internalMessage (optional)
stacktrace (optional)
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

AttemptFailureSummary - Up

failures
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.

AttemptFailureType - Up

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

AttemptInfoRead - Up

attempt
logs

AttemptNormalizationStatusRead - Up

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

AttemptNormalizationStatusReadList - Up

attemptNormalizationStatuses (optional)

AttemptRead - Up

id
Long format: int64
status
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)
streamStats (optional)
failureSummary (optional)

AttemptStats - Up

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

AttemptStatus - Up

AttemptStreamStats - Up

streamName
streamNamespace (optional)
stats

AttemptSyncConfig - Up

sourceConfiguration
destinationConfiguration
state (optional)

AuthSpecification - Up

auth_type (optional)
Enum:
oauth2.0
oauth2Specification (optional)

CatalogDiff - Up

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

CheckConnectionRead - Up

status
Enum:
succeeded
failed
message (optional)
jobInfo

CheckOperationRead - Up

status
Enum:
succeeded
failed
message (optional)

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)
destinationId (optional)
UUID format: uuid

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)
sourceId (optional)
UUID format: uuid

ConnectionCreate - Up

name (optional)
String Optional name of the connection
namespaceDefinition (optional)
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)
schedule (optional)
scheduleType (optional)
scheduleData (optional)
status
resourceRequirements (optional)
sourceCatalogId (optional)
UUID format: uuid
geography (optional)
notifySchemaChanges (optional)
nonBreakingChangesPreference (optional)

ConnectionIdRequestBody - Up

connectionId
UUID format: uuid

ConnectionRead - Up

connectionId
UUID format: uuid
name
namespaceDefinition (optional)
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
schedule (optional)
scheduleType (optional)
scheduleData (optional)
status
resourceRequirements (optional)
sourceCatalogId (optional)
UUID format: uuid
geography (optional)
breakingChange
notifySchemaChanges (optional)
nonBreakingChangesPreference (optional)

ConnectionReadList - Up

connections

ConnectionSchedule - Up

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

ConnectionScheduleData - Up

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

ConnectionScheduleData_basicSchedule - Up

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

ConnectionScheduleData_cron - Up

cronExpression
cronTimeZone

ConnectionScheduleType - Up

determine how the schedule data should be interpreted

ConnectionSearch - Up

connectionId (optional)
UUID format: uuid
name (optional)
namespaceDefinition (optional)
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)
scheduleType (optional)
scheduleData (optional)
status (optional)
source (optional)
destination (optional)

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
connectionId
UUID format: uuid
state (optional)
streamState (optional)
globalState (optional)

ConnectionStateCreateOrUpdate - Up

connectionId
UUID format: uuid
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.

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)
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)
schedule (optional)
scheduleType (optional)
scheduleData (optional)
status (optional)
resourceRequirements (optional)
sourceCatalogId (optional)
UUID format: uuid
geography (optional)
notifySchemaChanges (optional)
nonBreakingChangesPreference (optional)
breakingChange (optional)

CustomDestinationDefinitionCreate - Up

workspaceId
UUID format: uuid
destinationDefinition

CustomSourceDefinitionCreate - Up

workspaceId
UUID format: uuid
sourceDefinition

DataType - Up

DbMigrationExecutionRead - Up

initialVersion (optional)
targetVersion (optional)
executedMigrations (optional)

DbMigrationRead - Up

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

DbMigrationReadList - Up

migrations (optional)

DbMigrationRequestBody - Up

database

DbMigrationState - Up

DestinationCloneConfiguration - Up

connectionConfiguration (optional)
name (optional)

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)

DestinationCoreConfig - Up

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

DestinationCreate - Up

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

DestinationDefinitionCreate - Up

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

DestinationDefinitionIdRequestBody - Up

destinationDefinitionId
UUID format: uuid

DestinationDefinitionIdWithWorkspaceId - Up

destinationDefinitionId
UUID format: uuid
workspaceId
UUID format: uuid

DestinationDefinitionRead - Up

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

DestinationDefinitionReadList - Up

destinationDefinitions

DestinationDefinitionSpecificationRead - Up

destinationDefinitionId
UUID format: uuid
documentationUrl (optional)
connectionSpecification (optional)
authSpecification (optional)
advancedAuth (optional)
jobInfo
supportedDestinationSyncModes (optional)

DestinationDefinitionUpdate - Up

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

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)
destinationId (optional)
UUID format: uuid

DestinationRead - Up

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

DestinationReadList - Up

destinations

DestinationSearch - Up

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

DestinationSnippetRead - Up

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

DestinationSyncMode - Up

DestinationUpdate - Up

destinationId
UUID format: uuid
connectionConfiguration
name

DiscoverCatalogResult - Up

catalogId
UUID format: uuid

FieldAdd - Up

schema (optional)

FieldRemove - Up

schema (optional)

FieldSchemaUpdate - Up

oldSchema
newSchema

FieldTransform - Up

Describes the difference between two Streams.
transformType
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
addField (optional)
removeField (optional)
updateFieldSchema (optional)

Geography - Up

GlobalState - Up

shared_state (optional)
streamStates

HealthCheckRead - Up

available

ImportRead - Up

status
Enum:
succeeded
failed
reason (optional)

ImportRequestBody - Up

resourceId
UUID format: uuid
workspaceId
UUID format: uuid

InternalOperationResult - Up

succeeded

InvalidInputExceptionInfo - Up

message
exceptionClassName (optional)
exceptionStack (optional)
validationErrors

InvalidInputProperty - Up

propertyPath
invalidValue (optional)
message (optional)

JobConfigType - Up

JobDebugInfoRead - Up

job
attempts
workflowState (optional)

JobDebugRead - Up

id
Long format: int64
configType
configId
status
airbyteVersion
sourceDefinition
destinationDefinition

JobIdRequestBody - Up

id
Long format: int64

JobInfoLightRead - Up

job

JobInfoRead - Up

job
attempts

JobListRequestBody - Up

configTypes
configId
includingJobId (optional)
Long format: int64
pagination (optional)

JobOptionalRead - Up

job (optional)

JobRead - Up

id
Long format: int64
configType
configId
createdAt
Long format: int64
updatedAt
Long format: int64
startedAt (optional)
Long format: int64
status
resetConfig (optional)

JobReadList - Up

jobs
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
resourceRequirements

JobWithAttemptsRead - Up

job (optional)
attempts (optional)

KnownExceptionInfo - Up

message
exceptionClassName (optional)
exceptionStack (optional)
rootCauseExceptionClassName (optional)
rootCauseExceptionStack (optional)

LogRead - Up

logLines

LogType - Up

type/source of logs produced

LogsRequestBody - Up

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)
message
exceptionClassName (optional)
exceptionStack (optional)
rootCauseExceptionClassName (optional)
rootCauseExceptionStack (optional)

Notification - Up

notificationType
sendOnSuccess
sendOnFailure
slackConfiguration (optional)
customerioConfiguration (optional)

NotificationRead - Up

status
Enum:
succeeded
failed
message (optional)

NotificationType - Up

OAuth2Specification - Up

An object containing any metadata needed to describe this connector's Oauth flow
rootObject
array[oas_any_type_not_mapped] A list of strings representing a pointer to the root object which contains any oauth parameters in the ConnectorSpecification. Examples: if oauth parameters were contained inside the top level, rootObject=[] If they were nested inside another object {'credentials': {'app_id' etc...}, rootObject=['credentials'] If they were inside a oneOf {'switch': {oneOf: [{client_id...}, {non_oauth_param]}}, rootObject=['switch', 0]
oauthFlowInitParameters
array[array[String]] Pointers to the fields in the rootObject needed to obtain the initial refresh/access tokens for the OAuth flow. Each inner array represents the path in the rootObject of the referenced field. For example. Assume the rootObject contains params 'app_secret', 'app_id' which are needed to get the initial refresh token. If they are not nested in the rootObject, then the array would look like this [['app_secret'], ['app_id']] If they are nested inside an object called 'auth_params' then this array would be [['auth_params', 'app_secret'], ['auth_params', 'app_id']]
oauthFlowOutputParameters
array[array[String]] Pointers to the fields in the rootObject which can be populated from successfully completing the oauth flow using the init parameters. This is typically a refresh/access token. Each inner array represents the path in the rootObject of the referenced field.

OAuthConfigSpecification - Up

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

OAuthConsentRead - Up

consentUrl

OperationCreate - Up

workspaceId
UUID format: uuid
name
operatorConfiguration

OperationIdRequestBody - Up

operationId
UUID format: uuid

OperationRead - Up

workspaceId
UUID format: uuid
operationId
UUID format: uuid
name
operatorConfiguration

OperationReadList - Up

operations

OperationUpdate - Up

operationId
UUID format: uuid
name
operatorConfiguration

OperatorConfiguration - Up

operatorType
normalization (optional)
dbt (optional)
webhook (optional)

OperatorDbt - Up

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

OperatorNormalization - Up

option (optional)
Enum:
basic

OperatorType - Up

OperatorWebhook - Up

webhookConfigId (optional)
UUID The id of the webhook configs to use from the workspace. format: uuid
webhookType (optional)
Enum:
dbtCloud
dbtCloud (optional)
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)
rowOffset (optional)

PrivateDestinationDefinitionRead - Up

destinationDefinition
granted

PrivateDestinationDefinitionReadList - Up

destinationDefinitions

PrivateSourceDefinitionRead - Up

sourceDefinition
granted

PrivateSourceDefinitionReadList - Up

sourceDefinitions

ReleaseStage - Up

ResetConfig - Up

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

ResourceRequirements - Up

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

SaveAttemptSyncConfigRequestBody - Up

jobId
Long format: int64
attemptNumber
Integer format: int32
syncConfig

SaveStatsRequestBody - Up

jobId
Long format: int64
attemptNumber
Integer format: int32
stats
streamStats (optional)

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)

SetInstancewideDestinationOauthParamsRequestBody - Up

destinationDefinitionId
UUID format: uuid
params

SetInstancewideSourceOauthParamsRequestBody - Up

sourceDefinitionId
UUID format: uuid
params

SetWorkflowInAttemptRequestBody - Up

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

SlackNotificationConfiguration - Up

webhook

SlugRequestBody - Up

slug

SourceCloneConfiguration - Up

connectionConfiguration (optional)
name (optional)

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)

SourceCoreConfig - Up

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

SourceCreate - Up

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

SourceDefinitionCreate - Up

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

SourceDefinitionIdRequestBody - Up

sourceDefinitionId
UUID format: uuid

SourceDefinitionIdWithWorkspaceId - Up

sourceDefinitionId
UUID format: uuid
workspaceId
UUID format: uuid

SourceDefinitionRead - Up

sourceDefinitionId
UUID format: uuid
name
dockerRepository
dockerImageTag
documentationUrl (optional)
URI format: uri
icon (optional)
protocolVersion (optional)
String The Airbyte Protocol version supported by the connector
releaseStage (optional)
releaseDate (optional)
date The date when this connector was first released, in yyyy-mm-dd format. format: date
sourceType (optional)
Enum:
api
file
database
custom
resourceRequirements (optional)

SourceDefinitionReadList - Up

sourceDefinitions

SourceDefinitionSpecificationRead - Up

sourceDefinitionId
UUID format: uuid
documentationUrl (optional)
connectionSpecification (optional)
authSpecification (optional)
advancedAuth (optional)
jobInfo

SourceDefinitionUpdate - Up

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

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

SourceDiscoverSchemaRequestBody - Up

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

SourceDiscoverSchemaWriteRequestBody - Up

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

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)
sourceId (optional)
UUID format: uuid

SourceRead - Up

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

SourceReadList - Up

sources

SourceSearch - Up

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

SourceSnippetRead - Up

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

SourceUpdate - Up

sourceId
UUID format: uuid
connectionConfiguration
name

StreamDescriptor - Up

name
namespace (optional)

StreamState - Up

streamDescriptor
streamState (optional)

StreamTransform - Up

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

SyncMode - Up

SynchronousJobRead - Up

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

UploadRead - Up

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

WebBackendCheckUpdatesRead - Up

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

WebBackendConnectionCreate - Up

name (optional)
String Optional name of the connection
namespaceDefinition (optional)
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)
schedule (optional)
scheduleType (optional)
scheduleData (optional)
status
resourceRequirements (optional)
operations (optional)
sourceCatalogId (optional)
UUID format: uuid
geography (optional)
nonBreakingChangesPreference (optional)

WebBackendConnectionListItem - Up

Information about a connection that shows up in the connection list view.
connectionId
UUID format: uuid
name
scheduleType (optional)
scheduleData (optional)
status
source
destination
latestSyncJobCreatedAt (optional)
Long epoch time of the latest sync job. null if no sync job has taken place. format: int64
latestSyncJobStatus (optional)
isSyncing
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
namespaceDefinition (optional)
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
schedule (optional)
scheduleType (optional)
scheduleData (optional)
status
operationIds (optional)
array[UUID] format: uuid
source
destination
operations (optional)
latestSyncJobCreatedAt (optional)
Long epoch time of the latest sync job. null if no sync job has taken place. format: int64
latestSyncJobStatus (optional)
isSyncing
resourceRequirements (optional)
catalogId (optional)
UUID format: uuid
catalogDiff (optional)
geography (optional)
schemaChange
notifySchemaChanges
nonBreakingChangesPreference

WebBackendConnectionReadList - Up

connections

WebBackendConnectionRequestBody - Up

withRefreshedCatalog (optional)
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)
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)
schedule (optional)
scheduleType (optional)
scheduleData (optional)
status (optional)
resourceRequirements (optional)
skipReset (optional)
operations (optional)
sourceCatalogId (optional)
UUID format: uuid
geography (optional)
notifySchemaChanges (optional)
nonBreakingChangesPreference (optional)

WebBackendGeographiesListResult - Up

geographies

WebBackendOperationCreateOrUpdate - Up

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

WebBackendWorkspaceState - Up

workspaceId
UUID format: uuid

WebBackendWorkspaceStateResult - Up

hasConnections
hasSources
hasDestinations

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

WorkspaceCreate - Up

email (optional)
String format: email
anonymousDataCollection (optional)
name
news (optional)
securityUpdates (optional)
notifications (optional)
displaySetupWizard (optional)
defaultGeography (optional)
webhookConfigs (optional)

WorkspaceGiveFeedback - Up

workspaceId
UUID format: uuid

WorkspaceIdRequestBody - Up

workspaceId
UUID format: uuid

WorkspaceRead - Up

workspaceId
UUID format: uuid
customerId
UUID format: uuid
email (optional)
String format: email
name
slug
initialSetupComplete
displaySetupWizard (optional)
anonymousDataCollection (optional)
news (optional)
securityUpdates (optional)
notifications (optional)
firstCompletedSync (optional)
feedbackDone (optional)
defaultGeography (optional)
webhookConfigs (optional)

WorkspaceReadList - Up

workspaces

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)
displaySetupWizard (optional)
anonymousDataCollection (optional)
news (optional)
securityUpdates (optional)
notifications (optional)
defaultGeography (optional)
webhookConfigs (optional)

WorkspaceUpdateName - Up

workspaceId
UUID format: uuid
name