SCscanopy
Topologies

Get topology by ID

Changed on
get/api/v1/topologies/{id}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/topologies/{id}
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

idstring uuid required

Topology ID

Response

Topology found

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • 60db2dbbed33Revision changes
    • warning

      added the new Confirmation enum value to the ////////// response property for the response status

    • info

      the response's property default value changed from {"Application":[{"id":"e2ea28a8-ab66-4f00-9cc0-9038c5c79d47","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"a665ec34-ca4a-40b7-982c-b31003a319ba","rule":"ByHost"}],"L3Logical":[{"id":"47177f84-3fda-46c7-b81b-008293b81188","rule":"BySubnet"},{"id":"eb47e951-9a71-4b3c-806d-63b5932efb95","rule":"MergeContainerBridges"}],"Workloads":[{"id":"a665ec34-ca4a-40b7-982c-b31003a319ba","rule":"ByHost"}]} to {"Application":[{"id":"8359cdc9-f787-4e3a-be29-36c093779516","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"8589acf6-db61-4360-a96f-1a5de1a70312","rule":"ByHost"}],"L3Logical":[{"id":"043869dd-efe5-40a6-a4db-2c504bc08dd2","rule":"BySubnet"},{"id":"10d6e863-9d9a-43b8-8720-d3adb900d8e6","rule":"MergeContainerBridges"}],"Workloads":[{"id":"8589acf6-db61-4360-a96f-1a5de1a70312","rule":"ByHost"}]} for the status

    • info

      the response's property default value changed from {"id":"bc09dc49-8389-41cd-b771-ddb43dc9da88","rule":"ByTrunkPort"} {"id":"8e30beaa-77d4-4447-989e-6305deb6bb03","rule":"ByVLAN"} {"id":"12c5994d-26ca-4f68-8eca-0e8c42061489","rule":"ByPortOpStatus"} {"id":"8642b21c-1575-424c-ae5b-abf4c5467381","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","NetworkAppliance","RemoteAccess","Workstation","Mobile","IoT","Printer","OpenPorts","NetworkIdentities"],"is_infra_rule":true,"title":"Infrastructure"}}} {"id":"339650ec-9d74-40ef-b4f8-5800d7e9375c","rule":{"ByTag":{"tag_ids":[],"title":null}}} {"id":"9868fe8a-440f-45cb-a67d-874b3f4b8454","rule":"ByDeviceType"} {"id":"93db478d-f448-4766-94bc-732bfd624eaa","rule":"ByHypervisor"} {"id":"692ca573-af2d-4a44-901c-5a9377562c2e","rule":"ByContainerRuntime"} {"id":"4c35f319-bb9a-4d89-bc37-e157b2498c67","rule":"ByStack"} to {"id":"e687f3af-643e-4166-9372-480c613b2c59","rule":"ByTrunkPort"} {"id":"59bae1af-48ae-4a9d-8901-742a5962237e","rule":"ByVLAN"} {"id":"7d098cb5-a1f3-4b44-b2ad-eb84c9f3abce","rule":"ByPortOpStatus"} {"id":"fa92d20c-4c99-4385-b7e5-554e2f705091","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","NetworkAppliance","RemoteAccess","Workstation","Mobile","IoT","Printer","OpenPorts","NetworkIdentities"],"is_infra_rule":true,"title":"Infrastructure"}}} {"id":"dd6508db-c3f5-47a8-b22d-96a381b5cf75","rule":{"ByTag":{"tag_ids":[],"title":null}}} {"id":"8768cc4d-f427-41ea-9276-2bd74162d7e0","rule":"ByDeviceType"} {"id":"599c0eca-c956-4de2-b72a-6c1208350cbe","rule":"ByHypervisor"} {"id":"ab9ef755-540c-41f2-80ee-b0b30bcb57be","rule":"ByContainerRuntime"} {"id":"81c086c7-f636-4ef8-bc20-cba88bf034f1","rule":"ByStack"} for the status

  • c94279effef3Revision changes
    • info

      the response's property default value changed from {"Application":[{"id":"efa1c714-e521-49fd-b23a-d9a1ad0aab7c","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"0bac5fe1-18c3-433c-a82b-17dd45f90674","rule":"ByHost"}],"L3Logical":[{"id":"c771d31f-c99a-4067-ba54-0c0f2fd7686a","rule":"BySubnet"},{"id":"0a64d70a-ea49-4248-9b7e-c33b586775b8","rule":"MergeContainerBridges"}],"Workloads":[{"id":"0bac5fe1-18c3-433c-a82b-17dd45f90674","rule":"ByHost"}]} to {"Application":[{"id":"e2ea28a8-ab66-4f00-9cc0-9038c5c79d47","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"a665ec34-ca4a-40b7-982c-b31003a319ba","rule":"ByHost"}],"L3Logical":[{"id":"47177f84-3fda-46c7-b81b-008293b81188","rule":"BySubnet"},{"id":"eb47e951-9a71-4b3c-806d-63b5932efb95","rule":"MergeContainerBridges"}],"Workloads":[{"id":"a665ec34-ca4a-40b7-982c-b31003a319ba","rule":"ByHost"}]} for the status

    • info

      the response's property default value changed from {"id":"debb1fb3-4281-48ec-b57f-699cc003916b","rule":"ByTrunkPort"} {"id":"0b5b9955-0b03-4cfe-8c2f-833c613a75fa","rule":"ByVLAN"} {"id":"05ecf367-c87e-4e13-bb6c-a36aea444692","rule":"ByPortOpStatus"} {"id":"619cb90a-e289-414c-9e17-7c4c0eb870ca","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","NetworkAppliance","RemoteAccess","Workstation","Mobile","IoT","Printer","OpenPorts","NetworkIdentities"],"is_infra_rule":true,"title":"Infrastructure"}}} {"id":"55afdac4-4d1f-4baa-9690-9f36ead2e837","rule":{"ByTag":{"tag_ids":[],"title":null}}} {"id":"63ba8185-eacb-490b-b9af-58c3aee7690b","rule":"ByDeviceType"} {"id":"ae3f910d-edae-46b1-858a-5bd5c24a4b48","rule":"ByHypervisor"} {"id":"0c304f2b-9788-4f8f-b39f-a5922ac3026a","rule":"ByContainerRuntime"} {"id":"29796f4b-9fae-4e4f-90d5-bc4035d76cee","rule":"ByStack"} to {"id":"bc09dc49-8389-41cd-b771-ddb43dc9da88","rule":"ByTrunkPort"} {"id":"8e30beaa-77d4-4447-989e-6305deb6bb03","rule":"ByVLAN"} {"id":"12c5994d-26ca-4f68-8eca-0e8c42061489","rule":"ByPortOpStatus"} {"id":"8642b21c-1575-424c-ae5b-abf4c5467381","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","NetworkAppliance","RemoteAccess","Workstation","Mobile","IoT","Printer","OpenPorts","NetworkIdentities"],"is_infra_rule":true,"title":"Infrastructure"}}} {"id":"339650ec-9d74-40ef-b4f8-5800d7e9375c","rule":{"ByTag":{"tag_ids":[],"title":null}}} {"id":"9868fe8a-440f-45cb-a67d-874b3f4b8454","rule":"ByDeviceType"} {"id":"93db478d-f448-4766-94bc-732bfd624eaa","rule":"ByHypervisor"} {"id":"692ca573-af2d-4a44-901c-5a9377562c2e","rule":"ByContainerRuntime"} {"id":"4c35f319-bb9a-4d89-bc37-e157b2498c67","rule":"ByStack"} for the status