ScanopyScanopy
Topologies

Get Topology by ID

GET
/api/v1/topology/{id}
Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Path Parameters

id*string

Topology ID

Formatuuid

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/topology/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.0"
  },
  "success": true,
  "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": "accb4571-8040-4416-95a4-170893dd14c2",
              "rule": {
                "ByApplication": {
                  "tag_ids": []
                }
              }
            }
          ],
          "L2Physical": [
            {
              "id": "3ca1eeb6-3be5-456d-a08d-6a28ed46ed36",
              "rule": "ByHost"
            }
          ],
          "L3Logical": [
            {
              "id": "fbbbbace-fbd3-42db-9400-64066efee762",
              "rule": "BySubnet"
            },
            {
              "id": "22092b97-7fc0-4a77-b677-415dab9d1cf8",
              "rule": "MergeDockerBridges"
            }
          ],
          "Workloads": [
            {
              "id": "3ca1eeb6-3be5-456d-a08d-6a28ed46ed36",
              "rule": "ByHost"
            }
          ]
        },
        "element_rules": [
          {
            "id": "8fff7251-1cef-4e78-8482-f09b01c5a8ad",
            "rule": "ByTrunkPort"
          },
          {
            "id": "add0ea45-1fdc-4baf-9982-085b5b2213f3",
            "rule": "ByVLAN"
          },
          {
            "id": "2013eb9b-1431-46d2-acd8-747552ffa3ce",
            "rule": "ByPortOpStatus"
          },
          {
            "id": "e4d4fd85-11fd-4a8a-ade3-dca73b5196a2",
            "rule": {
              "ByServiceCategory": {
                "categories": [
                  "NetworkCore",
                  "NetworkAccess",
                  "RemoteAccess",
                  "Workstation",
                  "Mobile",
                  "Printer",
                  "OpenPorts"
                ],
                "is_infra_rule": true,
                "title": "Infrastructure"
              }
            }
          },
          {
            "id": "a86cd791-3884-40a1-a0a4-df2e363511c4",
            "rule": {
              "ByTag": {
                "tag_ids": [],
                "title": null
              }
            }
          },
          {
            "id": "7223103c-5554-4e8f-b17a-5d074d2d86eb",
            "rule": "ByHypervisor"
          },
          {
            "id": "21eb37dd-680f-4bb1-a313-569b85067d46",
            "rule": "ByContainerRuntime"
          },
          {
            "id": "ff463e8f-6a20-4879-9409-78ca609a05d0",
            "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"
  },
  "error": "string"
}
{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.0"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}