---
title: "Update Connection details"
method: PATCH
path: "/connections/{connectionId}"
tags: ["public_connections", "public", "Connections"]
---

# Update Connection details

`PATCH /connections/{connectionId}`

## Request body

- ConnectionPatchRequest
  - `name` string — Optional name of the connection
  - `configurations` StreamConfigurations — A list of configured stream options for a connection.
    - `streams` StreamConfiguration[]
      - `name` string, required
      - `syncMode` 'full_refresh_overwrite' | 'full_refresh_append' | 'incremental_append' | 'incremental_deduped_history'
      - `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` unless there is a default.
      - `primaryKey` array[] — Paths to the fields that will be used as primary key. This field is REQUIRED if `destination_sync_mode` is `*_dedup` unless it is already supplied by the source schema.
        - string[]
      - `selectedFields` SelectedFieldInfo[] — Paths to the fields that will be included in the configured catalog.
        - `fieldPath` string[]
      - `mappers` ConfiguredStreamMapper[] — Mappers that should be applied to the stream before writing to the destination.
        - `type` 'hashing' | 'field-renaming' | 'row-filtering' | 'encryption', required
        - `mapperConfiguration` MapperConfiguration, required — The values required to configure the mapper.
  - `schedule` AirbyteApiConnectionSchedule — schedule for when the the connection should run, per the schedule type
    - `scheduleType` 'manual' | 'cron', required
    - `cronExpression` string
  - `dataResidency` 'auto' | 'us' | 'eu'
  - `namespaceDefinition` 'source' | 'destination' | 'custom_format' — Define the location where the data will be stored in the destination
  - `namespaceFormat` string — Used when namespaceDefinition is 'custom_format'. 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 (ex. “airbyte_” causes “projects” => “airbyte_projects”).
  - `nonBreakingSchemaUpdatesBehavior` 'ignore' | 'disable_connection' | 'propagate_columns' | 'propagate_fully' — Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
  - `status` 'active' | 'inactive' | 'deprecated'

## Response `200`

Update a Connection by the id in the path.

- ConnectionResponse — Provides details of a single connection.
  - `connectionId` string, UUID, required
  - `name` string, required
  - `sourceId` string, UUID, required
  - `destinationId` string, UUID, required
  - `workspaceId` string, UUID, required
  - `status` 'active' | 'inactive' | 'deprecated', required
  - `schedule` ConnectionScheduleResponse, required — schedule for when the the connection should run, per the schedule type
    - `scheduleType` 'manual' | 'cron' | 'basic', required
    - `cronExpression` string
    - `basicTiming` string
  - `dataResidency` 'auto' | 'us' | 'eu', required
  - `nonBreakingSchemaUpdatesBehavior` 'ignore' | 'disable_connection' | 'propagate_columns' | 'propagate_fully' — Set how Airbyte handles syncs when it detects a non-breaking schema change in the source
  - `namespaceDefinition` 'source' | 'destination' | 'custom_format' — Define the location where the data will be stored in the destination
  - `namespaceFormat` string
  - `prefix` string
  - `configurations` StreamConfigurations, required — A list of configured stream options for a connection.
    - `streams` StreamConfiguration[]
      - `name` string, required
      - `syncMode` 'full_refresh_overwrite' | 'full_refresh_append' | 'incremental_append' | 'incremental_deduped_history'
      - `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` unless there is a default.
      - `primaryKey` array[] — Paths to the fields that will be used as primary key. This field is REQUIRED if `destination_sync_mode` is `*_dedup` unless it is already supplied by the source schema.
        - string[]
      - `selectedFields` SelectedFieldInfo[] — Paths to the fields that will be included in the configured catalog.
        - `fieldPath` string[]
      - `mappers` ConfiguredStreamMapper[] — Mappers that should be applied to the stream before writing to the destination.
        - `type` 'hashing' | 'field-renaming' | 'row-filtering' | 'encryption', required
        - `mapperConfiguration` MapperConfiguration, required — The values required to configure the mapper.
  - `createdAt` integer, required

## Other responses

- `403` — Not allowed
- `404` — Not found

## Changes

- **2024-12-03** `522cd014c007` — 1 warning, 2 info
  - added the new `encryption` enum value to the `configurations/streams/items/mappers/items/type` response property for the response status `200`
  - added the new `encryption` enum value to the request property `configurations/streams/items/mappers/items/type`
  - added the required property `createdAt` to the response with the `200` status
- **2024-10-31** `5b0643782cd5` — 5 breaking, 3 warning, 3 info
  - request property `configurations/streams/items/mappers/items/type` was restricted to a list of enum values
  - the `configurations/streams/items/mappers/items/mapperConfiguration` request property type/format changed from ``/`` to `object`/``
  - the `configurations/streams/items/mappers/items/type` request property type/format changed from ``/`` to `string`/``
  - the `configurations/streams/items/mappers/items/mapperConfiguration` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - …7 more
- **2024-10-23** `fae855ef1b76` — 2 info
  - added the new optional request property `configurations/streams/items/mappers`
  - added the optional property `configurations/streams/items/mappers` to the response with the `200` status

[Change history](https://skmtc.dev/airbytehq/apis/airbyte-api/changes/connections/:connectionId/patch.md)

---

[API](https://skmtc.dev/airbytehq/apis/airbyte-api.md) · [All operations](https://skmtc.dev/airbytehq/apis/airbyte-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/airbytehq/airbyte-api/revisions/522cd014c007/schema)