Documentation

SD-WAN · API

API reference

Manage SD-WAN programmatically — list sites and transports, read health and telemetry, publish steering and QoS policies, and subscribe to link and SLA events via webhooks.

The SD-WAN API lets you automate site management and pull telemetry into your own tools. It shares the platform's authentication and conventions — see the Developers space for auth, pagination, and rate limits.

Base URL & auth

Base URL:  https://api.intsignal.com/sd-wan/v1
Auth:      Authorization: Bearer <API_KEY>

Create an API key with SD-WAN scopes (sdwan:read, sdwan:write) in the Network Portal.

Sites & transports

Method & pathPurpose
GET /sitesList sites with status and role.
GET /sites/{id}Site detail, including transports and segments.
POST /sitesCreate a site (pre-stage for ZTP).
GET /sites/{id}/transportsList a site's circuits.
POST /sites/{id}/transportsAdd a circuit.

Telemetry

curl "https://api.intsignal.com/sd-wan/v1/sites/site_123/health?window=1h" \
  -H "Authorization: Bearer $API_KEY"
{
  "site": "site_123",
  "status": "up",
  "transports": [
    { "name": "fiber", "latency_ms": 11, "loss_pct": 0.0, "jitter_ms": 2 },
    { "name": "lte",   "latency_ms": 38, "loss_pct": 0.3, "jitter_ms": 6 }
  ],
  "sla": [{ "class": "real-time", "target_met": true }]
}

Policies

Method & pathPurpose
GET /policiesList steering and QoS policies with versions.
POST /policies/{id}/publishPublish a policy to its sites (change-managed).

Webhooks

Subscribe in Settings → Webhooks to react to network events:

  • transport.degraded / transport.down
  • site.offline
  • sla.breach
  • path.switched

Payloads are signed; verify them as described in webhooks.

Note

Policy publishes are recorded in change management just like Portal changes, so an automated push has the same audit trail as a manual one.

Need a hand with SD-WAN?Talk to our team →