Create a destination

Changed on Oct 30, 2025

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

post/destinations

Request

Base URL
https://api.airbyte.com/v1
URL
https://api.airbyte.com/v1/destinations
Auth
- HTTP bearer
- or HTTP basic
- or OAuth 2
  Client credentials
  Token URL: /applications/token

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

definitionIdstring UUID required

workspaceIdstring UUID required

createdAtinteger required

Example response

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

Changes

Oct 30, 20255e3520798637 Revision changes
- breaking
  removed subschema #3: OAuth2.0 from the // request property oneOf list
- breaking
  the response property const value Key Pair Authentication was removed for the status
- breaking
  the response property const value Username and Password was removed for the status
- breaking
  added subschema #4: Polaris Catalog to the // response property oneOf list for the response status
- warning
  removed the request property //
- warning
  removed the optional property // from the response with the status
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  the request property //// with a default value became required
- info
  the request property //// with a default value became required
- info
  the request property const value Key Pair Authentication was removed
- info
  the request property const value Username and Password was removed
- info
  the request property default value false was removed
- info
  the request property default value 1 was removed
- info
  added subschema #4: Polaris Catalog to the // request property oneOf list
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response's property default value false was removed for the status
- info
  the response's property default value 1 was removed for the status
- info
  removed subschema #3: OAuth2.0 from the // response property oneOf list for the response status
Jul 29, 20250701e88bdf31 Revision changes
- breaking
  the request property // became required
- breaking
  removed the enum value europe-central1 of the request property //
- breaking
  removed the enum value europe-west7 of the request property //
- breaking
  removed the enum value us-east2 of the request property //
- breaking
  removed the enum value us-east3 of the request property //
- breaking
  removed from the request property oneOf list
- breaking
  the /// request property type changed from no type to object
- breaking
  the /// request property type changed from no type to object
- breaking
  the ///// request property type changed from no type to object
- breaking
  the // request property type changed from integer to string
- breaking
  the /// request property type changed from no type to object
- breaking
  the /// request property type changed from no type to object
- breaking
  the /// request property type changed from no type to object
- breaking
  the response property const value HMAC_KEY was removed for the status
- breaking
  the response property const value GCS Staging was removed for the status
- breaking
  the response property const value Standard was removed for the status
- breaking
  the response property const value NO_TUNNEL was removed for the status
- breaking
  the response property const value SSH_KEY_AUTH was removed for the status
- breaking
  the response property const value SSH_PASSWORD_AUTH was removed for the status
- breaking
  added to the response property oneOf list for the response status
- breaking
  the /// response's property type changed from no type to object for status
- breaking
  the /// response's property type changed from no type to object for status
- breaking
  the ///// response's property type changed from no type to object for status
- breaking
  the // response's property type changed from integer to string for status
- breaking
  the /// response's property type changed from no type to object for status
- breaking
  the /// response's property type changed from no type to object for status
- breaking
  the /// response's property type changed from no type to object for status
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  added the new africa-south1 enum value to the // response property for the response status
- warning
  added the new europe-west10 enum value to the // response property for the response status
- warning
  added the new northamerica-south1 enum value to the // response property for the response status
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new required request property // with a default value
- info
  the request property const value HMAC_KEY was removed
- info
  the request property const value GCS Staging was removed
- info
  the request property const value Standard was removed
- info
  the request property const value NO_TUNNEL was removed
- info
  the request property const value SSH_KEY_AUTH was removed
- info
  the request property const value SSH_PASSWORD_AUTH was removed
- info
  the request property default value HMAC_KEY was added
- info
  the request property default value default was added
- info
  the request property default value GCS Staging was added
- info
  the request property default value Standard was added
- info
  the request property default value NO_TUNNEL was added
- info
  the request property default value SSH_KEY_AUTH was added
- info
  the request property default value SSH_PASSWORD_AUTH was added
- info
  the request property default value default was added
- info
  the request property default value changed from 8123 to 8443
- info
  added the new africa-south1 enum value to the request property //
- info
  added the new europe-west10 enum value to the request property //
- info
  added the new northamerica-south1 enum value to the request property //
- info
  added to the request property oneOf list
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  the response property // became required for the status
- info
  the response's property default value HMAC_KEY was added for the status
- info
  the response's property default value default was added for the status
- info
  the response's property default value GCS Staging was added for the status
- info
  the response's property default value Standard was added for the status
- info
  the response's property default value NO_TUNNEL was added for the status
- info
  the response's property default value SSH_KEY_AUTH was added for the status
- info
  the response's property default value SSH_PASSWORD_AUTH was added for the status
- info
  the response's property default value default was added for the status
- info
  the response's property default value changed from 8123 to 8443 for the status
- info
  removed the europe-central1 enum value from the // response property for the response status
- info
  removed the europe-west7 enum value from the // response property for the response status
- info
  removed the us-east2 enum value from the // response property for the response status
- info
  removed the us-east3 enum value from the // response property for the response status
- info
  removed from the response property oneOf list for the response status
- info
  added the required property // to the response with the status

Operation history (13 revisions)