Airbyte Configuration API

Airbyte Configuration API https://airbyte.io.

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

Here are some conventions that this API follows:

Change Management:

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

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Connection

Debugging

Destination

DestinationDefinition

DestinationDefinitionSpecification

Health

Jobs

Source

SourceDefinition

SourceDefinitionSpecification

WebBackend

Workspace

Connection

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

Consumes

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

Request body

ConnectionCreate ConnectionCreate (required)
Body Parameter —

Return type

ConnectionRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "name" : "name",
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "syncSchema" : {
    "streams" : [ {
      "supportedSyncModes" : [ null, null ],
      "sourceDefinedCursor" : true,
      "name" : "name",
      "cleanedName" : "cleanedName",
      "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
      "fields" : [ {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      }, {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      } ],
      "selected" : true,
      "cursorField" : [ "cursorField", "cursorField" ]
    }, {
      "supportedSyncModes" : [ null, null ],
      "sourceDefinedCursor" : true,
      "name" : "name",
      "cleanedName" : "cleanedName",
      "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
      "fields" : [ {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      }, {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      } ],
      "selected" : true,
      "cursorField" : [ "cursorField", "cursorField" ]
    } ]
  },
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

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

Responses

200

Successful operation ConnectionRead

422

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

Consumes

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

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Responses

204

The resource was deleted successfully.

404

Connection not found

422

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

Consumes

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

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

ConnectionRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "name" : "name",
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "syncSchema" : {
    "streams" : [ {
      "supportedSyncModes" : [ null, null ],
      "sourceDefinedCursor" : true,
      "name" : "name",
      "cleanedName" : "cleanedName",
      "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
      "fields" : [ {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      }, {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      } ],
      "selected" : true,
      "cursorField" : [ "cursorField", "cursorField" ]
    }, {
      "supportedSyncModes" : [ null, null ],
      "sourceDefinedCursor" : true,
      "name" : "name",
      "cleanedName" : "cleanedName",
      "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
      "fields" : [ {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      }, {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      } ],
      "selected" : true,
      "cursorField" : [ "cursorField", "cursorField" ]
    } ]
  },
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

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

Responses

200

Successful operation ConnectionRead

404

Connection not found

422

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

Consumes

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

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Return type

ConnectionReadList

Example data

Content-Type: application/json
{
  "connections" : [ {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "name" : "name",
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "syncSchema" : {
      "streams" : [ {
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "cleanedName" : "cleanedName",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
        "fields" : [ {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        }, {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        } ],
        "selected" : true,
        "cursorField" : [ "cursorField", "cursorField" ]
      }, {
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "cleanedName" : "cleanedName",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
        "fields" : [ {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        }, {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        } ],
        "selected" : true,
        "cursorField" : [ "cursorField", "cursorField" ]
      } ]
    },
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "name" : "name",
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "syncSchema" : {
      "streams" : [ {
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "cleanedName" : "cleanedName",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
        "fields" : [ {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        }, {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        } ],
        "selected" : true,
        "cursorField" : [ "cursorField", "cursorField" ]
      }, {
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "cleanedName" : "cleanedName",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
        "fields" : [ {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        }, {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        } ],
        "selected" : true,
        "cursorField" : [ "cursorField", "cursorField" ]
      } ]
    },
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

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

Responses

200

Successful operation ConnectionReadList

404

Workspace not found

422

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

Consumes

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

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

JobInfoRead

Example data

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

Produces

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

Responses

200

Successful operation JobInfoRead

404

Connection not found

422

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

Consumes

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

Request body

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

JobInfoRead

Example data

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

Produces

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

Responses

200

Successful operation JobInfoRead

404

Connection not found

422

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

Consumes

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

Request body

ConnectionUpdate ConnectionUpdate (required)
Body Parameter —

Return type

ConnectionRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "name" : "name",
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "syncSchema" : {
    "streams" : [ {
      "supportedSyncModes" : [ null, null ],
      "sourceDefinedCursor" : true,
      "name" : "name",
      "cleanedName" : "cleanedName",
      "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
      "fields" : [ {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      }, {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      } ],
      "selected" : true,
      "cursorField" : [ "cursorField", "cursorField" ]
    }, {
      "supportedSyncModes" : [ null, null ],
      "sourceDefinedCursor" : true,
      "name" : "name",
      "cleanedName" : "cleanedName",
      "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
      "fields" : [ {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      }, {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      } ],
      "selected" : true,
      "cursorField" : [ "cursorField", "cursorField" ]
    } ]
  },
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

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

Responses

200

Successful operation ConnectionRead

422

Invalid Input

Debugging

Up 
get /v1/debug
Get miscellaneous information for debugging (getDebuggingInfo)

Return type

DebugRead

Example data

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

Produces

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

Responses

200

Successful operation DebugRead

404

Debug info not found

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",
  "status" : "succeeded"
}

Produces

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

Responses

200

Successful operation CheckConnectionRead

404

Destination not found

422

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

Consumes

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

Request body

DestinationCreate DestinationCreate (required)
Body Parameter —

Return type

DestinationRead

Example data

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

Produces

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

Responses

200

Successful operation DestinationRead

422

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

Consumes

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

Request body

DestinationIdRequestBody DestinationIdRequestBody (required)
Body Parameter —

Responses

204

The resource was deleted successfully.

404

Destination not found

422

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

Consumes

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

Request body

DestinationIdRequestBody DestinationIdRequestBody (required)
Body Parameter —

Return type

DestinationRead

Example data

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

Produces

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

Responses

200

Successful operation DestinationRead

404

Destination not found

422

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

Consumes

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

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Return type

DestinationReadList

Example data

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

Produces

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

Responses

200

Successful operation DestinationReadList

404

Workspace not found

422

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

Consumes

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

Request body

DestinationUpdate DestinationUpdate (required)
Body Parameter —

Return type

DestinationRead

Example data

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

Produces

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

Responses

200

Successful operation DestinationRead

422

Invalid Input

DestinationDefinition

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

Consumes

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

Request body

DestinationDefinitionCreate DestinationDefinitionCreate (optional)
Body Parameter —

Return type

DestinationDefinitionRead

Example data

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

Produces

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

Responses

200

Successful operation DestinationDefinitionRead

422

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

Consumes

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

Request body

DestinationDefinitionIdRequestBody DestinationDefinitionIdRequestBody (required)
Body Parameter —

Return type

DestinationDefinitionRead

Example data

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

Produces

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

Responses

200

Successful operation DestinationDefinitionRead

404

DestinationDefinition not found

422

Invalid Input
Up 
post /v1/destination_definitions/list
List all of the destinationDefinitions that Airbyte supports (listDestinationDefinitions)

Return type

DestinationDefinitionReadList

Example data

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

Produces

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

Responses

200

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

Consumes

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

Request body

DestinationDefinitionUpdate DestinationDefinitionUpdate (required)
Body Parameter —

Return type

DestinationDefinitionRead

Example data

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

Produces

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

Responses

200

Successful operation DestinationDefinitionRead

404

DestinationDefinition not found

422

Invalid Input

DestinationDefinitionSpecification

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

Consumes

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

Request body

DestinationDefinitionIdRequestBody DestinationDefinitionIdRequestBody (required)
Body Parameter —

Return type

DestinationDefinitionSpecificationRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "documentationUrl",
  "connectionSpecification" : {
    "user" : {
      "type" : "string"
    }
  },
  "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 DestinationDefinitionSpecificationRead

404

DestinationDefinition not found

422

Invalid Input

Health

Up 
get /v1/health
Health Check (getHealthCheck)

Return type

HealthCheckRead

Example data

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

Produces

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

Responses

200

Successful operation HealthCheckRead

404

Debug info not found

Jobs

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

Consumes

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

Request body

JobIdRequestBody JobIdRequestBody (required)
Body Parameter —

Return type

JobInfoRead

Example data

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

Produces

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

Responses

200

Successful operation JobInfoRead

404

Job not found

422

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

Consumes

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

Request body

JobListRequestBody JobListRequestBody (required)
Body Parameter —

Return type

JobReadList

Example data

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

Produces

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

Responses

200

Successful operation JobReadList

404

Connection not found

422

Invalid Input

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",
  "status" : "succeeded"
}

Produces

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

Responses

200

Successful operation CheckConnectionRead

404

Source not found

422

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

Consumes

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

Request body

SourceCreate SourceCreate (required)
Body Parameter —

Return type

SourceRead

Example data

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

Produces

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

Responses

200

Successful operation SourceRead

422

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

Consumes

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

Request body

SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter —

Responses

204

The resource was deleted successfully.

404

Source not found

422

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

Consumes

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

Request body

SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter —

Return type

SourceDiscoverSchemaRead

Example data

Content-Type: application/json
{
  "schema" : {
    "streams" : [ {
      "supportedSyncModes" : [ null, null ],
      "sourceDefinedCursor" : true,
      "name" : "name",
      "cleanedName" : "cleanedName",
      "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
      "fields" : [ {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      }, {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      } ],
      "selected" : true,
      "cursorField" : [ "cursorField", "cursorField" ]
    }, {
      "supportedSyncModes" : [ null, null ],
      "sourceDefinedCursor" : true,
      "name" : "name",
      "cleanedName" : "cleanedName",
      "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
      "fields" : [ {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      }, {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      } ],
      "selected" : true,
      "cursorField" : [ "cursorField", "cursorField" ]
    } ]
  }
}

Produces

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

Responses

200

Successful operation SourceDiscoverSchemaRead

404

Source not found

422

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

Consumes

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

Request body

SourceIdRequestBody SourceIdRequestBody (required)
Body Parameter —

Return type

SourceRead

Example data

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

Produces

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

Responses

200

Successful operation SourceRead

404

Source not found

422

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

Consumes

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

Request body

SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
Body Parameter —

Return type

SourceDefinitionRead

Example data

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

Produces

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

Responses

200

Successful operation SourceDefinitionRead

404

SourceDefinition not found

422

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

Consumes

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

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Return type

SourceReadList

Example data

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

Produces

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

Responses

200

Successful operation SourceReadList

404

Workspace not found

422

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

Consumes

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

Request body

SourceUpdate SourceUpdate (required)
Body Parameter —

Return type

SourceRead

Example data

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

Produces

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

Responses

200

Successful operation SourceRead

404

Source not found

422

Invalid Input

SourceDefinition

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

Consumes

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

Request body

SourceDefinitionCreate SourceDefinitionCreate (optional)
Body Parameter —

Return type

SourceDefinitionRead

Example data

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

Produces

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

Responses

200

Successful operation SourceDefinitionRead

422

Invalid Input
Up 
post /v1/source_definitions/list
List all of the sourceDefinitions that Airbyte supports (listSourceDefinitions)

Return type

SourceDefinitionReadList

Example data

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

Produces

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

Responses

200

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

Consumes

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

Request body

SourceDefinitionUpdate SourceDefinitionUpdate (optional)
Body Parameter —

Return type

SourceDefinitionRead

Example data

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

Produces

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

Responses

200

Successful operation SourceDefinitionRead

404

SourceDefinition not found

422

Invalid Input

SourceDefinitionSpecification

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

Consumes

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

Request body

SourceDefinitionIdRequestBody SourceDefinitionIdRequestBody (required)
Body Parameter —

Return type

SourceDefinitionSpecificationRead

Example data

Content-Type: application/json
{
  "documentationUrl" : "documentationUrl",
  "connectionSpecification" : {
    "user" : {
      "type" : "string"
    }
  },
  "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

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

Responses

200

Successful operation SourceDefinitionSpecificationRead

404

SourceDefinition not found

422

Invalid Input

WebBackend

Up 
post /v1/web_backend/destinations/create
Create a destination (webBackendCreateDestination)

Consumes

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

Request body

DestinationCreate DestinationCreate (required)
Body Parameter —

Return type

DestinationRead

Example data

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

Produces

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

Responses

200

Successful operation DestinationRead

422

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

Consumes

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

Request body

SourceCreate SourceCreate (required)
Body Parameter —

Return type

SourceRead

Example data

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

Produces

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

Responses

200

Successful operation SourceRead

422

Invalid Input
Up 
post /v1/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

ConnectionIdRequestBody ConnectionIdRequestBody (required)
Body Parameter —

Return type

WbConnectionRead

Example data

Content-Type: application/json
{
  "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "schedule" : {
    "units" : 0,
    "timeUnit" : "minutes"
  },
  "lastSync" : 0,
  "name" : "name",
  "destination" : {
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "destinationName" : "destinationName",
    "name" : "name",
    "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "isSyncing" : true,
  "syncSchema" : {
    "streams" : [ {
      "supportedSyncModes" : [ null, null ],
      "sourceDefinedCursor" : true,
      "name" : "name",
      "cleanedName" : "cleanedName",
      "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
      "fields" : [ {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      }, {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      } ],
      "selected" : true,
      "cursorField" : [ "cursorField", "cursorField" ]
    }, {
      "supportedSyncModes" : [ null, null ],
      "sourceDefinedCursor" : true,
      "name" : "name",
      "cleanedName" : "cleanedName",
      "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
      "fields" : [ {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      }, {
        "name" : "name",
        "cleanedName" : "cleanedName",
        "selected" : true
      } ],
      "selected" : true,
      "cursorField" : [ "cursorField", "cursorField" ]
    } ]
  },
  "source" : {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "connectionConfiguration" : {
      "user" : "charles"
    },
    "name" : "name",
    "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceName" : "sourceName",
    "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

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

Responses

200

Successful operation WbConnectionRead

404

Connection not found

422

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

Consumes

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

Request body

WorkspaceIdRequestBody WorkspaceIdRequestBody (required)
Body Parameter —

Return type

WbConnectionReadList

Example data

Content-Type: application/json
{
  "connections" : [ {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "lastSync" : 0,
    "name" : "name",
    "destination" : {
      "connectionConfiguration" : {
        "user" : "charles"
      },
      "destinationName" : "destinationName",
      "name" : "name",
      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isSyncing" : true,
    "syncSchema" : {
      "streams" : [ {
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "cleanedName" : "cleanedName",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
        "fields" : [ {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        }, {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        } ],
        "selected" : true,
        "cursorField" : [ "cursorField", "cursorField" ]
      }, {
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "cleanedName" : "cleanedName",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
        "fields" : [ {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        }, {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        } ],
        "selected" : true,
        "cursorField" : [ "cursorField", "cursorField" ]
      } ]
    },
    "source" : {
      "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "connectionConfiguration" : {
        "user" : "charles"
      },
      "name" : "name",
      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "sourceName" : "sourceName",
      "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "schedule" : {
      "units" : 0,
      "timeUnit" : "minutes"
    },
    "lastSync" : 0,
    "name" : "name",
    "destination" : {
      "connectionConfiguration" : {
        "user" : "charles"
      },
      "destinationName" : "destinationName",
      "name" : "name",
      "destinationDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "isSyncing" : true,
    "syncSchema" : {
      "streams" : [ {
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "cleanedName" : "cleanedName",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
        "fields" : [ {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        }, {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        } ],
        "selected" : true,
        "cursorField" : [ "cursorField", "cursorField" ]
      }, {
        "supportedSyncModes" : [ null, null ],
        "sourceDefinedCursor" : true,
        "name" : "name",
        "cleanedName" : "cleanedName",
        "defaultCursorField" : [ "defaultCursorField", "defaultCursorField" ],
        "fields" : [ {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        }, {
          "name" : "name",
          "cleanedName" : "cleanedName",
          "selected" : true
        } ],
        "selected" : true,
        "cursorField" : [ "cursorField", "cursorField" ]
      } ]
    },
    "source" : {
      "sourceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "connectionConfiguration" : {
        "user" : "charles"
      },
      "name" : "name",
      "sourceDefinitionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "sourceName" : "sourceName",
      "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "destinationId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}

Produces

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

Responses

200

Successful operation WbConnectionReadList

404

Workspace not found

422

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

Consumes

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

Request body

DestinationRecreate DestinationRecreate (required)
Body Parameter —

Return type

DestinationRead

Example data

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

Produces

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

Responses

200

Successful operation DestinationRead

422

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

Consumes

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

Request body

SourceRecreate SourceRecreate (required)
Body Parameter —

Return type

SourceRead

Example data

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

Produces

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

Responses

200

Successful operation SourceRead

422

Invalid Input

Workspace

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
{
  "initialSetupComplete" : true,
  "onboardingComplete" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "slug" : "slug",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

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

Responses

200

Successful operation WorkspaceRead

404

Workspace not found

422

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

Consumes

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

Request body

SlugRequestBody SlugRequestBody (required)
Body Parameter —

Return type

WorkspaceRead

Example data

Content-Type: application/json
{
  "initialSetupComplete" : true,
  "onboardingComplete" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "slug" : "slug",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

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

Responses

200

Successful operation WorkspaceRead

404

Workspace not found

422

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

Consumes

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

Request body

WorkspaceUpdate WorkspaceUpdate (required)
Body Parameter —

Return type

WorkspaceRead

Example data

Content-Type: application/json
{
  "initialSetupComplete" : true,
  "onboardingComplete" : true,
  "customerId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "name" : "name",
  "slug" : "slug",
  "workspaceId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

Produces

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

Responses

200

Successful operation WorkspaceRead

404

Workspace not found

422

Invalid Input

Models

[ Jump to Methods ]

Table of Contents

  1. AttemptInfoRead -
  2. AttemptRead -
  3. AttemptStatus -
  4. CheckConnectionRead -
  5. ConnectionCreate -
  6. ConnectionIdRequestBody -
  7. ConnectionRead -
  8. ConnectionReadList -
  9. ConnectionSchedule -
  10. ConnectionStatus -
  11. ConnectionUpdate -
  12. DataType -
  13. DebugRead -
  14. DestinationCreate -
  15. DestinationDefinitionCreate -
  16. DestinationDefinitionIdRequestBody -
  17. DestinationDefinitionRead -
  18. DestinationDefinitionReadList -
  19. DestinationDefinitionSpecificationRead -
  20. DestinationDefinitionUpdate -
  21. DestinationIdRequestBody -
  22. DestinationRead -
  23. DestinationReadList -
  24. DestinationRecreate -
  25. DestinationUpdate -
  26. HealthCheckRead -
  27. JobConfigType -
  28. JobIdRequestBody -
  29. JobInfoRead -
  30. JobListRequestBody -
  31. JobRead -
  32. JobReadList -
  33. JobStatus -
  34. JobWithAttemptsRead -
  35. LogRead -
  36. SlugRequestBody -
  37. SourceCreate -
  38. SourceDefinitionCreate -
  39. SourceDefinitionIdRequestBody -
  40. SourceDefinitionRead -
  41. SourceDefinitionReadList -
  42. SourceDefinitionSpecificationRead -
  43. SourceDefinitionUpdate -
  44. SourceDiscoverSchemaRead -
  45. SourceIdRequestBody -
  46. SourceRead -
  47. SourceReadList -
  48. SourceRecreate -
  49. SourceSchema -
  50. SourceSchemaField -
  51. SourceSchemaStream -
  52. SourceUpdate -
  53. SyncMode -
  54. WbConnectionRead -
  55. WbConnectionReadList -
  56. WorkspaceIdRequestBody -
  57. WorkspaceRead -
  58. WorkspaceUpdate -

AttemptInfoRead - Up

attempt
AttemptRead
logs
LogRead

AttemptRead - Up

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

AttemptStatus - Up

CheckConnectionRead - Up

status
String
Enum:
succeeded
failed
message (optional)
String

ConnectionCreate - Up

name (optional)
String Optional name of the connection
sourceId
UUID format: uuid
destinationId
UUID format: uuid
syncMode
SyncMode
syncSchema (optional)
SourceSchema
schedule (optional)
ConnectionSchedule
status
ConnectionStatus

ConnectionIdRequestBody - Up

connectionId
UUID format: uuid

ConnectionRead - Up

connectionId
UUID format: uuid
name
String
sourceId
UUID format: uuid
destinationId
UUID format: uuid
syncMode
SyncMode
syncSchema
SourceSchema
schedule (optional)
ConnectionSchedule
status
ConnectionStatus

ConnectionReadList - Up

connections
array[ConnectionRead]

ConnectionSchedule - Up

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

ConnectionStatus - Up

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

ConnectionUpdate - Up

connectionId
UUID format: uuid
syncSchema
SourceSchema
schedule (optional)
ConnectionSchedule
status
ConnectionStatus

DataType - Up

DebugRead - Up

info
Object

DestinationCreate - Up

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

DestinationDefinitionCreate - Up

name
String
dockerRepository
String
dockerImageTag
String
documentationUrl
URI format: uri

DestinationDefinitionIdRequestBody - Up

destinationDefinitionId
UUID format: uuid

DestinationDefinitionRead - Up

destinationDefinitionId
UUID format: uuid
name
String
dockerRepository
String
dockerImageTag
String
documentationUrl
URI format: uri

DestinationDefinitionReadList - Up

destinationDefinitions
array[DestinationDefinitionRead]

DestinationDefinitionSpecificationRead - Up

destinationDefinitionId
UUID format: uuid
documentationUrl (optional)
String
connectionSpecification
DestinationDefinitionSpecification

DestinationDefinitionUpdate - Up

destinationDefinitionId
UUID format: uuid
dockerImageTag (optional)
String

DestinationIdRequestBody - Up

destinationId
UUID format: uuid

DestinationRead - Up

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

DestinationReadList - Up

destinations
array[DestinationRead]

DestinationRecreate - Up

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

DestinationUpdate - Up

destinationId
UUID format: uuid
connectionConfiguration
DestinationConfiguration
name
String

HealthCheckRead - Up

db
Boolean

JobConfigType - Up

JobIdRequestBody - Up

id
Long format: int64

JobInfoRead - Up

job
JobRead
attempts
array[AttemptInfoRead]

JobListRequestBody - Up

configType
JobConfigType
configId
String

JobRead - Up

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

JobReadList - Up

jobs
array[JobWithAttemptsRead]

JobStatus - Up

JobWithAttemptsRead - Up

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

LogRead - Up

logLines
array[String]

SlugRequestBody - Up

slug
String

SourceCreate - Up

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

SourceDefinitionCreate - Up

name
String
dockerRepository
String
dockerImageTag
String
documentationUrl
URI format: uri

SourceDefinitionIdRequestBody - Up

sourceDefinitionId
UUID format: uuid

SourceDefinitionRead - Up

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

SourceDefinitionReadList - Up

sourceDefinitions
array[SourceDefinitionRead]

SourceDefinitionSpecificationRead - Up

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

SourceDefinitionUpdate - Up

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

SourceDiscoverSchemaRead - Up

schema
SourceSchema

SourceIdRequestBody - Up

sourceId
UUID format: uuid

SourceRead - Up

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

SourceReadList - Up

sources
array[SourceRead]

SourceRecreate - Up

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

SourceSchema - Up

describes the available schema.
streams
array[SourceSchemaStream]

SourceSchemaField - Up

name
String
cleanedName (optional)
String
dataType
DataType
selected
Boolean

SourceSchemaStream - Up

name
String
cleanedName (optional)
String
fields
array[SourceSchemaField]
supportedSyncModes (optional)
array[SyncMode]
sourceDefinedCursor (optional)
Boolean
defaultCursorField (optional)
array[String]
selected (optional)
Boolean
syncMode (optional)
SyncMode
cursorField (optional)
array[String]

SourceUpdate - Up

sourceId
UUID format: uuid
connectionConfiguration
SourceConfiguration
name
String

SyncMode - Up

WbConnectionRead - Up

connectionId
UUID format: uuid
name
String
sourceId
UUID format: uuid
destinationId
UUID format: uuid
syncMode
SyncMode
syncSchema
SourceSchema
schedule (optional)
ConnectionSchedule
status
ConnectionStatus
source
SourceRead
destination
DestinationRead
lastSync (optional)
Long epoch time of last sync. null if no sync has taken place. format: int64
isSyncing
Boolean

WbConnectionReadList - Up

connections
array[WbConnectionRead]

WorkspaceIdRequestBody - Up

workspaceId
UUID format: uuid

WorkspaceRead - Up

workspaceId
UUID format: uuid
customerId
UUID format: uuid
name
String
slug
String
initialSetupComplete
Boolean
onboardingComplete
Boolean

WorkspaceUpdate - Up

workspaceId
UUID format: uuid
email (optional)
String format: email
initialSetupComplete
Boolean
onboardingComplete
Boolean
anonymousDataCollection
Boolean
news
Boolean
securityUpdates
Boolean