Get Service Endpoint List (v2.4)
GET/v2.4/api/tenants/:tenant_id/serviceendpoints
List all the servie endpoints.
Request
Path Parameters
ID of the tenant.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- ]
- ]
The actual count.
The ID.
The tenant ID.
items ServiceEndpointV2N4[]
address Address
The address of the endpoint location.
The name of the city. Max size = 100.
The name of the country. Max size = 100.
The postal code. Max size = 100.
The name of the state. Max size = 100.
The name of the street. Max size = 100.
The name of the street. Max size = 100.
All data center sites are automatically added when Admin Up is selected, which means that it can accept traffic per network policy. If not selected, the endpoint is not used in path selection for forwarding traffic.
Explicitly allow enterprise traffic to transit through the cloud security service.
The description of the service endpoint. Max size = 256.
Disable tunnel reoptimization. True or False.
The ID of the service endpoint.
liveliness_probe SEPLivelinessProbeV2N2
The information on liveliness probing.
http HttpProbe[]
The values for probing interval, failure count, HTTP status codes, and URL.
The HTTP failure count interval. Must be between 3 to 300 seconds.
The HTTP status codes. Maximum 8 status codes can be specified.
The HTTP probe interval. Must be between 3 to 3600 seconds.
The HTTP probe URL. Max size = 1024.
icmp_ping IcmpPingProbe[]
The values for probing interval, failure count, and IP address.
The ICMP failure count interval. Must be between 3 to 300 seconds.
The ICMP probe interval. Must be between 1 to 30 seconds.
The ICMP probe addresses. Maximum 8 addresses can be specified.
location Location
The service endpoint label representing a specific location.
The decsription of the location.
The latitude of the location. Max range = 90.
The longitude of the location. Max range = 180.
The name of the service endpoint. Max size = 128.
sase_properties SaseServiceEndpointProperties
The sase service endpoint properties.
Active
Lqm Enabled
service_link_peers ServiceLinkPeers
The value of the hostname and IP addresses.
The hostnames of the service link peers. Max size = 128.
The addresses of the service link peers. Max size = 128.
The site ID.
A information field that can be added to identify the service endpoint. Maximum 10 unique tags of length 1024 each are allowed.
Possible values: [CG_TRANSIT
, NON_CG_TRANSIT
, SASE
]
The network service type.
{
"count": 0,
"id": "string",
"tenant_id": "string",
"items": [
{
"address": {
"city": "string",
"country": "string",
"post_code": "string",
"state": "string",
"street": "string",
"street2": "string"
},
"admin_up": true,
"allow_enterprise_traffic": true,
"disable_tunnel_reoptimization": true,
"id": "string",
"liveliness_probe": {
"http": [
{
"failure_count": 0,
"http_status_codes": [
0
],
"interval": 0,
"url": "string"
}
],
"icmp_ping": [
{
"failure_count": 0,
"interval": 0,
"ip_addresses": [
"string"
]
}
]
},
"location": {
"latitude": 0,
"longitude": 0
},
"name": "string",
"sase_properties": {
"active": true,
"lqm_enabled": true
},
"service_link_peers": {
"hostnames": [
"string"
],
"ip_addresses": [
"string"
]
},
"site_id": "string",
"tags": [
"string"
],
"type": "CG_TRANSIT"
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_JSON"
}
]
}
}