List VLANs
Returns VLANs accessible to the authenticated user, optionally filtered by site.
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Query Parameters
Primary ordering field (used for grouping). Always sorts ASC to keep groups together.
Secondary ordering field (sorting within groups or standalone sort).
Direction for order_by field (group_by always uses ASC).
Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.
Number of results to skip. Default: 0.
Filter by site ID. Repeat the parameter to pass several.
Filter by how the VLAN came to exist (source.type). Repeat for several.
Filter to VLANs linked to one of these subnets. Repeat for several.
Filter by tag IDs (returns VLANs that have ANY of the specified tags)
Tag sets the VLAN must hold one tag from each of. Each entry is a comma-separated list of tag ids. One entry per tag group the list is filtered by.
Group by the tag each row holds from this tag group. Takes the place of group_by.
Sort by the position of the tag each row holds from this tag group. Takes the place of
order_by.
As-of timestamp (ISO 8601). When set, returns SCD2 state as of this instant (snapshot view) instead of live state.
Free-text search. Case-insensitive substring match against the VLAN ID, name and description.
Response Body
application/json
curl -X GET "https://example.com/api/v1/vlans"{
"data": [
{
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
"tags": [
"a424dc99-d215-4281-ad2d-a3a9bc179925"
],
"vlan_number": 0,
"description": "string",
"interface_ids": [
"513ddd9b-363c-404c-8d2f-e4772a6284ee"
],
"name_source": "Unspecified",
"source": {
"type": "Manual"
},
"subnet_ids": [
"942824b1-f36d-4404-96ac-b099828cf934"
],
"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"
}
],
"meta": {
"api_version": 1,
"pagination": {
"has_more": true,
"limit": 50,
"offset": 0,
"total_count": 142
},
"server_version": "0.19.6"
},
"success": true,
"error": "string"
}Product names and logos are trademarks of their respective owners. See credits.