Get connection

Returns the specified connection.

Request

POST

http://<хост_on-premises>/rpc/getConnection

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 2

Example: 2

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 13 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"
}

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",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "experimental_features": "off",
  "host": "example",
  "id": "example",
  "key": "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"
}

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",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "greenplum",
  "updated_at": "example",
  "username": "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"
}

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"
}

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",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "enforce_collate": "off",
  "host": "example",
  "id": "example",
  "key": "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",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "enforce_collate": "auto",
  "host": "example",
  "id": "example",
  "key": "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"
}

trino

Type: trino1

Example

{
  "auth_type": null,
  "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",
  "listing_sources": null,
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "trino",
  "updated_at": "example",
  "username": "example"
}

ydb

Type: ydb1

Example

{
  "auth_type": "anonymous",
  "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",
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "ydb",
  "updated_at": "example",
  "username": "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"
}

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

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

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",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "experimental_features": "off",
  "host": "example",
  "id": "example",
  "key": "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"
}

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

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",
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "greenplum",
  "updated_at": "example",
  "username": "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"
}

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"
}

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

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: off

Enum: auto, on, off

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: mysql

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": "off",
  "host": "example",
  "id": "example",
  "key": "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

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

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

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",
  "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"
}

trino1

Name

Description

auth_type

Type: unknown

Example: null

host

Type: string

Example: example

listing_sources

Type: unknown

Example: null

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: trino

Example: example

updated_at

Type: string

Example: example

Example

{
  "auth_type": null,
  "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",
  "listing_sources": null,
  "meta": {},
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "trino",
  "updated_at": "example",
  "username": "example"
}

ydb1

Name	Description
db_name	Type: string Example: `example`
host	Type: string Example: `example`
name	Type: string Example: `example`
port	Type: integer
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`
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`
ssl_enable	Type: unknown Default: `off`
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,
  "collection_id": "null",
  "created_at": "example",
  "data_export_forbidden": "off",
  "db_name": "example",
  "description": "",
  "host": "example",
  "id": "example",
  "key": "example",
  "name": "example",
  "port": 0,
  "raw_sql_level": "off",
  "ssl_enable": "off",
  "type": "ydb",
  "updated_at": "example",
  "username": "example"
}

Overview

Create connection

Get connection

RequestRequest

HeadersHeaders

BodyBody

ResponsesResponses

200 OK200 OK

BodyBody

appmetrica_api1appmetrica_api1

chyt1chyt1

clickhouse1clickhouse1

greenplum1greenplum1

json_api1json_api1

metrika_api1metrika_api1

mssql1mssql1

mysql1mysql1

oracle1oracle1

postgres1postgres1

promql1promql1

trino1trino1

ydb1ydb1

Request

Headers

Body

Responses

200 OK

Body

appmetrica_api1

chyt1

clickhouse1

greenplum1

json_api1

metrika_api1

mssql1

mysql1

oracle1

postgres1

promql1

trino1

ydb1