Topologies
Get all topologies for the authenticated user's networks.
Returns both live-view rows (snapshot_id IS NULL) and snapshot-pinned
rows. The frontend renders the live one by default and renders snapshot
rows when the user picks one from the snapshots dropdown.
Authorization<token>
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Query Parameters
network_id?string|null
Filter by network ID
Format
uuidids?|null
Filter by specific entity IDs (for selective loading)
limit?integer|null
Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.
Format
int32Range
0 <= value <= 1000offset?integer|null
Number of results to skip. Default: 0.
Format
int32Range
0 <= valueResponse Body
application/json
curl -X GET "https://app.scanopy.net/api/v1/topology"{
"data": [
{
"network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3",
"options": {
"local": {
"bundle_edges": true,
"hide_edge_types": [
"Hypervisor"
],
"no_fade_edges": false,
"show_minimap": true,
"tag_filter": {
"hidden_host_tag_ids": [],
"hidden_service_tag_ids": [],
"hidden_subnet_tag_ids": []
}
},
"request": {
"container_rules": {
"Application": [
{
"id": "d1ea742c-8015-4ba1-84e1-f593c1ce8935",
"rule": {
"ByApplication": {
"tag_ids": []
}
}
}
],
"L2Physical": [
{
"id": "d2a2058d-3504-4cbd-bc18-2b5a6e6d39fc",
"rule": "ByHost"
}
],
"L3Logical": [
{
"id": "ae803c11-0a86-49f1-bcdd-c68dfbaa91ec",
"rule": "BySubnet"
},
{
"id": "b7aded30-27fa-4eb4-b4a4-8e0ca04f3f19",
"rule": "MergeContainerBridges"
}
],
"Workloads": [
{
"id": "d2a2058d-3504-4cbd-bc18-2b5a6e6d39fc",
"rule": "ByHost"
}
]
},
"element_rules": [
{
"id": "0242432d-a5f4-49b8-8df4-0c0ce7d71d59",
"rule": "ByTrunkPort"
},
{
"id": "5dbb183f-a550-4dfe-8e8d-e60a65a9cebb",
"rule": "ByVLAN"
},
{
"id": "eb395d22-5753-4d37-9216-ca1b09434a27",
"rule": "ByPortOpStatus"
},
{
"id": "53609ccc-5b30-4a6c-8101-5815e8b6ef7b",
"rule": {
"ByServiceCategory": {
"categories": [
"NetworkCore",
"NetworkAccess",
"RemoteAccess",
"Workstation",
"Mobile",
"Printer",
"OpenPorts"
],
"is_infra_rule": true,
"title": "Infrastructure"
}
}
},
{
"id": "06d70837-bf0d-4092-8132-ed40e842b4bb",
"rule": {
"ByTag": {
"tag_ids": [],
"title": null
}
}
},
{
"id": "f9e3bd25-4f65-4be4-8a11-48d4a650d0c9",
"rule": "ByHypervisor"
},
{
"id": "b4c32324-3658-4d37-bc56-0df832d8e5f0",
"rule": "ByContainerRuntime"
},
{
"id": "a900d45b-a7c9-4fea-9c33-83dc631e9228",
"rule": "ByStack"
}
],
"hide_entities": {},
"hide_metadata_values": {
"Application": {
"Service": {
"Category": [
"OpenPorts"
]
}
},
"L2Physical": {
"Service": {
"Category": [
"OpenPorts"
]
}
},
"L3Logical": {
"Service": {
"Category": [
"OpenPorts"
]
}
},
"Workloads": {
"Service": {
"Category": [
"OpenPorts"
]
}
}
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"meta": {
"api_version": 1,
"pagination": {
"has_more": true,
"limit": 50,
"offset": 0,
"total_count": 142
},
"server_version": "0.17.7"
},
"success": true,
"error": "string"
}