Test SSH Tunnel

Version 4.0.26.2 (latest)

Test the SSH Tunnel

Request

GET/ssh_tunnel/{ssh_tunnel_id}/test
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
ssh_tunnel_id
string
Id of SSH Tunnel

Response

200: Test SSH Tunnel

Datatype
Description
(object)
tunnel_id
string
Unique ID for the tunnel
ssh_server_id
string
SSH Server ID
ssh_server_name
string
SSH Server name
ssh_server_host
string
SSH Server Hostname or IP Address
ssh_server_port
integer
SSH Server port
ssh_server_user
string
Username used to connect to the SSH Server
last_attempt
string
Time of last connect attempt
local_host_port
integer
Localhost Port used by the Looker instance to connect to the remote DB
database_host
string
Hostname or IP Address of the Database Server
database_port
integer
Port that the Database Server is listening on
status
string
Current connection status for this Tunnel

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-09 UTC.