Validate Tunnel Config

Validate UEM Tunnel Config

Request

URI

POST

https://{api_host}/api/ztnad/v1/enterprises/{enterpriseLogicalId}/validate

COPY

Path Parameters

string

enterpriseLogicalId

Required

Enterprise Logical ID

Request Body

validateTunnelConfigBody of type(s) application/json

Required

{
    "dnsName": "something.ra.velocloud.net",
    "workspaceOneOrg": "sample-workspaceOneOrg",
    "workspaceOneUrl": "sample.vmware.com",
    "workspaceOneUsername": "username",
    "workspaceOnePassword": "password",
    "doTunnelConfig": false
}

string

dnsName

Required

dnsName

string

workspaceOneOrg

Required

workspaceOneOrg

string

workspaceOneUrl

Required

workspaceOneUrl

string

workspaceOneUsername

Required

workspaceOneUsername

string

workspaceOnePassword

Required

workspaceOnePassword

boolean

doTunnelConfig

Required

doTunnelConfig

Responses

200

Returns validateTunnelConfigResponse of type(s) application/json

{
    "valid": false,
    "message": "string"
}

boolean

valid

Required

valid

string

message

Required

message

400

Invalid Input

Returns httpResponseError of type(s) application/json

{
    "code": "INVALID_CONFIG",
    "errors": [
        {
            "message": "error message",
            "path": "object.path",
            "key": "text"
        }
    ]
}

string

code

Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_CONFIG, HEALTHCHECK_UNAVAILABLE,

array of object

errors

Required

errors

500

Internal Server Error

Returns httpResponseError of type(s) application/json

{
    "code": "INVALID_CONFIG",
    "errors": [
        {
            "message": "error message",
            "path": "object.path",
            "key": "text"
        }
    ]
}

string

code

Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_CONFIG, HEALTHCHECK_UNAVAILABLE,

array of object

errors

Required

errors

On This Page

Description

Request