v30

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-16601,3773.2 MB

public_sources

public

Sources

Create a source

Creates a source given a name, workspace id, and a json blob containing the configuration for the source.

post/sources

Request body

namestring required

Name of the source e.g. dev-mysql-instance.

definitionIdstring uuid

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided.

workspaceIdstring uuid required

secretIdstring

Optional secretID obtained through the OAuth redirect flow.

Example request

{
  "configuration": {
    "start_date": "2022-03-01T00:00:00.000Z"
  }
}

Response

Successful operation

sourceIdstring UUID required

namestring required

sourceTypestring required

definitionIdstring UUID required

workspaceIdstring UUID required

createdAtinteger required

Example response

{
  "sourceId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
  "name": "Analytics Team Postgres",
  "sourceType": "postgres",
  "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e",
  "definitionId": "321d9b60-11d1-44cb-8c92-c246d53bf98e"
}