API Reference

Magic Transit

Sites

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

WANs

List Site WANs

client.magicTransit.sites.wans.list(stringsiteID, WANListParams { account_id } params, RequestOptionsoptions?): SinglePage<WAN { id, health_check_rate, name, 5 more } >

GET/accounts/{account_id}/magic/sites/{site_id}/wans

Site WAN Details

client.magicTransit.sites.wans.get(stringwanID, WANGetParams { account_id, site_id } params, RequestOptionsoptions?): WAN { id, health_check_rate, name, 5 more }

GET/accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}

Create a new Site WAN

client.magicTransit.sites.wans.create(stringsiteID, WANCreateParams { account_id, physport, name, 3 more } params, RequestOptionsoptions?): SinglePage<WAN { id, health_check_rate, name, 5 more } >

POST/accounts/{account_id}/magic/sites/{site_id}/wans

Update Site WAN

client.magicTransit.sites.wans.update(stringwanID, WANUpdateParams { account_id, site_id, name, 4 more } params, RequestOptionsoptions?): WAN { id, health_check_rate, name, 5 more }

PUT/accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}

Patch Site WAN

client.magicTransit.sites.wans.edit(stringwanID, WANEditParams { account_id, site_id, name, 4 more } params, RequestOptionsoptions?): WAN { id, health_check_rate, name, 5 more }

PATCH/accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}

Delete Site WAN

client.magicTransit.sites.wans.delete(stringwanID, WANDeleteParams { account_id, site_id } params, RequestOptionsoptions?): WAN { id, health_check_rate, name, 5 more }

DELETE/accounts/{account_id}/magic/sites/{site_id}/wans/{wan_id}

ModelsExpand Collapse

WAN { id, health_check_rate, name, 5 more }

id?: string

Identifier

maxLength32

health_check_rate?: "low" | "mid" | "high"

Magic WAN health check rate for tunnels created on this link. The default value is mid.

One of the following:

"low"

"mid"

"high"

name?: string

physport?: number

priority?: number

Priority of WAN for traffic loadbalancing.

site_id?: string

Identifier

maxLength32

static_addressing?: WANStaticAddressing { address, gateway_address, secondary_address }

(optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.

vlan_tag?: number

VLAN ID. Use zero for untagged.

WANStaticAddressing { address, gateway_address, secondary_address }

(optional) if omitted, use DHCP. Submit secondary_address when site is in high availability mode.

address: string

A valid CIDR notation representing an IP range.

gateway_address: string

A valid IPv4 address.

secondary_address?: string

A valid CIDR notation representing an IP range.