List Tunnel

List Tunnel

This request lists the registered Tunnel service instances.

Request
URI
GET
https://{api_host}//config/tunnels
COPY
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TunnelServicesResponse of type(s) application/json;charset=UTF-8 
{
    "tunnels": {
        "tunnels": [
            {
                "id": "91f729d0-8d37-45da-8648-a3fac9466119",
                "url": "https://10.71.249.18:8047/",
                "certificate": "MIID..."
            }
        ]
    }
}
array of TunnelApiEndpoint
tunnels
Optional

List of registered Tunnel service instances.


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Tunnels Operations
GET
List Tunnel
POST
Register Tunnel