Skip to main content

Get an SD-WAN interface profile

GET 
/sdwan-interface-profiles/:id

Get an existing SD-WAN interface profile.

Request​

Path Parameters

    id uuidrequired

    The UUID of the configuration resource

Responses​

OK

Schema
    oneOf
    folder stringrequired

    Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

    The folder in which the resource is defined

    id string

    UUID of the resource

    name stringrequired

    Possible values: <= 31 characters, Value must match regular expression ^[0-9a-zA-Z._-]+$

    Name of the interface profile

    comment string

    Possible values: <= 1023 characters

    The description of the interface profile

    link_tag string

    Possible values: <= 31 characters

    The link tag of the interface profile

    link_type string

    Possible values: [ADSL/DSL, Cablemodem, Ethernet, Fiber, LTE/3G/4G/5G, MPLS, Microwave/Radio, Satellite, WiFi, Private1, Private2, Private3, Private4, Other]

    Default value: Ethernet

    The type of link

    vpn_data_tunnel_support boolean

    Enable data traffic over VPN?

    maximum_download integer

    Possible values: <= 100000

    Maximum download capacity in Mbps

    maximum_upload integer

    Possible values: <= 100000

    Maximum upload capacity in Mbps

    error_correction boolean

    Allow this interface for FEC / Packet Duplication

    path_monitoring string

    Possible values: [Aggressive, Relaxed]

    Path monitoring profile

    vpn_failover_metric integer

    Possible values: >= 1 and <= 65535

    Metric for vpn tunnels on this interface

    probe_frequency integer

    Possible values: >= 1 and <= 5

    Number of probes sent per second

    probe_idle_time integer

    Possible values: >= 1 and <= 86400

    Idle time in seconds when no probes are sent

    failback_hold_time integer

    Possible values: >= 20 and <= 120

    Failback hold time in seconds before reverting session to original path

Loading...