ScanopyScanopy
Topologies

Get Topology by ID

GET
/api/v1/topology/{id}

Authorization

Authorization<token>

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

In: header

Path Parameters

id*string

Topology ID

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/topology/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.14"
  },
  "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": "f2ccd7b0-ae8d-4ee4-ade1-001a5456ef27",
              "rule": {
                "ByApplication": {
                  "tag_ids": []
                }
              }
            }
          ],
          "L2Physical": [
            {
              "id": "85568638-5553-49a3-973f-d088761060bd",
              "rule": "ByHost"
            }
          ],
          "L3Logical": [
            {
              "id": "66cb8aef-ee56-4135-8f63-634d776166cd",
              "rule": "BySubnet"
            },
            {
              "id": "cc6f2864-f4e9-4dcd-8a20-1a3216958b29",
              "rule": "MergeContainerBridges"
            }
          ],
          "Workloads": [
            {
              "id": "85568638-5553-49a3-973f-d088761060bd",
              "rule": "ByHost"
            }
          ]
        },
        "element_rules": [
          {
            "id": "5cf4c1b8-4ec8-4736-bc24-333d64c70ea0",
            "rule": "ByTrunkPort"
          },
          {
            "id": "2ad724c1-5387-490a-8483-f25dab201cef",
            "rule": "ByVLAN"
          },
          {
            "id": "d7e18b51-c29a-472c-9dc2-821b6aa415fc",
            "rule": "ByPortOpStatus"
          },
          {
            "id": "2ffe6bfc-ece1-4eef-a24b-caf0030507c3",
            "rule": {
              "ByServiceCategory": {
                "categories": [
                  "NetworkCore",
                  "NetworkAccess",
                  "RemoteAccess",
                  "Workstation",
                  "Mobile",
                  "Printer",
                  "OpenPorts"
                ],
                "is_infra_rule": true,
                "title": "Infrastructure"
              }
            }
          },
          {
            "id": "28cd7291-2157-4daf-a05e-2d3070e51485",
            "rule": {
              "ByTag": {
                "tag_ids": [],
                "title": null
              }
            }
          },
          {
            "id": "bf9af5d6-ba3d-4867-94ed-662b8ea2057a",
            "rule": "ByHypervisor"
          },
          {
            "id": "4f042998-78e8-4d13-a040-65f315aa9771",
            "rule": "ByContainerRuntime"
          },
          {
            "id": "20a4e905-cf1e-4944-babc-ac6da7bbe967",
            "rule": "ByStack"
          }
        ],
        "hide_entities": {},
        "hide_metadata_values": {
          "Application": {
            "Service": {
              "Category": [
                "OpenPorts"
              ]
            }
          },
          "L2Physical": {
            "Interface": {
              "LinkState": [
                "Unlinked"
              ]
            },
            "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.14"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}