ON THIS PAGE
GET /staged_config/deployment/hosts/{id}/tunnels
SUMMARY Gets the list of tunnels for the host.
Gets the list of staged tunnels for the staged host.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
id |
path |
Required |
Number (Integer) |
text/plain |
Required - The ID of the staged host. |
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. |
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. |
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
- 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
[ { "local_port": 42, "name": "String", "remote_host_id": 42, "remote_port": 42, "reverse_source": true } ]