DataLens API: Get connection

Field

Description

connectionId

string

Required field. ID of the connection to return. You can find it in the connection settings in DataLens interface.

workbookId

string | null

ID of the workbook the connection belongs to. If navigation across folders is enabled and the connection belongs to a folder, the value must be null.

rev_id

string

Version ID for the connection. For details, see documentation.

If the field is empty, you will get the current version of the connection.

Field

Description

accuracy

number | null

Accuracy of the metric data.

counter_id

string

Required field. AppMetrica counter (app) ID.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

description

string | null

Description of the connection.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

token

string

Required field. OAuth token of the connection.

type

appmetrica_api (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

Field

Description

additional_cluster

string

Backup cluster from the connection.

alias

string

Required field. CHYT clique alias.

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

cluster

string

Required field. Cluster from the connection.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

description

string | null

Description of the connection.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

raw_sql_level

enum

Raw SQL level:

• off — The option is disabled.
• subselect — Allowed subqueries in datasets.
• template — Allowed subqueries in datasets and source parameterization.
• dashsql — Allowed subqueries in datasets, source parameterization, and QL charts.

token

string

Required field. OAuth token from the connection.

type

ch_over_yt (const)

updated_at

string

Timestamp when the connection was last updated.

Field

Description

additional_cluster

string

Backup cluster from the connection.

alias

string

Required field. CHYT clique alias.

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

cluster

string

Required field. Cluster from the connection.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

description

string | null

Description of the connection.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

raw_sql_level

enum

Raw SQL level:

• off — The option is disabled.
• subselect — Allowed subqueries in datasets.
• template — Allowed subqueries in datasets and source parameterization.
• dashsql — Allowed subqueries in datasets, source parameterization, and QL charts.

type

ch_over_yt_user_auth (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

Field

Description

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

connection_manager_cloud_id

string | null

ID of the cloud where the connection to the cluster was created in Connection Manager.

connection_manager_connection_id

string | null

Connection ID from Connection Manager.

connection_manager_delegation_is_set

boolean | null

Type of connection management. If true, connections are created automatically by a managed database cluster. Else connections are created by a user or a third-party service.

connection_manager_folder_id

string | null

ID of the folder where the connection to the cluster was created in Connection Manager.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

db_name

string | null

Database name.

description

string | null

Description of the connection.

host

string

Required field. Host name.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

mdb_cluster_id

string | null

ID of the MDB cluster.

mdb_folder_id

string | null

ID of the MDB folder.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

password

string | null

Password for the connection.

port

integer

Required field. Connection port. The default port is 8443.

raw_sql_level

enum

Raw SQL level:

• off — The option is disabled.
• subselect — Allowed subqueries in datasets.
• template — Allowed subqueries in datasets and source parameterization.
• dashsql — Allowed subqueries in datasets, source parameterization, and QL charts.

readonly

integer

Read-only flag.

secure

unknown

Secure connection flag.

ssl_ca

unknown

SSL certificate authority.

type

clickhouse (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

username

string | null

Username for the connection.

Field

Description

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

db_name

string | null

Database name.

description

string | null

Description of the connection.

enforce_collate

enum

Mode of setting collate in a query:

• auto — Default setting is used, DataLens decides whether to enable the en_US locale.
• on — DataLens setting is used, the en_US locale is specified for individual expressions in a query.
• off — Applies the default setting. DataLens uses database-level locale settings.

host

string

Required field. Host name.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

mdb_cluster_id

string | null

ID of the MDB cluster.

mdb_folder_id

string | null

ID of the MDB folder.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

password

string

Required field. Password for the connection.

port

integer

Required field. Connection port.

raw_sql_level

enum

Raw SQL level:

• off — The option is disabled.
• subselect — Allowed subqueries in datasets.
• template — Allowed subqueries in datasets and source parameterization.
• dashsql — Allowed subqueries in datasets, source parameterization, and QL charts.

ssl_ca

unknown

SSL certificate authority.

ssl_enable

unknown

SSL flag.

type

greenplum (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

username

string

Required field. Username for the connection.

Field

Description

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

description

string | null

Description of the connection.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

type

gsheets (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

url

string

Required field. Path to the Google Sheets file.

Field

Description

allowed_methods[]

enum

Required field. A method to send an HTTP request to the API. The available methods are:

• GET
• POST

created_at

string

Timestamp when the connection was created.

description

string | null

Description of the connection.

host

string

Required field. Host name.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

path

string | null

Path to the API (part of the URL without a protocol, host name, or port).

plain_headers

object | null

Public request headers represented by key-value pair.

port

integer

Required field. Connection port.

secret_headers

object | null

Private request headers represented by key-value pair. For private headers value will return null.

secure

boolean

Secure connection flag.

tvm_dst_id

integer | null
ID for TVM authentication.

type

json_api (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

Field

Description

accuracy

number | null

Accuracy of the metric data.

counter_id

string

Required field. AppMetrica counter (app) ID.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

description

string | null

Description of the connection.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

token

string

Required field. OAuth token from the connection.

type

metrika_api (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

Field

Description

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

db_name

string | null

Database name.

description

string | null

Description of the connection.

host

string

Required field. Host name.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

password

string

Required field. Password for the connection.

port

integer

Required field. Connection port.

raw_sql_level

enum

Raw SQL level:

• off — The option is disabled.
• subselect — Allowed subqueries in datasets.
• template — Allowed subqueries in datasets and source parameterization.
• dashsql — Allowed subqueries in datasets, source parameterization, and QL charts.

type

mssql (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

username

string

Required field. Username for the connection.

Field

Description

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

connection_manager_cloud_id

string | null

ID of the cloud where the connection to the cluster was created in Connection Manager.

connection_manager_connection_id

string | null

Connection ID from Connection Manager.

connection_manager_delegation_is_set

boolean | null

Type of connection management. If true, connections are created automatically by a managed database cluster. Else connections are created by a user or a third-party service.

connection_manager_folder_id

string | null

ID of the folder where the connection to the cluster was created in Connection Manager.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

db_name

string | null

Database name.

description

string | null

Description of the connection.

host

string

Required field. Host name.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

mdb_cluster_id

string | null

ID of the MDB cluster.

mdb_folder_id

string | null

ID of the MDB folder.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

password

string | null

Password for the connection.

port

integer

Required field. Connection port.

raw_sql_level

enum

Raw SQL level:

• off — The option is disabled.
• subselect — Allowed subqueries in datasets.
• template — Allowed subqueries in datasets and source parameterization.
• dashsql — Allowed subqueries in datasets, source parameterization, and QL charts.

ssl_ca

unknown

SSL certificate authority.

ssl_enable

unknown

SSL flag.

type

mysql (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

username

string | null

Username for the connection.

Field

Description

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

db_connect_method

enum

Required field. Specified service name or the system ID of the database.

• sid — system ID.
• service_name — service name.

db_name

string | null

Database name.

description

string | null

Description of the connection.

host

string

Required field. Host name.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

password

string

Required field. Password for the connection.

port

integer

Required field. Connection port.

raw_sql_level

enum

Raw SQL level:

• off — The option is disabled.
• subselect — Allowed subqueries in datasets.
• template — Allowed subqueries in datasets and source parameterization.
• dashsql — Allowed subqueries in datasets, source parameterization, and QL charts.

ssl_ca

unknown

SSL certificate authority.

ssl_enable

unknown

SSL flag.

type

oracle (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

username

string

Required field. Username for the connection.

Field

Description

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

connection_manager_cloud_id

string | null

ID of the cloud where the connection to the cluster was created in Connection Manager.

connection_manager_connection_id

string | null

Connection ID from Connection Manager.

connection_manager_delegation_is_set

boolean | null

Type of connection management. If true, connections are created automatically by a managed database cluster. Else connections are created by a user or a third-party service.

connection_manager_folder_id

string | null

ID of the folder where the connection to the cluster was created in Connection Manager.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

db_name

string | null

Database name.

description

string | null

Description of the connection.

enforce_collate

enum

Mode of setting collate in a query:

• auto — Default setting is used, DataLens decides whether to enable the en_US locale.
• on — DataLens setting is used, the en_US locale is specified for individual expressions in a query.
• off — Applies the default setting. DataLens uses database-level locale settings.

host

string

Required field. Host name.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

mdb_cluster_id

string | null

ID of the MDB cluster.

mdb_folder_id

string | null

ID of the MDB folder.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

password

string | null

Password for the connection.

port

integer

Required field. Connection port.

raw_sql_level

enum

Raw SQL level:

• off — The option is disabled.
• subselect — Allowed subqueries in datasets.
• template — Allowed subqueries in datasets and source parameterization.
• dashsql — Allowed subqueries in datasets, source parameterization, and QL charts.

ssl_ca

unknown

SSL certificate authority.

ssl_enable

unknown

SSL flag.

type

postgres (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

username

string | null

Username for the connection.

Field

Description

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

db_name

string | null

Database name.

description

string | null

Description of the connection.

host

string

Required field. Host name.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

password

string | null

Password for the connection.

path

string | null

port

integer

Required field. Connection port.

secure

boolean

Secure connection flag.

type

promql (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

username

string | null

Username for the connection.

Field

Description

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

created_at

string

Timestamp when the connection was created.

description

string | null

Description of the connection.

host

string

Required field. Host name.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

type

solomon (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

Field

Description

created_at

string

Timestamp when the connection was created.

description

string | null

Description of the connection.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

meta

object (map<string, unknown>)

Metadata associated with the connection.

name

string

Required field. Name of the connection.

type

usage_tracking_ya_team (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

Field

Description

auth_type

enum

Authentication type:

• anonymous — anonymously.
• password — with password.
• oauth — with OAuth token.
• null — not specified.

cache_ttl_sec

integer | null

Cache time-to-live in seconds.

created_at

string

Timestamp when the connection was created.

data_export_forbidden

unknown

Indicates if data export is forbidden.

db_name

string

Required field. Database name.

description

string | null

Description of the connection.

host

string

Required field. Host name.

id

string

Unique identifier of the connection.

key

string

Key used to identify the connection. Indicates the path and name of the connection.

name

string

Required field. Name of the connection.

port

integer

Required field. Connection port.

raw_sql_level

enum

Raw SQL level:

• off — The option is disabled.
• subselect — Allowed subqueries in datasets.
• template — Allowed subqueries in datasets and source parameterization.
• dashsql — Allowed subqueries in datasets, source parameterization, and QL charts.

ssl_ca

unknown

SSL certificate authority.

ssl_enable

unknown

SSL flag.

token

string | null

OAuth token from the connection.

type

ydb (const)

Type of the connection.

updated_at

string

Timestamp when the connection was last updated.

username

string | null

Username for the connection.

Field

Description

Empty