DEdecodable
Connection Operations

Create a connection.

Requires permissions matching:

  • connection:write:default.<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
post/connections

Request

  • Base URL
    https://replace-with-account.api.decodable.co/v1alpha2
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization codehttps://auth.decodable.co/authorize?audience=https://api.decodable.co/
      Token URLhttps://auth.decodable.co/oauth/token
      Scopeswrite:connection
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

stream_namestring

If a stream_id is not specified in the body, a new stream will be created with this name. Otherwise a default name will be generated.

stream_descriptionstring

If a stream_id is not specified in the body, a new stream will be created with this description. Otherwise a default description will be generated.

enable_experimentalboolean

Enable connections to be created using experimental connectors

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

Connectivity was successfully established but the connection was not created.

Changes

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