Airbyte

Airbyte Public Destinations API

The public_destinations API from Airbyte — 2 operation(s) for public_destinations.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /destinations List destinations · Airbyte List Destinations #
Ask an LLM
“How do I list the destinations set up in my workspaces?”
“Can I include deleted destinations when listing them?”
Tell an agent
List destinations in workspace {workspaceIds}.
List all my destinations, including deleted ones.
POST /destinations Create a destination · Airbyte Create a Destination #
Ask an LLM
“How do I create a new destination like a warehouse to send data to?”
“What configuration do I need to supply when setting up a destination?”
Tell an agent
Create a destination named {name} in workspace {workspaceId} with configuration {configuration}.
Set up destination {name} in workspace {workspaceId} from connector definition {definitionId} using {configuration}.
GET /destinations/{destinationId} Get a destination's details · Airbyte Get Destination Details #
Ask an LLM
“How do I view the configuration of one destination?”
“Can I see secret coordinates instead of masked values for a destination?”
Tell an agent
Get destination {destinationId}.
Show destination {destinationId} with secret coordinates included.
DELETE /destinations/{destinationId} Delete a destination · Airbyte Delete a Destination #
Ask an LLM
“How do I delete a destination I no longer write to?”
“Can I remove a destination from my workspace?”
Tell an agent destructive · confirm first
Delete destination {destinationId}.
Remove the destination {destinationId}.
PATCH /destinations/{destinationId} Partially update a destination · Airbyte Update a Destination #
Ask an LLM
“How do I change just one setting on a destination, like its name?”
“Can I update only part of a destination's configuration?”
Tell an agent
Rename destination {destinationId} to {name}.
Patch destination {destinationId} with configuration changes {configuration}.
PUT /destinations/{destinationId} Fully overwrite a destination's configuration · Airbyte Update a Destination and Fully Overwrite it #
Ask an LLM
“How do I replace a destination's entire configuration rather than patch it?”
“Can I overwrite every field of a destination in one call?”
Tell an agent
Overwrite destination {destinationId} with name {name} and full configuration {configuration}.
Replace all settings of destination {destinationId} with {configuration}, named {name}.

Documentation

📖
Documentation
https://docs.airbyte.com
📖
APIReference
https://reference.airbyte.com/reference/getting-started
📖
Authentication
https://docs.airbyte.com/api-documentation

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/openapi/airbyte-public-destinations-api-openapi.yml

Other Resources

🔗
SDKs
https://github.com/airbytehq/airbyte-api-python-sdk
🔗
SDKs
https://github.com/airbytehq/airbyte-api-java-sdk
🔗
SDKs
https://pypi.org/project/airbyte-api/
🔗
SDKs
https://github.com/airbytehq/terraform-provider-airbyte
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/airbyte/refs/heads/main/graphql/airbyte-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/airbyte:airbyte-public-destinations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

airbyte-public-destinations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: airbyte-api Public Destinations API
  version: 1.0.0
  description: Programmatically control Airbyte Cloud, OSS & Enterprise.
servers:
- url: https://api.airbyte.com/v1
  description: Airbyte API v1
tags:
- name: public_destinations
paths:
  /destinations:
    get:
      tags:
      - public_destinations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DestinationsResponse'
              examples:
                listDestinations200Example:
                  summary: Default listDestinations 200 response
                  x-microcks-default: true
                  value:
                    previous: example
                    next: example
                    data: example
          description: Successful operation
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: listDestinations
      x-speakeasy-alias: listDestinations
      x-speakeasy-group: Destinations
      summary: Airbyte List Destinations
      parameters:
      - name: workspaceIds
        description: The UUIDs of the workspaces you wish to list destinations for. Empty list will retrieve all allowed workspaces.
        schema:
          type: array
          items:
            format: uuid
            type: string
        in: query
        required: false
      - name: includeDeleted
        description: Include deleted destinations in the returned results.
        schema:
          default: false
          type: boolean
        in: query
        required: false
      - name: limit
        description: Set the limit on the number of destinations returned. The default is 20.
        schema:
          format: int32
          type: integer
          minimum: 1
          maximum: 100
          default: 20
        in: query
      - name: offset
        description: Set the offset to start at when returning destinations. The default is 0
        schema:
          type: integer
          format: int32
          minimum: 0
          default: 0
        in: query
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DestinationCreateRequest'
            examples:
              Destination Creation Request Example:
                value:
                  name: Postgres
                  workspaceId: 2155ae5a-de39-4808-af6a-16fe7b8b4ed2
                  configuration:
                    airbyte_destination_name: postgres
                    port: 5432
                    schema: public
                    ssl_mode:
                      mode: prefer
                    tunnel_method:
                      tunnel_method: NO_TUNNEL
                    host: localhost
                    database: postgres
                    username: postgres
                    password: test
      tags:
      - public_destinations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DestinationResponse'
              examples:
                Destination Creation Response Example:
                  value:
                    destinationId: af0c3c67-aa61-419f-8922-95b0bf840e86
          description: Successful operation
        '400':
          description: Invalid data
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: createDestination
      x-speakeasy-alias: createDestination
      x-speakeasy-entity-operation: Destination#create
      x-speakeasy-group: Destinations
      summary: Airbyte Create a Destination
      description: Creates a destination given a name, workspace id, and a json blob containing the configuration for the source.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /destinations/{destinationId}:
    parameters:
    - name: destinationId
      schema:
        format: UUID
        type: string
      in: path
      required: true
    get:
      tags:
      - public_destinations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DestinationResponse'
              examples:
                Destination Get Response Example:
                  value:
                    destinationId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826
                    name: My Destination
                    sourceType: postgres
                    workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035
                    configuration:
                      conversion_window_days: 14
                      customer_id: '1234567890'
                      start_date: 1672531200000
                      end_date: 1704067200000
          description: Get a Destination by the id in the path.
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: getDestination
      x-speakeasy-alias: getDestination
      x-speakeasy-entity-operation: Destination#read
      x-speakeasy-group: Destinations
      summary: Airbyte Get Destination Details
      parameters:
      - in: query
        name: includeSecretCoordinates
        schema:
          type: boolean
        required: false
        description: Rather than return *** for secret properties include the secret coordinate information
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - public_destinations
      responses:
        '204':
          description: The resource was deleted successfully
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: deleteDestination
      x-speakeasy-alias: deleteDestination
      x-speakeasy-entity-operation: Destination#delete
      x-speakeasy-group: Destinations
      summary: Airbyte Delete a Destination
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - public_destinations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DestinationPatchRequest'
            examples:
              Destination Update Request Example:
                value:
                  configuration:
                    conversion_window_days: 14
                    customer_id: '1234567890'
                    start_date: 1672531200000
                    end_date: 1704067200000
                  name: My Destination
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DestinationResponse'
              examples:
                Destination Update Response Example:
                  value:
                    destinationId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826
                    name: running
                    sourceType: postgres
                    workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035
                    configuration:
                      conversion_window_days: 14
                      customer_id: '1234567890'
                      start_date: 1672531200000
                      end_date: 1704067200000
          description: Update a Destination
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: patchDestination
      x-speakeasy-alias: patchDestination
      x-speakeasy-group: Destinations
      summary: Airbyte Update a Destination
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      tags:
      - public_destinations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DestinationPutRequest'
            examples:
              Destination Update Request Example:
                value:
                  configuration:
                    conversion_window_days: 14
                    customer_id: '1234567890'
                    start_date: 1672531200000
                    end_date: 1704067200000
                  name: My Destination
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DestinationResponse'
              examples:
                Destination Update Response Example:
                  value:
                    destinationId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826
                    name: running
                    sourceType: postgres
                    workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035
                    configuration:
                      conversion_window_days: 14
                      customer_id: '1234567890'
                      start_date: 1672531200000
                      end_date: 1704067200000
          description: Update a Destination and fully overwrite it
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: putDestination
      x-speakeasy-alias: putDestination
      x-speakeasy-group: Destinations
      x-speakeasy-entity-operation: Destination#update
      summary: Airbyte Update a Destination and Fully Overwrite it
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DestinationPutRequest:
      required:
      - name
      - configuration
      type: object
      properties:
        name:
          type: string
        configuration:
          $ref: '#/components/schemas/DestinationConfiguration'
        resourceAllocation:
          $ref: '#/components/schemas/ScopedResourceRequirements'
      x-implements: io.airbyte.api.common.ConfigurableActor
      x-speakeasy-entity: Destination
      x-speakeasy-param-suppress-computed-diff: true
      x-speakeasy-component: true
    ScopedResourceRequirements:
      x-speakeasy-component: true
      description: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
      type: object
      additionalProperties: false
      properties:
        default:
          $ref: '#/components/schemas/ResourceRequirements'
        jobSpecific:
          type: array
          items:
            $ref: '#/components/schemas/JobTypeResourceLimit'
    DestinationPatchRequest:
      type: object
      properties:
        name:
          type: string
        configuration:
          $ref: '#/components/schemas/DestinationConfiguration'
        resourceAllocation:
          $ref: '#/components/schemas/ScopedResourceRequirements'
      x-implements: io.airbyte.api.common.ConfigurableActor
      x-speakeasy-entity: Destination
      x-speakeasy-param-suppress-computed-diff: true
      x-speakeasy-component: true
    JobType:
      x-speakeasy-component: true
      description: enum that describes the different types of jobs that the platform runs.
      type: string
      enum:
      - get_spec
      - check_connection
      - discover_schema
      - sync
      - reset_connection
      - connection_updater
      - replicate
    DestinationCreateRequest:
      required:
      - name
      - workspaceId
      - configuration
      type: object
      properties:
        name:
          description: Name of the destination e.g. dev-mysql-instance.
          type: string
        definitionId:
          description: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided.
          format: uuid
          type: string
        workspaceId:
          format: uuid
          type: string
        configuration:
          $ref: '#/components/schemas/DestinationConfiguration'
        resourceAllocation:
          $ref: '#/components/schemas/ScopedResourceRequirements'
      x-implements: io.airbyte.api.common.ConfigurableActor
      x-speakeasy-entity: Destination
      x-speakeasy-param-suppress-computed-diff: true
      x-speakeasy-component: true
    DestinationConfiguration:
      type: object
      description: The values required to configure the destination. The schema for this must match the schema return by destination_definition_specifications/get for the destinationDefinition.
      example:
        user: charles
      x-speakeasy-component: true
    DestinationsResponse:
      title: Root Type for DestinationsResponse
      description: ''
      required:
      - data
      type: object
      properties:
        previous:
          type: string
        next:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/DestinationResponse'
      example:
        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
      x-speakeasy-component: true
    JobTypeResourceLimit:
      x-speakeasy-component: true
      description: sets resource requirements for a specific job type for an actor or actor definition. these values override the default, if both are set.
      type: object
      additionalProperties: false
      required:
      - jobType
      - resourceRequirements
      properties:
        jobType:
          $ref: '#/components/schemas/JobType'
        resourceRequirements:
          $ref: '#/components/schemas/ResourceRequirements'
    DestinationResponse:
      title: Root Type for DestinationResponse
      description: Provides details of a single destination.
      type: object
      required:
      - destinationId
      - name
      - destinationType
      - definitionId
      - workspaceId
      - configuration
      - createdAt
      properties:
        destinationId:
          format: UUID
          type: string
        name:
          type: string
        destinationType:
          type: string
        definitionId:
          format: UUID
          type: string
        workspaceId:
          format: UUID
          type: string
        configuration:
          $ref: '#/components/schemas/DestinationConfiguration'
        createdAt:
          format: int64
          type: integer
        resourceAllocation:
          $ref: '#/components/schemas/ScopedResourceRequirements'
      example:
        destinationId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826
        name: Analytics Team Postgres
        destinationType: postgres
        workspaceId: 871d9b60-11d1-44cb-8c92-c246d53bf87e
        definitionId: 321d9b60-11d1-44cb-8c92-c246d53bf98e
      x-speakeasy-component: true
    ResourceRequirements:
      x-speakeasy-component: true
      description: optional resource requirements to run workers (blank for unbounded allocations)
      type: object
      properties:
        cpu_request:
          type: string
        cpu_limit:
          type: string
        memory_request:
          type: string
        memory_limit:
          type: string
        ephemeral_storage_request:
          type: string
        ephemeral_storage_limit:
          type: string