> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prophecy.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update connection

> Update the properties of a specific connection



## OpenAPI

````yaml put /api/orchestration/fabric/{fabricId}/connection/name/{connectionName}
openapi: 3.0.3
info:
  title: Prophecy Connections API
  description: API for managing Prophecy connections
  version: 1.0.0
servers: []
security: []
paths:
  /api/orchestration/fabric/{fabricId}/connection/name/{connectionName}:
    parameters:
      - name: fabricId
        in: path
        description: The unique ID of the parent fabric
        required: true
        schema:
          type: string
      - name: connectionName
        in: path
        description: The unique name of the connection
        required: true
        schema:
          type: string
    put:
      tags:
        - Connections
      summary: Update connection
      description: Update the properties of a specific connection
      operationId: updateConnection
      parameters:
        - $ref: '#/components/parameters/X-AUTH-TOKEN'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - kind
                - isDefaultWarehouseConnection
                - properties
              properties:
                name:
                  type: string
                  description: >-
                    The connection name. Must match the connection name
                    specified in the endpoint URL path parameter. This value
                    cannot be changed.
                kind:
                  type: string
                  description: The type of connection. This value cannot be changed.
                isDefaultWarehouseConnection:
                  type: boolean
                  description: >-
                    Whether this connection is the default warehouse connection.
                    This value cannot be changed.
                properties:
                  type: object
                  description: >-
                    Connection configuration properties. All required properties
                    for the connection type must be included. Only certain
                    properties can be updated. Check the Prophecy UI to see
                    which properties can be updated.


                    Find specific properties in the **Connections > Properties**
                    section of the API documentation.
            example:
              name: bigquery_api_test
              kind: bigquery
              isDefaultWarehouseConnection: false
              properties:
                authType: private_key
                dataset: kw_dev_api
                id: ''
                projectId: product-internal-463917
                serviceAccountKey:
                  kind: prophecy
                  properties:
                    id: '4657'
                    name: bq_service_account_2
                  subKind: text
                  type: secret
      responses:
        '200':
          description: Connection updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the request was successful.
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Unique identifier for the connection.
                      name:
                        type: string
                        description: The unique name of the connection.
                      kind:
                        type: string
                        description: The type of connection.
                      isDefaultWarehouseConnection:
                        type: boolean
                        description: >-
                          Whether this connection is the default warehouse
                          connection.
                      properties:
                        type: object
                        description: Connection configuration properties.
                  message:
                    type: string
                    description: Response message.
              example:
                success: true
                data:
                  id: d0ef2f82-5b66-4a17-b238-cc04c6f1cb3e
                  name: bigquery_api_test
                  kind: bigquery
                  isDefaultWarehouseConnection: false
                  properties:
                    authType: private_key
                    dataset: kw_dev_api
                    id: ''
                    projectId: product-internal-463917
                    serviceAccountKey:
                      kind: prophecy
                      properties:
                        id: '4657'
                        name: bq_service_account_2
                      subKind: text
                      type: secret
                message: List(), List()
        '400':
          description: >-
            Validation error. Required fields are missing or invalid, or the
            `name` field does not match the connection name in the endpoint URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful. Always false
                      for error responses.
                  message:
                    type: string
                    description: Error message describing the validation failure.
              example:
                success: false
                message: >-
                  Update connection failed due to : No connection found for
                  fabric 10740 and connection id bigquery_api_test_update
components:
  parameters:
    X-AUTH-TOKEN:
      name: X-AUTH-TOKEN
      in: header
      description: Prophecy authentication token. Required for all API requests.
      required: true
      schema:
        type: string

````