Skip to main content

Delete Service Endpoint (v2.2)

DELETE 

/sdwan/v2.2/api/serviceendpoints/:service_endpoint_id

Delete a service endpoint.

Request

Path Parameters

    service_endpoint_id stringrequired

    The ID of the service endpoint.

Responses

Successful Operation

Schema
    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.

    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.

    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.

Loading...