Vlans
Create a new VLAN
Creates a VLAN scoped to a network. VLAN numbers must be unique within a network.
Authorization<token>
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Request Body
application/json
name*string
Human-facing name for this VLAN.
network_id*string
The network this entity belongs to.
Format
uuidorganization_id*string
The organization that owns this record.
Format
uuidvlan_number*integer
The 802.1Q VLAN number (1-4094)
Format
int32Range
0 <= valuedescription?string|null
Free-text notes about the VLAN.
source?||||
How this VLAN came to be known — discovered, imported, or created by hand.
subnet_ids?array<string>
Subnets associated with this VLAN, derived from discovered interface
native-VLAN data via the subnet_vlans junction. Hydrated by
VlanService on read; it is not a column on vlans, so anything sent
here on create/update is ignored by to_params.
Response Body
application/json
application/json
application/json
curl -X POST "https://app.scanopy.net/api/v1/vlans" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3", "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6", "vlan_number": 0 }'{
"meta": {
"api_version": 1,
"server_version": "0.17.7"
},
"success": true,
"data": {
"name": "string",
"network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"vlan_number": 0,
"description": "string",
"source": {
"type": "Manual"
},
"subnet_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z",
"first_discovery_id": "6902465b-102c-46e4-8f8c-33ac44cf66e9",
"last_discovery_id": "48da132e-8b2a-4a5e-9c95-ecca249347f8",
"last_seen_at": "2019-08-24T14:15:22Z",
"lineage_id": "29b62bee-90fd-477a-963b-7a89d5ffca9a",
"valid_from": "2019-08-24T14:15:22Z",
"valid_to": "2019-08-24T14:15:22Z"
},
"error": "string"
}{
"meta": {
"api_version": 1,
"server_version": "0.17.7"
},
"success": true,
"code": "string",
"error": "string",
"params": {
"property1": null,
"property2": null
}
}{
"meta": {
"api_version": 1,
"server_version": "0.17.7"
},
"success": true,
"code": "string",
"error": "string",
"params": {
"property1": null,
"property2": null
}
}