Get Element WAN Interface Status (v2.1)

GET 
/v2.1/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/waninterfaces/:wan_interface_id/state

Get the status of the elemant WAN interface.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

ID of the site. More details on the site can be retrieved by querying the sites API.

element_id stringrequired

ID of the element.

wan_interface_id stringrequired

ID of the WAN interface.

Responses

200

Successful Operation

application/json

Schema

Schema

disabled boolean

List the element wan interfaces in a disabled state.

disabled_reason string

List the reason for the disabled state.

element_id string

Element Id

id string

The ID.

inactive boolean

Inactive

inactive_reason string

List the reason for inactive state.

operational boolean

List the element wan interfaces that are operational.

region string

List the region of the element.

site_id stringrequired

The ID of the site.

site_wan_interface_id string

The ID of the site wan interface.

tenant_id stringrequired

Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)

Example (from schema)

{
  "disabled": true,
  "disabled_reason": "string",
  "element_id": "string",
  "id": "string",
  "inactive": true,
  "inactive_reason": "string",
  "operational": true,
  "region": "string",
  "site_id": "string",
  "site_wan_interface_id": "string",
  "tenant_id": "string"
}

Loading...