ScanopyScanopy
Vlans

Bulk upsert VLANs from discovery

Used by daemons to report discovered VLANs. Creates new VLANs or updates names. Returns the mapping of VLAN numbers to entity UUIDs for Interface construction.

POST
/api/v1/vlans/discovery

Authorization

daemon_api_key
Authorization<token>

Daemon API key (Bearer scp_d_...). Requires X-Daemon-ID header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for daemon VLAN discovery upsert

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/vlans/discovery" \  -H "Content-Type: application/json" \  -d '{    "network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3",    "vlans": [      {        "name": "string",        "vlan_number": 0      }    ]  }'
{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.17"
  },
  "success": true,
  "data": {
    "vlans": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "vlan_number": 0
      }
    ]
  },
  "error": "string"
}
{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.17"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}