Sign in

v1

latestOpenAPI 3.1.02026-07-2654172281.3 KB
Destinations

Create a destination

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

post/destinations

Request body

namestring required

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

definitionIdstring uuid

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

workspaceIdstring uuid required

Example request

{
  "configuration": {
    "spreadsheet_id": "https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit"
  }
}

Response

Successful operation

destinationIdstring UUID required
namestring required
destinationTypestring required
workspaceIdstring UUID required

Example response

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