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 & path | Purpose |
|---|---|
GET /sites | List sites with status and role. |
GET /sites/{id} | Site detail, including transports and segments. |
POST /sites | Create a site (pre-stage for ZTP). |
GET /sites/{id}/transports | List a site's circuits. |
POST /sites/{id}/transports | Add 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 & path | Purpose |
|---|---|
GET /policies | List steering and QoS policies with versions. |
POST /policies/{id}/publish | Publish a policy to its sites (change-managed). |
Webhooks
Subscribe in Settings → Webhooks to react to network events:
transport.degraded/transport.downsite.offlinesla.breachpath.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.
