---
title: "Create a JWT token to perform a connectivity check in the data plane"
method: POST
path: "/connectivity-check/token"
tags: ["Data Plane Tokens"]
---

# Create a JWT token to perform a connectivity check in the data plane

`POST /connectivity-check/token`

## Request

- Base URL: `https://replace-with-account.api.decodable.co/v1alpha2`
- URL: `https://replace-with-account.api.decodable.co/v1alpha2/connectivity-check/token`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/decodable/apis/decodable-control-plane/docs/connectivity-check/token/post.ts> (a function with typed inputs; its response is checked against the schema)

Perform a one-off connectivity check.

## Request body

- ConnectionCommon: `kind: connection`, `spec_version: v1`.
  - `name` string: The connection name.
  - `description` string: 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_mappings` object[]: The connection stream mappings. If present, `schema` and `stream_id` must be `null`.
    - `stream_id` string: An opaque ID, created by Decodable, that uniquely identifies a resource.
    - `external_resource_specifier` unknown
  - `stream_id` string: An opaque ID, created by Decodable, that uniquely identifies a resource.
  - `schema` object[]: Record schema.
    - `name` string: The field name.
    - `type` string: The field type.
  - `schema_v2` SchemaV2: Record schema, version 2.
    - `fields` union[]: The fields in this schema.
      - union
        - PhysicalField: A physical field.
          - `kind` 'physical', required
          - `name` string
          - `type` string
        - ComputedField: A computed field.
          - `kind` 'computed', required
          - `name` string
          - `expression` string
        - MetadataField: A metadata field.
          - `kind` 'metadata', required
          - `name` string
          - `type` string
          - `key` string
    - `watermarks` object[]: Watermark expressions for this stream. At this time only one expression is supported.
      - `name` string
      - `expression` string
    - `constraints` object
      - `primary_key` string[]: Column names to use for primary key.
  - `properties` object: The connection properties.
  - `autoscale_configuration` AutoscaleConfiguration, nullable: The configuration for autoscale conditions.
    - `pause_conditions` object, nullable: A map of pause conditions and their given setting values.
    - `resume_conditions` object, nullable: A map of resume conditions and their given setting values.

## Response `200`

A request and token issued by the control plane API for use with the data plane API.

- object
  - `token` string, required: A JWT token issued by the control plane API permitting a specific request to the data plane.
  - `data_plane_request` string: 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.

## Other responses

- `400`: An invalid request was received.
- `403`: Access denied: requesting user lacks a required permission.
- `default`: An error has occurred.

---

[API](https://skmtc.dev/decodable/apis/decodable-control-plane.md) - [All operations](https://skmtc.dev/decodable/apis/decodable-control-plane/llms.txt) - [OpenAPI document](https://skmtc.dev/decodable/apis/decodable-control-plane/revisions/9718a3019da8?raw)