Skip to main content
POST
Look up Eligible Gateways for Failover

Authorizations

Authorization
string
header
required

Enter your JWT in the format: Bearer

Path Parameters

site_id
string<uuid>
required

The unique identifier for the site.

Example:

"9c69345c-8d39-4786-9f17-8153c988c89a"

Body

application/json
interface
string
required

The name of the interface on the router to query.

Example:

"ether1-wan"

Response

A list of potential gateway IP addresses for the interface.

gateway
string<ipv4>

A potential gateway IP address.

Example:

"198.51.100.1"

is_dhcp
boolean

Indicates if the gateway is likely assigned via DHCP.

Example:

false