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

# Update connection

> Update a connection's settings or rotate its secrets. Fields omitted
from the body are left unchanged; secrets are write-only.

A present ``snapshot_config`` replaces the stored policy, with one
protection: on HTTP connections, omitting the ``http_replication`` key
preserves the stored ``http_replication`` — clients that do not round-trip
it cannot erase it. Include ``http_replication`` to replace it, or set it
to ``null`` to clear it; other keys always reflect exactly what was sent.
Omit ``snapshot_config`` entirely to leave the whole policy unchanged.
``http_replication`` is valid only for HTTP/REST connector types and must
not be copied to dataset settings.



## OpenAPI

````yaml https://api.summation.com/openapi.json patch /v1/connections/data/{connection_id}
openapi: 3.1.0
info:
  title: summation-api public API
  version: 0.1.0
servers: []
security: []
tags:
  - name: Auth
    description: Machine authentication for API clients.
  - name: Tenant
    description: Organization and tenant context resolved by summation-api.
  - name: Projects
    description: Project resources.
  - name: Conversations
    description: Conversation and message resources.
  - name: Reports
    description: Report resources and report operations.
  - name: Runs
    description: Project run history and execution status.
  - name: Playbooks
    description: Playbook resources.
  - name: Files
    description: Project file resources.
  - name: Catalog Entries
    description: Project-scoped data asset attachments.
  - name: Data Connectors
    description: Reusable external data source connections.
  - name: App Connectors
    description: External app connectors whose tools the agent can use during chat.
  - name: Tables
    description: Canonical table metadata and catalog.
  - name: Views
    description: Canonical Summation view metadata and catalog.
  - name: Query Executions
    description: Read-only SQL query execution.
  - name: Grid
    description: Materialized grid status, sync, and lineage.
  - name: Schedules
    description: Schedule and schedule run inspection.
paths:
  /v1/connections/data/{connection_id}:
    patch:
      tags:
        - Data Connectors
      summary: Update connection
      description: >-
        Update a connection's settings or rotate its secrets. Fields omitted

        from the body are left unchanged; secrets are write-only.


        A present ``snapshot_config`` replaces the stored policy, with one

        protection: on HTTP connections, omitting the ``http_replication`` key

        preserves the stored ``http_replication`` — clients that do not
        round-trip

        it cannot erase it. Include ``http_replication`` to replace it, or set
        it

        to ``null`` to clear it; other keys always reflect exactly what was
        sent.

        Omit ``snapshot_config`` entirely to leave the whole policy unchanged.

        ``http_replication`` is valid only for HTTP/REST connector types and
        must

        not be copied to dataset settings.
      operationId: update_data_connection
      parameters:
        - name: connection_id
          in: path
          required: true
          schema:
            type: string
            title: Connection Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionWriteRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid request or unsupported option.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '401':
          description: Missing, invalid, or expired credentials.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '403':
          description: Authenticated but missing the required scope.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '404':
          description: Resource not found or not accessible.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
      security:
        - SummationMachineAuth:
            - agent:write
components:
  schemas:
    ConnectionWriteRequest:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Connection name, shown across Summation.
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
          description: Source type, e.g. POSTGRES or SNOWFLAKE.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Optional human-readable description.
        config:
          additionalProperties: true
          type: object
          title: Config
          description: >-
            Non-secret, type-specific settings. The accepted keys differ per
            type — GET /v1/connections/data/types/{type} lists them with which
            are required and a ready-to-send example. Postgres, for instance,
            takes pg_host, pg_port, pg_db, pg_user and pg_sslmode.
          examples:
            - pg_db: analytics
              pg_host: db.example.com
              pg_port: '5432'
              pg_user: summation
        secrets:
          additionalProperties: true
          type: object
          title: Secrets
          description: >-
            Credentials, keyed the same way as config — see GET
            /v1/connections/data/types/{type} for the secret keys of a given
            type (Postgres: pg_pass). Stored server-side as secret refs; never
            returned by any response.
          examples:
            - pg_pass: <password>
        snapshot_config:
          additionalProperties: true
          type: object
          title: Snapshot Config
          description: >-
            Connector-level snapshot policy. Only HTTP/REST connections may set
            snapshot_config.http_replication; never put http_replication in
            connector config or dataset snapshot settings. The object accepts
            version=1, validate_server_address (optional; true is the only
            accepted value — server-address validation cannot be disabled
            through this API), connector-scoped limits, and resources. Each
            resource defines request_path; cursor, required for every
            INCREMENTAL_* sync strategy and optional for FULL_REFRESH, in
            formats RFC3339, STRING, or INTEGER; optional composite tie-breaker
            and DESTINATION_MAX or EXPLICIT bootstrap; pagination modes
            NEXT_LINK and TOKEN using JSON pointers, LINK_HEADER using the RFC
            8288 Link response header, or KEYSET and OFFSET using query
            parameters (KEYSET requires a cursor); initial_query_parameters,
            which require a cursor; query_parameters containing ${cursor} and,
            for a composite cursor, ${tie_breaker}. A cursor-less resource
            rejects both placeholders, and may set constant query_parameters
            only under TOKEN or OFFSET pagination, where they are sent on every
            page; NEXT_LINK and LINK_HEADER follow a provider-built continuation
            URL and so reject query_parameters entirely. Optional
            source-to-destination field_mappings, tombstone, and
            execution_order. Data Management validates the complete
            configuration. Encode integers above 2^53-1 as strings
            (INTEGER-format cursor values are parsed back losslessly). PATCH
            semantics: a present snapshot_config replaces the stored policy,
            with one protection — on HTTP connections, omitting the
            http_replication key preserves the stored http_replication, so
            clients that do not round-trip it cannot erase it. Include
            http_replication to replace it, or set it to null to clear it. Omit
            the snapshot_config field entirely to leave the whole policy
            unchanged.
          examples:
            - enabled: true
              http_replication:
                limits:
                  max_concurrency: 2
                  max_response_bytes_per_request: 100000000
                  requests_per_day: 40000
                  requests_per_minute: 60
                  requests_per_second: 1
                  response_bytes_per_hour: 4000000000
                resources:
                  - cursor:
                      bootstrap_mode: DESTINATION_MAX
                      field: ModificationTimestamp
                      format: RFC3339
                      literal_style: ODATA
                      tie_breaker_field: ListingKey
                      tie_breaker_format: STRING
                    field_mappings:
                      '@odata.id': odata_id
                    initial_query_parameters:
                      $filter: ModificationTimestamp ge 2026-01-01T00:00:00Z
                    pagination:
                      data_pointer: /value
                      max_pages_per_run: 1000
                      mode: NEXT_LINK
                      next_pointer: /@odata.nextLink
                      page_size: 1000
                      page_size_parameter: $top
                    query_parameters:
                      $filter: >-
                        ModificationTimestamp gt ${cursor} or
                        (ModificationTimestamp eq ${cursor} and ListingKey gt
                        ${tie_breaker})
                    request_path: /v2/Property
                validate_server_address: true
                version: 1
      type: object
      title: ConnectionWriteRequest
    ProblemError:
      description: >-
        Public error envelope (RFC 7807 ``application/problem+json``).


        Mirrors the body produced by :func:`api_error`. Declaring it in the
        contract

        lets generated clients type error handling instead of guessing.
      properties:
        type:
          description: URI reference identifying the problem type.
          title: Type
          type: string
        title:
          description: Short, human-readable summary of the problem type.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation specific to this occurrence.
          title: Detail
          type: string
        code:
          description: Stable, machine-readable error code.
          title: Code
          type: string
        request_id:
          description: Correlation id, echoed in the x-request-id header.
          title: Request Id
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - request_id
      title: ProblemError
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    SummationMachineAuth:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            agent:read: agent:read
            agent:write: agent:write
          tokenUrl: /v1/auth/m2m/token

````