---
title: "Search connections"
method: POST
path: "/v1/connections/search"
tags: ["connection"]
---

# Search connections

`POST /v1/connections/search`

## Request body

- ConnectionSearch
  - `connectionId` string, uuid
  - `destination` DestinationSearch
    - `connectionConfiguration` unknown
    - `destinationDefinitionId` string, uuid
    - `destinationId` string, uuid
    - `destinationName` string
    - `name` string
    - `workspaceId` string, uuid
  - `destinationId` string, uuid
  - `name` string
  - `namespaceDefinition` 'source' | 'destination' | 'customformat' — Method used for computing final namespace in destination
  - `namespaceFormat` string — Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
  - `prefix` string — Prefix that will be prepended to the name of each stream when it is written to the destination.
  - `schedule` ConnectionSchedule — if null, then no schedule is set.
    - `timeUnit` 'minutes' | 'hours' | 'days' | 'weeks' | 'months', required
    - `units` integer, required
  - `scheduleData` ConnectionScheduleData — schedule for when the the connection should run, per the schedule type
    - `basicSchedule` object
      - `timeUnit` 'minutes' | 'hours' | 'days' | 'weeks' | 'months', required
      - `units` integer, required
    - `cron` object
      - `cronExpression` string, required
      - `cronTimeZone` string, required
  - `scheduleType` 'manual' | 'basic' | 'cron' — determine how the schedule data should be interpreted
  - `source` SourceSearch
    - `connectionConfiguration` unknown
    - `name` string
    - `sourceDefinitionId` string, uuid
    - `sourceId` string, uuid
    - `sourceName` string
    - `workspaceId` string, uuid
  - `sourceId` string, uuid
  - `status` 'active' | 'inactive' | 'deprecated' — Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced.

## Response `200`

Successful operation

- ConnectionReadList
  - `connections` ConnectionRead[], required
    - `breakingChange` boolean, required
    - `connectionId` string, uuid, required
    - `destinationId` string, uuid, required
    - `geography` 'auto' | 'us' | 'eu'
    - `name` string, required
    - `namespaceDefinition` 'source' | 'destination' | 'customformat' — Method used for computing final namespace in destination
    - `namespaceFormat` string — Used when namespaceDefinition is 'customformat'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'.
    - `nonBreakingChangesPreference` 'ignore' | 'disable'
    - `notifySchemaChanges` boolean
    - `operationIds` OperationId[]
    - `prefix` string — Prefix that will be prepended to the name of each stream when it is written to the destination.
    - `resourceRequirements` ResourceRequirements — optional resource requirements to run workers (blank for unbounded allocations)
      - `cpu_limit` string
      - `cpu_request` string
      - `memory_limit` string
      - `memory_request` string
    - `schedule` ConnectionSchedule — if null, then no schedule is set.
      - `timeUnit` 'minutes' | 'hours' | 'days' | 'weeks' | 'months', required
      - `units` integer, required
    - `scheduleData` ConnectionScheduleData — schedule for when the the connection should run, per the schedule type
      - `basicSchedule` object
        - `timeUnit` 'minutes' | 'hours' | 'days' | 'weeks' | 'months', required
        - `units` integer, required
      - `cron` object
        - `cronExpression` string, required
        - `cronTimeZone` string, required
    - `scheduleType` 'manual' | 'basic' | 'cron' — determine how the schedule data should be interpreted
    - `sourceCatalogId` string, uuid
    - `sourceId` string, uuid, required
    - `status` 'active' | 'inactive' | 'deprecated', required — Active means that data is flowing through the connection. Inactive means it is not. Deprecated means the connection is off and cannot be re-activated. the schema field describes the elements of the schema that will be synced.
    - `syncCatalog` AirbyteCatalog, required — describes the available schema (catalog).
      - `streams` AirbyteStreamAndConfiguration[], required
        - `config` AirbyteStreamConfiguration — the mutable part of the stream to configure the destination
          - `aliasName` string — Alias name to the stream to be used in the destination
          - `cursorField` string[] — Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if `sync_mode` is `incremental`. Otherwise it is ignored.
          - `destinationSyncMode` 'append' | 'overwrite' | 'append_dedup', required
          - `fieldSelectionEnabled` boolean — Whether field selection should be enabled. If this is true, only the properties in `selectedFields` will be included.
          - `primaryKey` array[] — Paths to the fields that will be used as primary key. This field is REQUIRED if `destination_sync_mode` is `*_dedup`. Otherwise it is ignored.
            - string[]
          - `selected` boolean — If this is true, the stream is selected with all of its properties. For new connections, this considers if the stream is suggested or not
          - `selectedFields` SelectedFieldInfo[] — Paths to the fields that will be included in the configured catalog. This must be set if `fieldSelectedEnabled` is set. An empty list indicates that no properties will be included.
            - `fieldPath` string[]
          - `suggested` boolean — Does the connector suggest that this stream be enabled by default?
          - `syncMode` 'full_refresh' | 'incremental', required
        - `stream` AirbyteStream — the immutable schema defined by the source
          - `defaultCursorField` string[] — Path to the field that will be used to determine if a record is new or modified since the last sync. If not provided by the source, the end user will have to specify the comparable themselves.
          - `jsonSchema` StreamJsonSchema — Stream schema using Json Schema specs.
          - `name` string, required — Stream's name.
          - `namespace` string — Optional Source-defined namespace. Airbyte streams from the same sources should have the same namespace. Currently only used by JDBC destinations to determine what schema to write to.
          - `sourceDefinedCursor` boolean — If the source defines the cursor field, then any other cursor field inputs will be ignored. If it does not, either the user_provided one is used, or the default one is used as a backup.
          - `sourceDefinedPrimaryKey` array[] — If the source defines the primary key, paths to the fields that will be used as a primary key. If not provided by the source, the end user will have to specify the primary key themselves.
            - string[]
          - `supportedSyncModes` SyncMode[]

## Other responses

- `422` — Input failed validation

---

[API](https://skmtc.net/airbyte/apis/config.md) · [All operations](https://skmtc.net/airbyte/apis/config/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/airbyte/config/versions/ce48e08e02ec/schema)