Register Tunnel

Register Tunnel

This request configures the service to use the given Tunneling Service API endpoint.

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

Operation ID for correlating logs across multiple services

Request Body
RegisterTunnelServiceRequest of type(s) application/json
Required 
{
    "certificate": "MIIDb...",
    "rootPassword": "rootpassword",
    "url": "https://tunneladdress:8047/"
}
string
certificate
Optional

Base64-encoded certificate of the Tunnel service API endpoint.

string
rootPassword
Optional

The root password for the appliance where the Tunnel instance is running.

string
url
Optional

The API URL of the Tunnel instace.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TunnelApiEndpoint of type(s) application/json;charset=UTF-8 
{
    "certificate": "MIIDb...",
    "id": "58ae326f-29bc-4c0c-b00a-95c5f91c5586",
    "url": "https://tunneladdress:8047/"
}
string
certificate
Optional

Base-64 encoded certificate of the tunnel.

string
id
Optional

ID of the tunnel.

string
url
Optional

URL pointing to the API endpoint of the tunnel.


401

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

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+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.7+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