Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /staged_config/deployment/hosts/{id}/tunnels

Gets the list of tunnels for the host.

Gets the list of staged tunnels for the staged host.

Table 1: GET /staged_config/deployment/hosts/{id}/tunnels Resource Details

MIME Type

application/json

Table 2: GET /staged_config/deployment/hosts/{id}/tunnels Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

id

path

Required

Number (Integer)

text/plain

Required - The ID of the staged host.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3: GET /staged_config/deployment/hosts/{id}/tunnels Response Codes

HTTP Response Code

Unique Code

Description

200

 

A list of SSH tunnels. This will list all tunnels currently in the system for the staged host.

404

1009

Host id provided is invalid.

422

1010

Invalid host_id provided.

Response Description

A list of SSH tunnels. This will list all tunnels currently in the system for the deployed host. The Tunnel object has the following fields:

  • name - The name of the tunnel object.

  • remote_hostID - The host ID of the remote host of the tunnel.

  • remote_port - The port on the remote host that is used by the tunnel.

  • local_port - The port on the originating host that is used by the tunnel.

  • reverse_source - Set this value to true to initiate the tunnel on the remote host instead of the originating host. This has no effect if either the originating or the remote host is a console.

Response Sample