Query DB for Service Bindings (v2.4)

POST 
/sdwan/v2.4/api/serviceendpoints/query

Query the DB for limit number of service bindings that match the query parameters.

Request

application/json

Body

Service Endpoint

address Address

The address of the endpoint location.

city string

The name of the city. Max size = 100.

country string

The name of the country. Max size = 100.

post_code string

The postal code. Max size = 100.

state string

The name of the state. Max size = 100.

street string

The name of the street. Max size = 100.

street2 string

The name of the street. Max size = 100.

admin_up booleanrequired

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.

allow_enterprise_traffic boolean

Explicitly allow enterprise traffic to transit through the cloud security service.

description

The description of the service endpoint. Max size = 256.

disable_tunnel_reoptimization boolean

Disable tunnel reoptimization. True or False.

id string

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.
Array [
failure_count integerrequired
The HTTP failure count interval. Must be between 3 to 300 seconds.
http_status_codes integer[]
The HTTP status codes. Maximum 8 status codes can be specified.
interval integerrequired
The HTTP probe interval. Must be between 3 to 3600 seconds.
url stringrequired
The HTTP probe URL. Max size = 1024.
]
icmp_ping IcmpPingProbe[]
The values for probing interval, failure count, and IP address.
Array [
failure_count integerrequired
The ICMP failure count interval. Must be between 3 to 300 seconds.
interval integerrequired
The ICMP probe interval. Must be between 1 to 30 seconds.
ip_addresses string[]required
The ICMP probe addresses. Maximum 8 addresses can be specified.
]
location Location

The service endpoint label representing a specific location.

description

The description of the location.

latitude float

The latitude of the location. Max range = 90.

longitude float

The longitude of the location. Max range = 180.

name stringrequired

The name of the service endpoint. Max size = 128.

sase_properties SaseServiceEndpointProperties

The sase service endpoint properties.

active boolean

Active

lqm_enabled boolean

Lqm Enabled

service_link_peers ServiceLinkPeers

The value of the hostname and IP addresses.

hostnames string[]

The hostnames of the service link peers. Max size = 128.

ip_addresses string[]

The addresses of the service link peers. Max size = 128.

site_id string

The site ID.

tags string[]

A information field that can be added to identify the service endpoint. Maximum 10 unique tags of length 1024 each are allowed.

type stringrequired

Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]

The network service type.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

Description of the query. Max size = 256.

id string

The ID.

next_query object

Details of the next query.

total_count int64

Total number.

items ServiceEndpointV2N4[]
Array [
address Address
The address of the endpoint location.
city string
The name of the city. Max size = 100.
country string
The name of the country. Max size = 100.
post_code string
The postal code. Max size = 100.
state string
The name of the state. Max size = 100.
street string
The name of the street. Max size = 100.
street2 string
The name of the street. Max size = 100.
admin_up booleanrequired
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.
allow_enterprise_traffic boolean
Explicitly allow enterprise traffic to transit through the cloud security service.
description
The description of the service endpoint. Max size = 256.
disable_tunnel_reoptimization boolean
Disable tunnel reoptimization. True or False.
id string
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.
Array [
failure_count integerrequired
The HTTP failure count interval. Must be between 3 to 300 seconds.
http_status_codes integer[]
The HTTP status codes. Maximum 8 status codes can be specified.
interval integerrequired
The HTTP probe interval. Must be between 3 to 3600 seconds.
url stringrequired
The HTTP probe URL. Max size = 1024.
]
icmp_ping IcmpPingProbe[]
The values for probing interval, failure count, and IP address.
Array [
failure_count integerrequired
The ICMP failure count interval. Must be between 3 to 300 seconds.
interval integerrequired
The ICMP probe interval. Must be between 1 to 30 seconds.
ip_addresses string[]required
The ICMP probe addresses. Maximum 8 addresses can be specified.
]
location Location
The service endpoint label representing a specific location.
description
The description of the location.
latitude float
The latitude of the location. Max range = 90.
longitude float
The longitude of the location. Max range = 180.
name stringrequired
The name of the service endpoint. Max size = 128.
sase_properties SaseServiceEndpointProperties
The sase service endpoint properties.
active boolean
Active
lqm_enabled boolean
Lqm Enabled
service_link_peers ServiceLinkPeers
The value of the hostname and IP addresses.
hostnames string[]
The hostnames of the service link peers. Max size = 128.
ip_addresses string[]
The addresses of the service link peers. Max size = 128.
site_id string
The site ID.
tags string[]
A information field that can be added to identify the service endpoint. Maximum 10 unique tags of length 1024 each are allowed.
type stringrequired
Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]
The network service type.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "total_count": 0,
  "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"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "BAD_REQUEST"
      }
    ]
  }
}

Loading...