---
title: "Get SD-WAN Config by ID"
method: GET
path: "/v1/sd-wan-configs/{id}"
---

# Get SD-WAN Config by ID

`GET /v1/sd-wan-configs/{id}`

## Request

- Base URL: `https://api.ui.com`
- URL: `https://api.ui.com/v1/sd-wan-configs/{id}`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api/docs/v1/sd-wan-configs/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves detailed information about a specific SD-WAN configuration by ID.

## Path parameters

- `id` string, required

## Response `200`

200

- object
  - `data` object, nullable: Generic response data, specific schema depends on the endpoint
    - `id` string: Unique identifier of the SD-WAN config
    - `name` string: Name of the SD-WAN config
    - `type` string: Type of SD-WAN config - Currently only supports sdwan-hbsp
    - `variant` string: Variant of SD-WAN configuration
    - `settings` object: Advanced settings
      - `hubsInterconnect` boolean, nullable
      - `spokeToHubTunnelsMode` string
      - `spokesAutoScaleAndNatEnabled` boolean: Auto-assigns subnet and routes; otherwise, users enter them manually.
      - `spokesAutoScaleAndNatRange` string, nullable: Subnet in CIDR format, Example: 172.16.0.0/12
      - `spokesIsolate` boolean: Setting for NET: Spokes can reach hubs but not other spokes.
      - `spokeStandardSettingsEnabled` boolean: Enable spoke standard settings
      - `spokeStandardSettingsValues` object, nullable: Spoke standard settings
        - `primaryWan` string, nullable: Example: 'WAN'
        - `wanFailover` boolean, nullable: Use fail over WAN.
      - `spokeToHubRouting` string, nullable
    - `hubs` object[]
      - `id` string
      - `hostId` string
      - `siteId` string
      - `networkIds` string[]: Ids of networks belonging to the hub
      - `routes` string[]: Subnets in CIDR format: 10.0.0.0/24
      - `primaryWan` string: Example: 'WAN'
      - `wanFailover` boolean: Use fail over WAN.
    - `spokes` object[]
      - `id` string
      - `hostId` string
      - `siteId` string
      - `networkIds` string[]: Ids of networks belonging to the spoke
      - `routes` string[]: Subnets in CIDR format: 10.0.0.0/24
      - `primaryWan` string: Example: 'WAN'
      - `wanFailover` boolean: Use fail over WAN.
      - `hubsPriority` string[]: Non-null for distributed topology and spokeToHubRouting=custom
  - `httpStatusCode` integer: HTTP status code
  - `traceId` string: Request trace identifier

## Other responses

- `401`: 401
- `404`: 404
- `429`: 429
- `500`: 500
- `502`: 502

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api/revisions/16daa37f17c9?raw)