Create SSH Tunnel

Version 4.0.24.6 (latest)

Create an SSH Tunnel

Request

POST /ssh_tunnels
Datatype
Description
Request
HTTP Request
body
HTTP Body
Expand HTTP Body definition...
body
SSH Tunnel
Expand SshTunnel definition...
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

Response

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

409: Resource Already Exists

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

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

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