DEdecodable
Connection Operations

Update an existing connection by id.

Requires permissions matching:

  • connection:write:default.<name> for both old and new name
  • stream:read-data:default.<stream-name> on attached streams for sink connections
  • stream:write-data:default.<stream-name> on attached streams for source connections
patch/connections/{id}

Request

Query parameters

response_schema_v'v1' | 'v2'

The response schema version to use. Defaults to v1. When v1, the response will include the schema field. When v2, the response will include the schema_v2 field.

Request body

namestring

The connection name.

descriptionstring

The connection description.

connector'astra-streaming' | 'clickhouse' | 'confluent-cloud' | 'datadog' | 'datagen' | 'delta-lake' | 'druid' | 'dynamodb-cdc' | 'elasticsearch' | 'gcp-pubsub' | 'hudi' | 'influxdb' | 'kafka' | 'kinesis' | 'mongodb' | 'mongodb-cdc' | 'ms-sql' | 'mysql-cdc' | 'oracle' | 'oracle-cdc' | 'pinot' | 'polaris' | 'postgres' | 'postgres-cdc' | 'pulsar' | 'redis' | 'redpanda' | 'redshift' | 'rest' | 'rockset' | 's3' | 's3-lambda' | 's3-v2' | 'singlestore-db' | 'snowflake' | 'startree' | 'streamnative' | 'timescale'

The connector used by the connection.

type'source' | 'sink'

The connection type.

stream_idstring

An opaque ID, created by Decodable, that uniquely identifies a resource.

propertiesobject

The connection properties.

Example request

{
  "stream_mappings": [
    {
      "stream_id": "abcd1234"
    }
  ],
  "stream_id": "abcd1234",
  "autoscale_configuration": {
    "pause_conditions": {
      "max_record_read_rate": {
        "record_count": "100",
        "duration_seconds": "300"
      },
      "max_job_runtime": {
        "duration_seconds": "3600"
      }
    },
    "resume_conditions": {
      "schedule": {
        "cron_expression": "0 8 * * *"
      }
    }
  }
}

Response

A connection update response.

OR

Example response

{
  "operator-chaining": "true"
}

Changes

No recorded changes to this operation across all 1 revision of this API.