Get Ras By Enterprise
Get Secure Access Services by Enterprise logicalId
Request
URI
GET
https://{api_host}/api/ztnad/v1/enterprises/{enterpriseLogicalId}/ras
COPY
Path Parameters
string
enterpriseLogicalId
Required
Enterprise Logical ID
Responses
200
Secure Access Services
Returns getRasByEnterpriseResponse of type(s) application/json
{
"_href": "/enterprises/1/ras",
"services": [
{
"_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
array of object
services
Required
services
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