Airbyte

Airbyte Public Destination Definitions API

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

GitHub OpenAPI

Operations 5

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 /workspaces/{workspaceId}/definitions/destinations List a workspace's destination definitions · Airbyte List Destination Definitions #
Ask an LLM
“Which destination connector definitions exist in my workspace?”
“How do I see the custom destination connectors registered in a workspace?”
Tell an agent
List the destination definitions in workspace {workspaceId}.
Show all destination connector definitions for workspace {workspaceId}.
POST /workspaces/{workspaceId}/definitions/destinations Register a custom destination connector image · Airbyte Create a Destination Definition #
Ask an LLM
“How do I add a custom destination connector from my own Docker image?”
“Can I register a destination definition with a documentation URL?”
Tell an agent
Create destination definition {name} in workspace {workspaceId} from image {dockerRepository}:{dockerImageTag}.
Register custom destination {name} in workspace {workspaceId} using repository {dockerRepository} tag {dockerImageTag}, docs at {documentationUrl}.
GET /workspaces/{workspaceId}/definitions/destinations/{definitionId} Get a destination definition · Airbyte Get Destination Definition Details #
Ask an LLM
“How do I check which Docker image a destination definition uses?”
“What details are stored for a single destination definition?”
Tell an agent
Get destination definition {definitionId} in workspace {workspaceId}.
Show the image tag of destination definition {definitionId} in workspace {workspaceId}.
PUT /workspaces/{workspaceId}/definitions/destinations/{definitionId} Update a destination definition's name or image tag · Airbyte Update Destination Definition Details #
Ask an LLM
“How do I bump the image tag of a custom destination connector?”
“Can I rename a destination definition I registered?”
Tell an agent
Update destination definition {definitionId} in workspace {workspaceId} to name {name} and image tag {dockerImageTag}.
Upgrade custom destination {definitionId} in workspace {workspaceId} to tag {dockerImageTag}, keeping name {name}.
DELETE /workspaces/{workspaceId}/definitions/destinations/{definitionId} Delete a destination definition · Airbyte Delete a Destination Definition #
Ask an LLM
“How do I delete a custom destination connector definition?”
“Can I remove a destination definition from my workspace?”
Tell an agent destructive · confirm first
Delete destination definition {definitionId} from workspace {workspaceId}.
Remove custom destination connector {definitionId} in workspace {workspaceId}.

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-destination-definitions-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-destination-definitions-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-destination-definitions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: airbyte-api Public Destination Definitions 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_destination_definitions
paths:
  /workspaces/{workspaceId}/definitions/destinations:
    parameters:
    - name: workspaceId
      schema:
        format: uuid
        type: string
      in: path
      required: true
    get:
      tags:
      - public_destination_definitions
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefinitionsResponse'
              examples:
                listDestinationDefinitions200Example:
                  summary: Default listDestinationDefinitions 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: listDestinationDefinitions
      x-speakeasy-alias: listDestinationDefinitions
      x-speakeasy-group: DestinationDefinitions
      summary: Airbyte List Destination Definitions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDestinationDefinition
      x-speakeasy-alias: createDestinationDefinition
      x-speakeasy-group: DestinationDefinitions
      summary: Airbyte Create a Destination Definition
      x-speakeasy-entity-operation: DestinationDefinition#create
      tags:
      - public_destination_definitions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDefinitionRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefinitionResponse'
              examples:
                createDestinationDefinition200Example:
                  summary: Default createDestinationDefinition 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: example-name
                    dockerRepository: example
                    dockerImageTag: example
                    documentationUrl: https://example.com
          description: Success
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /workspaces/{workspaceId}/definitions/destinations/{definitionId}:
    parameters:
    - name: workspaceId
      schema:
        format: uuid
        type: string
      in: path
      required: true
    - name: definitionId
      x-speakeasy-match: id
      schema:
        format: uuid
        type: string
      in: path
      required: true
    get:
      tags:
      - public_destination_definitions
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefinitionResponse'
              examples:
                getDestinationDefinition200Example:
                  summary: Default getDestinationDefinition 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: example-name
                    dockerRepository: example
                    dockerImageTag: example
                    documentationUrl: https://example.com
          description: Success
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: getDestinationDefinition
      x-speakeasy-alias: getDestinationDefinition
      x-speakeasy-group: DestinationDefinitions
      summary: Airbyte Get Destination Definition Details
      x-speakeasy-entity-operation: DestinationDefinition#read
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      tags:
      - public_destination_definitions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDefinitionRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefinitionResponse'
              examples:
                updateDestinationDefinition200Example:
                  summary: Default updateDestinationDefinition 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: example-name
                    dockerRepository: example
                    dockerImageTag: example
                    documentationUrl: https://example.com
          description: Success
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: updateDestinationDefinition
      x-speakeasy-alias: updateDestinationDefinition
      x-speakeasy-group: DestinationDefinitions
      summary: Airbyte Update Destination Definition Details
      x-speakeasy-entity-operation: DestinationDefinition#update
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - public_destination_definitions
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefinitionResponse'
              examples:
                deleteDestinationDefinition200Example:
                  summary: Default deleteDestinationDefinition 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: example-name
                    dockerRepository: example
                    dockerImageTag: example
                    documentationUrl: https://example.com
          description: Success
        '403':
          description: Not allowed
        '404':
          description: Not found
      operationId: deleteDestinationDefinition
      x-speakeasy-alias: deleteDestinationDefinition
      x-speakeasy-group: DestinationDefinitions
      summary: Airbyte Delete a Destination Definition
      x-speakeasy-entity-operation: DestinationDefinition#delete
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    UpdateDefinitionRequest:
      type: object
      x-speakeasy-component: true
      required:
      - name
      - dockerImageTag
      properties:
        name:
          type: string
        dockerImageTag:
          type: string
    CreateDefinitionRequest:
      type: object
      x-speakeasy-component: true
      required:
      - name
      - dockerRepository
      - dockerImageTag
      properties:
        name:
          type: string
        dockerRepository:
          type: string
        dockerImageTag:
          type: string
        documentationUrl:
          type: string
          format: uri
    DefinitionsResponse:
      title: Root Type for DefinitionsResponse
      description: ''
      x-speakeasy-component: true
      required:
      - data
      type: object
      properties:
        previous:
          type: string
        next:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/DefinitionResponse'
    DefinitionResponse:
      title: Root Type for DefinitionResponse
      description: Provides details of a single connector definition.
      type: object
      x-speakeasy-component: true
      required:
      - id
      - name
      - dockerRepository
      - dockerImageTag
      properties:
        id:
          format: UUID
          type: string
        name:
          type: string
        dockerRepository:
          type: string
        dockerImageTag:
          type: string
        documentationUrl:
          type: string