public_destinations
public
Destinations

List destinations

Changed on
get/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

Query parameters

workspaceIdsstring[]

The UUIDs of the workspaces you wish to list destinations for. Empty list will retrieve all allowed workspaces.

includeDeletedboolean

Include deleted destinations in the returned results.

limitinteger

Set the limit on the number of destinations returned. The default is 20.

offsetinteger

Set the offset to start at when returning destinations. The default is 0

Response

Successful operation

previousstring
nextstring

Example response

{
  "next": "https://api.airbyte.com/v1/destinations?limit=5&offset=10",
  "previous": "https://api.airbyte.com/v1/destinations?limit=5&offset=0",
  "data": {
    "destinationId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
    "name": "Analytics Team Postgres",
    "destinationType": "postgres",
    "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e"
  }
}

Changes

    • 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 optional property //// from 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

      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

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