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.5"
  },
  "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": "6ad8ac61-1ec0-4d0f-b487-c2b24003e274",
              "rule": {
                "ByApplication": {
                  "tag_ids": []
                }
              }
            }
          ],
          "L2Physical": [
            {
              "id": "f4521ed8-af41-4e71-9424-fd58d16c92cd",
              "rule": "ByHost"
            }
          ],
          "L3Logical": [
            {
              "id": "102e6ed6-f80f-4816-99a4-a13e3ff57309",
              "rule": "BySubnet"
            },
            {
              "id": "a6e55f78-4a93-4c82-b948-48271f08a73a",
              "rule": "MergeContainerBridges"
            }
          ],
          "Workloads": [
            {
              "id": "f4521ed8-af41-4e71-9424-fd58d16c92cd",
              "rule": "ByHost"
            }
          ]
        },
        "element_rules": [
          {
            "id": "5962e9d5-77f1-4740-ae17-3c40a6a2de07",
            "rule": "ByTrunkPort"
          },
          {
            "id": "22ee2610-f428-4720-93b2-61461839ea1f",
            "rule": "ByVLAN"
          },
          {
            "id": "6ee38b1b-eba3-4178-a2c7-44f6f743b44d",
            "rule": "ByPortOpStatus"
          },
          {
            "id": "571c14da-e052-46d0-83cb-4e9e45624892",
            "rule": {
              "ByServiceCategory": {
                "categories": [
                  "NetworkCore",
                  "NetworkAccess",
                  "RemoteAccess",
                  "Workstation",
                  "Mobile",
                  "Printer",
                  "OpenPorts"
                ],
                "is_infra_rule": true,
                "title": "Infrastructure"
              }
            }
          },
          {
            "id": "6ba9679a-d437-4770-8652-348f2c0822e1",
            "rule": {
              "ByTag": {
                "tag_ids": [],
                "title": null
              }
            }
          },
          {
            "id": "89be9dd3-e827-47ec-9133-9a0815547897",
            "rule": "ByHypervisor"
          },
          {
            "id": "989e0944-d805-46bb-8b00-11e9dba542d3",
            "rule": "ByContainerRuntime"
          },
          {
            "id": "204d6ef7-988c-4d79-9e34-7c7d9b7f4952",
            "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.5"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}