DEdecodable
Data Plane Tokens

Create a JWT token to perform a connectivity check for given connection in the data plane

Perform a connectivity check on the connection with optional modifications in the request body.

post/connections/{id}/connectivity-check/token

Request

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 request and token issued by the control plane API for use with the data plane API.

tokenstring required

A JWT token issued by the control plane API permitting a specific request to the data plane.

data_plane_requeststring

A stringified json request body for the data plane API which is permitted and signed by the associated JWT token. It must be sent verbatim (including whitespace) in order to match the token signature.

Changes

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