Статья создана

Get connection

Returns the specified connection.

Request

POST

https://api.datalens.tech/rpc/getConnection

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 2

Example: 2

x-dl-audit-mode

Type: string

Const: true

Example: ``

Body

application/json

{
  "connectionId": "example",
  "workbookId": "example",
  "bindedDatasetId": "example",
  "rev_id": "example"
}

Name	Description
connectionId	Type: string Example: `example`
bindedDatasetId	Type: string \| null Example: `example`
rev_id	Type: string Example: `example`
workbookId	Type: string \| null Example: `example`

Responses

200 OK

Response

Body

application/json

{
  "accuracy": null,
  "collection_id": "null",
  "counter_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "appmetrica_api",
  "updated_at": "example"
}

Name

Description

One of 29 types

appmetrica_api

Type: appmetrica_api1

Example

{
  "accuracy": null,
  "collection_id": "null",
  "counter_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "appmetrica_api",
  "updated_at": "example"
}

bigquery

Type: bigquery1

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "name": "example",
  "project_id": "example",
  "raw_sql_level": "off",
  "type": "bigquery",
  "updated_at": "example"
}

bitrix24

Type: bitrix241

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "portal": "example",
  "type": "bitrix24",
  "updated_at": "example"
}

ch_billing_analytics

Type: ch_billing_analytics1

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "ch_billing_analytics",
  "updated_at": "example"
}

ch_ya_music_podcast_stats

Type: ch_ya_music_podcast_stats1

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "ch_ya_music_podcast_stats",
  "updated_at": "example"
}

chyt

Type: chyt1

Example

{
  "alias": "example",
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "secure": true,
  "type": "chyt",
  "updated_at": "example"
}

clickhouse

Type: clickhouse1

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "connection_manager_cloud_id": "example",
  "connection_manager_connection_id": "example",
  "connection_manager_delegation_is_set": true,
  "connection_manager_folder_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "experimental_features": "off",
  "host": "example",
  "id": "example",
  "key": "example",
  "mdb_cluster_id": "example",
  "mdb_folder_id": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "readonly": 2,
  "secure": null,
  "ssl_ca_verify": "on",
  "type": "clickhouse",
  "updated_at": "example",
  "username": "example"
}

equeo

Type: equeo1

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "equeo",
  "updated_at": "example"
}

extractor1c

Type: extractor1c1

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "extractor1c",
  "updated_at": "example"
}

greenplum

Type: greenplum1

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "enforce_collate": "auto",
  "host": "example",
  "id": "example",
  "key": "example",
  "mdb_cluster_id": "example",
  "mdb_folder_id": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "greenplum",
  "updated_at": "example",
  "username": "example"
}

gsheets

Type: gsheets1

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "gsheets",
  "updated_at": "example",
  "url": "example"
}

json_api

Type: json_api1

Example

{
  "allowed_methods": [
    "GET"
  ],
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "path": "example",
  "plain_headers": {},
  "port": 0,
  "secret_headers": {},
  "secure": true,
  "type": "json_api",
  "updated_at": "example"
}

kontur_market

Type: kontur_market1

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "kontur_market",
  "updated_at": "example"
}

metrika_api

Type: metrika_api1

Example

{
  "accuracy": null,
  "collection_id": "null",
  "counter_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "metrika_api",
  "updated_at": "example"
}

monitoring

Type: monitoring1

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "cloud_id": "example",
  "collection_id": "null",
  "created_at": "example",
  "delegation_is_set": true,
  "description": "",
  "folder_id": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "service_account_id": "example",
  "type": "monitoring",
  "updated_at": "example"
}

moysklad

Type: moysklad1

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "moysklad",
  "updated_at": "example"
}

mssql

Type: mssql1

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "type": "mssql",
  "updated_at": "example",
  "username": "example"
}

mysql

Type: mysql1

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "connection_manager_cloud_id": "example",
  "connection_manager_connection_id": "example",
  "connection_manager_delegation_is_set": true,
  "connection_manager_folder_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "enforce_collate": "off",
  "host": "example",
  "id": "example",
  "key": "example",
  "mdb_cluster_id": "example",
  "mdb_folder_id": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "mysql",
  "updated_at": "example",
  "username": "example"
}

oracle

Type: oracle1

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_connect_method": "sid",
  "db_name": "example",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "oracle",
  "updated_at": "example",
  "username": "example"
}

postgres

Type: postgres1

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "connection_manager_cloud_id": "example",
  "connection_manager_connection_id": "example",
  "connection_manager_delegation_is_set": true,
  "connection_manager_folder_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "enforce_collate": "auto",
  "host": "example",
  "id": "example",
  "key": "example",
  "mdb_cluster_id": "example",
  "mdb_folder_id": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "postgres",
  "updated_at": "example",
  "username": "example"
}

promql

Type: promql1

Example

{
  "auth_type": "password",
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "path": "example",
  "port": 0,
  "secure": true,
  "type": "promql",
  "updated_at": "example",
  "username": "example"
}

smb_heatmaps

Type: smb_heatmaps1

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "smb_heatmaps",
  "updated_at": "example"
}

snowflake

Type: snowflake1

Example

{
  "account_name": "example",
  "client_id": "example",
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "name": "example",
  "raw_sql_level": "off",
  "refresh_token_expire_time": "2025-01-01T00:00:00Z",
  "schema": "example",
  "type": "snowflake",
  "updated_at": "example",
  "user_name": "example",
  "user_role": "example",
  "warehouse": "example"
}

speechsense

Type: speechsense1

Example

{
  "auth_type": "user_credentials",
  "cloud_id": "null",
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "delegation_is_set": null,
  "description": "",
  "folder_id": "null",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "project_id": "example",
  "service_account_id": "null",
  "type": "speechsense",
  "updated_at": "example"
}

trino

Type: trino1

Example

{
  "auth_type": null,
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "cloud_id": "example",
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "delegation_is_set": true,
  "description": "",
  "folder_id": "example",
  "host": "example",
  "id": "example",
  "key": "example",
  "listing_sources": null,
  "mdb_cluster_id": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "service_account_id": "example",
  "ssl_enable": "off",
  "type": "trino",
  "updated_at": "example",
  "username": "example"
}

usage_analytics_detailed

Type: usage_analytics_detailed1

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "usage_analytics_detailed",
  "updated_at": "example"
}

usage_analytics_light

Type: usage_analytics_light1

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "usage_analytics_light",
  "updated_at": "example"
}

ydb

Type: ydb1

Example

{
  "auth_type": "anonymous",
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "cloud_id": "example",
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "delegation_is_set": true,
  "description": "",
  "folder_id": "example",
  "host": "example",
  "id": "example",
  "key": "example",
  "mdb_cluster_id": "example",
  "mdb_folder_id": "example",
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "service_account_id": "example",
  "ssl_enable": "on",
  "type": "ydb",
  "updated_at": "example",
  "username": "example"
}

Type: yq1

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "cloud_id": "example",
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "delegation_is_set": true,
  "description": "",
  "folder_id": "example",
  "id": "example",
  "key": "example",
  "name": "example",
  "raw_sql_level": "off",
  "service_account_id": "example",
  "type": "yq",
  "updated_at": "example"
}

appmetrica_api1

Name

Description

counter_id

Type: string

Example: example

name

Type: string

Example: example

accuracy

Type: number | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: appmetrica_api

Example: example

updated_at

Type: string

Example: example

Example

{
  "accuracy": null,
  "collection_id": "null",
  "counter_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "appmetrica_api",
  "updated_at": "example"
}

bigquery1

Name	Description
name	Type: string Example: `example`
project_id	Type: string Example: `example`
cache_invalidation_throttling_interval_sec	Type: integer \| null Default: `null`
cache_ttl_sec	Type: integer \| null Default: `null`
collection_id	Type: string \| null Default: `null`
created_at	Type: string Example: `example`
description	Type: string \| null Default: ``
id	Type: string Example: `example`
key	Type: string Example: `example`
raw_sql_level	Type: string Default: `off` Enum: `off`, `subselect`, `template`, `dashsql`
type	Type: string Const: `bigquery` Example: `example`
updated_at	Type: string Example: `example`

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "name": "example",
  "project_id": "example",
  "raw_sql_level": "off",
  "type": "bigquery",
  "updated_at": "example"
}

bitrix241

Name

Description

name

Type: string

Example: example

portal

Type: string

Example: example

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: bitrix24

Example: example

updated_at

Type: string

Example: example

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "portal": "example",
  "type": "bitrix24",
  "updated_at": "example"
}

ch_billing_analytics1

Name

Description

name

Type: string

Example: example

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: ch_billing_analytics

Example: example

updated_at

Type: string

Example: example

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "ch_billing_analytics",
  "updated_at": "example"
}

ch_ya_music_podcast_stats1

Name

Description

name

Type: string

Example: example

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: ch_ya_music_podcast_stats

Example: example

updated_at

Type: string

Example: example

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "ch_ya_music_podcast_stats",
  "updated_at": "example"
}

chyt1

Name

Description

alias

Type: string

Example: example

host

Type: string

Example: example

name

Type: string

Example: example

port

Type: integer

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

raw_sql_level

Type: string

Default: off

Enum: off, subselect, template, dashsql

secure

Type: boolean

type

Type: string

Const: chyt

Example: example

updated_at

Type: string

Example: example

Example

{
  "alias": "example",
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "secure": true,
  "type": "chyt",
  "updated_at": "example"
}

clickhouse1

Name

Description

host

Type: string

Example: example

name

Type: string

Example: example

port

Type: integer

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

connection_manager_cloud_id

Type: string | null

Example: example

connection_manager_connection_id

Type: string | null

Example: example

connection_manager_delegation_is_set

Type: boolean | null

connection_manager_folder_id

Type: string | null

Example: example

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

db_name

Type: string | null

Example: example

description

Type: string | null

Default: ``

experimental_features

Type: unknown

Default: off

Type: string

Example: example

key

Type: string

Example: example

mdb_cluster_id

Type: string | null

Example: example

mdb_folder_id

Type: string | null

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

raw_sql_level

Type: string

Default: off

Enum: off, subselect, template, dashsql

readonly

Type: integer

Default: 2

secure

Type: unknown

Example: null

ssl_ca_verify

Type: unknown

Default: on

type

Type: string

Const: clickhouse

Example: example

updated_at

Type: string

Example: example

username

Type: string | null

Example: example

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "connection_manager_cloud_id": "example",
  "connection_manager_connection_id": "example",
  "connection_manager_delegation_is_set": true,
  "connection_manager_folder_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "experimental_features": "off",
  "host": "example",
  "id": "example",
  "key": "example",
  "mdb_cluster_id": "example",
  "mdb_folder_id": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "readonly": 2,
  "secure": null,
  "ssl_ca_verify": "on",
  "type": "clickhouse",
  "updated_at": "example",
  "username": "example"
}

equeo1

Name

Description

name

Type: string

Example: example

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: equeo

Example: example

updated_at

Type: string

Example: example

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "equeo",
  "updated_at": "example"
}

extractor1c1

Name

Description

name

Type: string

Example: example

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: extractor1c

Example: example

updated_at

Type: string

Example: example

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "extractor1c",
  "updated_at": "example"
}

greenplum1

Name

Description

host

Type: string

Example: example

name

Type: string

Example: example

port

Type: integer

username

Type: string

Example: example

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

db_name

Type: string | null

Example: example

description

Type: string | null

Default: ``

enforce_collate

Type: string

Default: auto

Enum: auto, on, off

Type: string

Example: example

key

Type: string

Example: example

mdb_cluster_id

Type: string | null

Example: example

mdb_folder_id

Type: string | null

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

raw_sql_level

Type: string

Default: off

Enum: off, subselect, template, dashsql

ssl_enable

Type: unknown

Default: off

type

Type: string

Const: greenplum

Example: example

updated_at

Type: string

Example: example

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "enforce_collate": "auto",
  "host": "example",
  "id": "example",
  "key": "example",
  "mdb_cluster_id": "example",
  "mdb_folder_id": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "greenplum",
  "updated_at": "example",
  "username": "example"
}

gsheets1

Name

Description

name

Type: string

Example: example

url

Type: string

Example: example

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: gsheets

Example: example

updated_at

Type: string

Example: example

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "gsheets",
  "updated_at": "example",
  "url": "example"
}

json_api1

Name

Description

allowed_methods

Type: string[]

Example

[
  "GET"
]

host

Type: string

Example: example

name

Type: string

Example: example

port

Type: integer

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

path

Type: string | null

Example: example

plain_headers

Type: object | null

Example

{}

secret_headers

Type: object | null

Example

{}

secure

Type: boolean

type

Type: string

Const: json_api

Example: example

updated_at

Type: string

Example: example

Example

{
  "allowed_methods": [
    "GET"
  ],
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "path": "example",
  "plain_headers": {},
  "port": 0,
  "secret_headers": {},
  "secure": true,
  "type": "json_api",
  "updated_at": "example"
}

kontur_market1

Name

Description

name

Type: string

Example: example

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: kontur_market

Example: example

updated_at

Type: string

Example: example

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "kontur_market",
  "updated_at": "example"
}

metrika_api1

Name

Description

counter_id

Type: string

Example: example

name

Type: string

Example: example

accuracy

Type: number | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: metrika_api

Example: example

updated_at

Type: string

Example: example

Example

{
  "accuracy": null,
  "collection_id": "null",
  "counter_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "metrika_api",
  "updated_at": "example"
}

monitoring1

Name

Description

cloud_id

Type: string | null

Example: example

folder_id

Type: string

Example: example

name

Type: string

Example: example

service_account_id

Type: string

Example: example

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

delegation_is_set

Type: boolean | null

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: monitoring

Example: example

updated_at

Type: string

Example: example

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "cloud_id": "example",
  "collection_id": "null",
  "created_at": "example",
  "delegation_is_set": true,
  "description": "",
  "folder_id": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "service_account_id": "example",
  "type": "monitoring",
  "updated_at": "example"
}

moysklad1

Name

Description

name

Type: string

Example: example

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: moysklad

Example: example

updated_at

Type: string

Example: example

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "moysklad",
  "updated_at": "example"
}

mssql1

Name

Description

host

Type: string

Example: example

name

Type: string

Example: example

port

Type: integer

username

Type: string

Example: example

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

db_name

Type: string | null

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

raw_sql_level

Type: string

Default: off

Enum: off, subselect, template, dashsql

type

Type: string

Const: mssql

Example: example

updated_at

Type: string

Example: example

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "type": "mssql",
  "updated_at": "example",
  "username": "example"
}

mysql1

Name

Description

host

Type: string

Example: example

name

Type: string

Example: example

port

Type: integer

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

connection_manager_cloud_id

Type: string | null

Example: example

connection_manager_connection_id

Type: string | null

Example: example

connection_manager_delegation_is_set

Type: boolean | null

connection_manager_folder_id

Type: string | null

Example: example

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

db_name

Type: string | null

Example: example

description

Type: string | null

Default: ``

enforce_collate

Type: string

Default: off

Enum: auto, on, off

Type: string

Example: example

key

Type: string

Example: example

mdb_cluster_id

Type: string | null

Example: example

mdb_folder_id

Type: string | null

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

raw_sql_level

Type: string

Default: off

Enum: off, subselect, template, dashsql

ssl_enable

Type: unknown

Default: off

type

Type: string

Const: mysql

Example: example

updated_at

Type: string

Example: example

username

Type: string | null

Example: example

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "connection_manager_cloud_id": "example",
  "connection_manager_connection_id": "example",
  "connection_manager_delegation_is_set": true,
  "connection_manager_folder_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "enforce_collate": "off",
  "host": "example",
  "id": "example",
  "key": "example",
  "mdb_cluster_id": "example",
  "mdb_folder_id": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "mysql",
  "updated_at": "example",
  "username": "example"
}

oracle1

Name

Description

db_connect_method

Type: string

Enum: sid, service_name

host

Type: string

Example: example

name

Type: string

Example: example

port

Type: integer

username

Type: string

Example: example

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

db_name

Type: string | null

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

raw_sql_level

Type: string

Default: off

Enum: off, subselect, template, dashsql

ssl_enable

Type: unknown

Default: off

type

Type: string

Const: oracle

Example: example

updated_at

Type: string

Example: example

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_connect_method": "sid",
  "db_name": "example",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "oracle",
  "updated_at": "example",
  "username": "example"
}

postgres1

Name

Description

host

Type: string

Example: example

name

Type: string

Example: example

port

Type: integer

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

connection_manager_cloud_id

Type: string | null

Example: example

connection_manager_connection_id

Type: string | null

Example: example

connection_manager_delegation_is_set

Type: boolean | null

connection_manager_folder_id

Type: string | null

Example: example

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

db_name

Type: string | null

Example: example

description

Type: string | null

Default: ``

enforce_collate

Type: string

Default: auto

Enum: auto, on, off

Type: string

Example: example

key

Type: string

Example: example

mdb_cluster_id

Type: string | null

Example: example

mdb_folder_id

Type: string | null

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

raw_sql_level

Type: string

Default: off

Enum: off, subselect, template, dashsql

ssl_enable

Type: unknown

Default: off

type

Type: string

Const: postgres

Example: example

updated_at

Type: string

Example: example

username

Type: string | null

Example: example

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "connection_manager_cloud_id": "example",
  "connection_manager_connection_id": "example",
  "connection_manager_delegation_is_set": true,
  "connection_manager_folder_id": "example",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "enforce_collate": "auto",
  "host": "example",
  "id": "example",
  "key": "example",
  "mdb_cluster_id": "example",
  "mdb_folder_id": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "postgres",
  "updated_at": "example",
  "username": "example"
}

promql1

Name

Description

host

Type: string

Example: example

name

Type: string

Example: example

port

Type: integer

auth_type

Type: unknown

Default: password

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

db_name

Type: string | null

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

path

Type: string | null

Example: example

secure

Type: boolean

type

Type: string

Const: promql

Example: example

updated_at

Type: string

Example: example

username

Type: string | null

Example: example

Example

{
  "auth_type": "password",
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "path": "example",
  "port": 0,
  "secure": true,
  "type": "promql",
  "updated_at": "example",
  "username": "example"
}

smb_heatmaps1

Name

Description

name

Type: string

Example: example

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: smb_heatmaps

Example: example

updated_at

Type: string

Example: example

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "smb_heatmaps",
  "updated_at": "example"
}

snowflake1

Name	Description
account_name	Type: string Example: `example`
client_id	Type: string Example: `example`
db_name	Type: string Example: `example`
name	Type: string Example: `example`
schema	Type: string Example: `example`
user_name	Type: string Example: `example`
warehouse	Type: string Example: `example`
collection_id	Type: string \| null Default: `null`
created_at	Type: string Example: `example`
data_export_forbidden	Type: unknown Default: `off`
description	Type: string \| null Default: ``
id	Type: string Example: `example`
key	Type: string Example: `example`
raw_sql_level	Type: string Default: `off` Enum: `off`, `subselect`, `template`, `dashsql`
refresh_token_expire_time	Type: string \| null Example: `2025-01-01T00:00:00Z`
type	Type: string Const: `snowflake` Example: `example`
updated_at	Type: string Example: `example`
user_role	Type: string \| null Example: `example`

Example

{
  "account_name": "example",
  "client_id": "example",
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "name": "example",
  "raw_sql_level": "off",
  "refresh_token_expire_time": "2025-01-01T00:00:00Z",
  "schema": "example",
  "type": "snowflake",
  "updated_at": "example",
  "user_name": "example",
  "user_role": "example",
  "warehouse": "example"
}

speechsense1

Name

Description

name

Type: string

Example: example

project_id

Type: string

Example: example

auth_type

Type: unknown

Default: user_credentials

cloud_id

Type: string | null

Default: null

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

delegation_is_set

Type: boolean | null

Default: null

description

Type: string | null

Default: ``

folder_id

Type: string | null

Default: null

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

service_account_id

Type: string | null

Default: null

type

Type: string

Const: speechsense

Example: example

updated_at

Type: string

Example: example

Example

{
  "auth_type": "user_credentials",
  "cloud_id": "null",
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "delegation_is_set": null,
  "description": "",
  "folder_id": "null",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "project_id": "example",
  "service_account_id": "null",
  "type": "speechsense",
  "updated_at": "example"
}

trino1

Name

Description

host

Type: string

Example: example

listing_sources

Type: unknown

Example: null

name

Type: string

Example: example

auth_type

Type: unknown

Example: null

cache_invalidation_throttling_interval_sec

Type: integer | null

Default: null

cache_ttl_sec

Type: integer | null

Default: null

cloud_id

Type: string | null

Example: example

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

data_export_forbidden

Type: unknown

Default: off

db_name

Type: string | null

Example: example

delegation_is_set

Type: boolean | null

description

Type: string | null

Default: ``

folder_id

Type: string | null

Example: example

Type: string

Example: example

key

Type: string

Example: example

mdb_cluster_id

Type: string | null

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

port

Type: integer | null

raw_sql_level

Type: string

Default: off

Enum: off, subselect, template, dashsql

service_account_id

Type: string | null

Example: example

ssl_enable

Type: unknown

Default: off

type

Type: string

Const: trino

Example: example

updated_at

Type: string

Example: example

username

Type: string | null

Example: example

Example

{
  "auth_type": null,
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "cloud_id": "example",
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "delegation_is_set": true,
  "description": "",
  "folder_id": "example",
  "host": "example",
  "id": "example",
  "key": "example",
  "listing_sources": null,
  "mdb_cluster_id": "example",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "service_account_id": "example",
  "ssl_enable": "off",
  "type": "trino",
  "updated_at": "example",
  "username": "example"
}

usage_analytics_detailed1

Name

Description

name

Type: string

Example: example

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: usage_analytics_detailed

Example: example

updated_at

Type: string

Example: example

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "usage_analytics_detailed",
  "updated_at": "example"
}

usage_analytics_light1

Name

Description

name

Type: string

Example: example

collection_id

Type: string | null

Default: null

created_at

Type: string

Example: example

description

Type: string | null

Default: ``

Type: string

Example: example

key

Type: string

Example: example

meta

Type: object

[additional]

Type: unknown

Example: null

Example

{}

type

Type: string

Const: usage_analytics_light

Example: example

updated_at

Type: string

Example: example

Example

{
  "collection_id": "null",
  "created_at": "example",
  "description": "",
  "id": "example",
  "key": "example",
  "meta": {},
  "name": "example",
  "type": "usage_analytics_light",
  "updated_at": "example"
}

ydb1

Name	Description
cloud_id	Type: string \| null Example: `example`
db_name	Type: string Example: `example`
folder_id	Type: string Example: `example`
host	Type: string Example: `example`
name	Type: string Example: `example`
port	Type: integer
service_account_id	Type: string Example: `example`
auth_type	Type: string \| null Enum: `anonymous`, `password`, `oauth`, `null` Example: `anonymous`
cache_invalidation_throttling_interval_sec	Type: integer \| null Default: `null`
cache_ttl_sec	Type: integer \| null Default: `null`
collection_id	Type: string \| null Default: `null`
created_at	Type: string Example: `example`
data_export_forbidden	Type: unknown Default: `off`
delegation_is_set	Type: boolean \| null
description	Type: string \| null Default: ``
id	Type: string Example: `example`
key	Type: string Example: `example`
mdb_cluster_id	Type: string \| null Example: `example`
mdb_folder_id	Type: string \| null Example: `example`
raw_sql_level	Type: string Default: `off` Enum: `off`, `subselect`, `template`, `dashsql`
ssl_enable	Type: unknown Default: `on`
type	Type: string Const: `ydb` Example: `example`
updated_at	Type: string Example: `example`
username	Type: string \| null Example: `example`

Example

{
  "auth_type": "anonymous",
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "cloud_id": "example",
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "delegation_is_set": true,
  "description": "",
  "folder_id": "example",
  "host": "example",
  "id": "example",
  "key": "example",
  "mdb_cluster_id": "example",
  "mdb_folder_id": "example",
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "service_account_id": "example",
  "ssl_enable": "on",
  "type": "ydb",
  "updated_at": "example",
  "username": "example"
}

yq1

Name	Description
cloud_id	Type: string \| null Example: `example`
folder_id	Type: string Example: `example`
name	Type: string Example: `example`
service_account_id	Type: string Example: `example`
cache_invalidation_throttling_interval_sec	Type: integer \| null Default: `null`
cache_ttl_sec	Type: integer \| null Default: `null`
collection_id	Type: string \| null Default: `null`
created_at	Type: string Example: `example`
data_export_forbidden	Type: unknown Default: `off`
delegation_is_set	Type: boolean \| null
description	Type: string \| null Default: ``
id	Type: string Example: `example`
key	Type: string Example: `example`
raw_sql_level	Type: string Default: `off` Enum: `off`, `subselect`, `template`, `dashsql`
type	Type: string Const: `yq` Example: `example`
updated_at	Type: string Example: `example`

Example

{
  "cache_invalidation_throttling_interval_sec": null,
  "cache_ttl_sec": null,
  "cloud_id": "example",
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "delegation_is_set": true,
  "description": "",
  "folder_id": "example",
  "id": "example",
  "key": "example",
  "name": "example",
  "raw_sql_level": "off",
  "service_account_id": "example",
  "type": "yq",
  "updated_at": "example"
}

Get connection

RequestRequest

HeadersHeaders

BodyBody

ResponsesResponses

200 OK200 OK

BodyBody

appmetrica_api1appmetrica_api1

bigquery1bigquery1

bitrix241bitrix241

ch_billing_analytics1ch_billing_analytics1

ch_ya_music_podcast_stats1ch_ya_music_podcast_stats1

chyt1chyt1

clickhouse1clickhouse1

equeo1equeo1

extractor1c1extractor1c1

greenplum1greenplum1

gsheets1gsheets1

json_api1json_api1

kontur_market1kontur_market1

metrika_api1metrika_api1

monitoring1monitoring1

moysklad1moysklad1

mssql1mssql1

mysql1mysql1

oracle1oracle1

postgres1postgres1

promql1promql1

smb_heatmaps1smb_heatmaps1

snowflake1snowflake1

speechsense1speechsense1

trino1trino1

usage_analytics_detailed1usage_analytics_detailed1

usage_analytics_light1usage_analytics_light1

ydb1ydb1

yq1yq1

Была ли статья полезна?

Request

Headers

Body

Responses

200 OK

Body

appmetrica_api1

bigquery1

bitrix241

ch_billing_analytics1

ch_ya_music_podcast_stats1

chyt1

clickhouse1

equeo1

extractor1c1

greenplum1

gsheets1

json_api1

kontur_market1

metrika_api1

monitoring1

moysklad1

mssql1

mysql1

oracle1

postgres1

promql1

smb_heatmaps1

snowflake1

speechsense1

trino1

usage_analytics_detailed1

usage_analytics_light1

ydb1

yq1