Get Ras By Logical Id
Get Secure Access Services by logicalId
Request
URI
GET
https://{api_host}/api/ztnad/v1/enterprises/{enterpriseLogicalId}/ras/{logicalId}
COPY
Path Parameters
string
enterpriseLogicalId
Required
Enterprise Logical ID
string
logicalId
Required
Secure Access Service LogicalId
Responses
200
Secure Access Service
Returns getRasResponse of type(s) application/json
{
"_href": "/enterprises/1/ras/7e5b6baa-e5fa-4272-ba4c-5f1941235584",
"id": 1,
"logicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
"enterpriseObjectId": "number",
"name": "sample-service",
"description": "text",
"tags": [
"string"
],
"enterpriseId": "number",
"enterpriseLogicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
"dnsName": "something.ra.velocloud.net",
"workspaceOneOrg": "sample-workspaceOneOrg",
"workspaceOneUrl": "sample.vmware.com",
"doTunnelConfig": false,
"enterpriseDnsObjectId": "number",
"enterpriseDnsObjectName": "something.ra.velocloud.net",
"segmentId": "number",
"segmentLogicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
"vniId": "number",
"customerCidr": "192.168.2.1/24",
"numberOfBits": "number",
"cws": {
"enable": false,
"policyId": 1,
"policyName": "text"
},
"popList": [
{
"name": "text",
"logicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
"gatewaysList": [
{
"vcoLogicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
"vcoGatewayLogicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
"ipAddress": "192.168.2.1",
"endpointIpAddress": "192.168.2.1",
"name": "text"
}
]
}
],
"gatewaysList": [
{
"vcoLogicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
"vcoGatewayLogicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c82",
"ipAddress": "192.168.2.1",
"endpointIpAddress": "192.168.2.1",
"name": "text"
}
],
"status": "string",
"modified": "2020-07-18T15:48:18.000Z",
"created": "2020-07-18T15:48:18.000Z"
}string
_href
Required
_href
integer
id
Required
id
string
logicalId
Required
logicalId
number As float As float
enterpriseObjectId
Required
enterpriseObjectId
string As ^[a-zA-Z0-9]*$
name
Required
name
string
description
Required
description
array of string
tags
Required
tags
number As float As float
enterpriseId
Required
enterpriseId
string
enterpriseLogicalId
Required
enterpriseLogicalId
string
dnsName
Required
dnsName
string
workspaceOneOrg
Required
workspaceOneOrg
string
workspaceOneUrl
Required
workspaceOneUrl
boolean
doTunnelConfig
Required
doTunnelConfig
number As float As float
enterpriseDnsObjectId
Required
enterpriseDnsObjectId
string
enterpriseDnsObjectName
Optional
enterpriseDnsObjectName
number As float As float
segmentId
Required
segmentId
string
segmentLogicalId
Required
segmentLogicalId
number As float As float
vniId
Required
vniId
string
customerCidr
Required
customerCidr
number As float As float
numberOfBits
Required
numberOfBits
object
cws
Optional
cws
array of object
popList
Required
popList
array of object
gatewaysList
Required
gatewaysList
string
status
Required
status
Possible values are : CREATE_BEGAN, UPDATE_BEGAN, DELETE_BEGAN, SERVICE_UP, CREATE_TUNNEL_CONFIG_IN_PROGRESS, CREATE_TUNNEL_CONFIG_COMPLETED, CREATE_TUNNEL_CONFIG_FAILED, DEPLOY_TUNNEL_POD_IN_PROGRESS, DEPLOY_TUNNEL_POD_FAILED, DELETE_TUNNEL_POD_IN_PROGRESS, DELETE_TUNNEL_POD_COMPLETED, DELETE_TUNNEL_POD_FAILED, DELETE_TUNNEL_CONFIG_IN_PROGRESS, DELETE_TUNNEL_CONFIG_FAILED,
string
modified
Required
modified
string
created
Required
created
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
404
Secure Access Service not found
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