ScanopyScanopy
Topologies

Unlock a topology

POST
/api/v1/topology/{id}/unlock

Authorization

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

application/json

curl -X POST "https://loading/api/v1/topology/497f6eca-6276-4993-bfeb-53cbbbba6f08/unlock"
{
  "meta": {
    "api_version": 1,
    "server_version": "0.14.10"
  },
  "success": true,
  "data": {
    "bindings": [
      {
        "created_at": "2026-03-02T07:10:08.140405Z",
        "id": "9748bc1b-49c1-4dc6-abe8-11a5c7b092da",
        "interface_id": "550e8400-e29b-41d4-a716-446655440005",
        "network_id": "550e8400-e29b-41d4-a716-446655440002",
        "port_id": "550e8400-e29b-41d4-a716-446655440006",
        "service_id": "550e8400-e29b-41d4-a716-446655440007",
        "type": "Port",
        "updated_at": "2026-03-02T07:10:08.140405Z"
      }
    ],
    "edges": [
      {
        "edge_type": "Interface",
        "host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "is_multi_hop": true,
        "label": "string",
        "source": "07b8e003-7027-443f-88b0-24a5eb1cc68b",
        "source_handle": "Top",
        "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5",
        "target_handle": "Top"
      }
    ],
    "entity_tags": [
      {
        "color": "Green",
        "created_at": "2026-01-15T10:30:00Z",
        "description": "Production environment resources",
        "id": "550e8400-e29b-41d4-a716-44665544000a",
        "name": "production",
        "organization_id": "550e8400-e29b-41d4-a716-446655440001",
        "updated_at": "2026-01-15T10:30:00Z"
      }
    ],
    "groups": [
      {
        "binding_ids": [],
        "color": "Blue",
        "created_at": "2026-01-15T10:30:00Z",
        "description": "HTTP/HTTPS services group",
        "edge_style": "Bezier",
        "group_type": "RequestPath",
        "id": "550e8400-e29b-41d4-a716-446655440008",
        "name": "Web Services",
        "network_id": "550e8400-e29b-41d4-a716-446655440002",
        "source": {
          "type": "Manual"
        },
        "tags": [],
        "updated_at": "2026-01-15T10:30:00Z"
      }
    ],
    "hosts": [
      {
        "created_at": "2026-01-15T10:30:00Z",
        "description": "Primary web server",
        "hidden": false,
        "hostname": "web-server-01.local",
        "id": "550e8400-e29b-41d4-a716-446655440003",
        "name": "web-server-01",
        "network_id": "550e8400-e29b-41d4-a716-446655440002",
        "source": {
          "type": "Manual"
        },
        "tags": [],
        "updated_at": "2026-01-15T10:30:00Z",
        "virtualization": null
      }
    ],
    "if_entries": [
      {
        "admin_status": "Up",
        "created_at": "2019-08-24T14:15:22Z",
        "host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "if_descr": "string",
        "if_index": 0,
        "if_type": 0,
        "network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3",
        "oper_status": "Up",
        "updated_at": "2019-08-24T14:15:22Z",
        "cdp_address": "string",
        "cdp_device_id": "string",
        "cdp_platform": "string",
        "cdp_port_id": "string",
        "if_alias": "string",
        "if_name": "string",
        "interface_id": "16c0a784-0728-4b20-a16b-354e14c2524c",
        "lldp_chassis_id": {},
        "lldp_mgmt_addr": "string",
        "lldp_port_desc": "string",
        "lldp_port_id": {},
        "lldp_sys_desc": "string",
        "lldp_sys_name": "string",
        "mac_address": "string",
        "neighbor": {},
        "speed_bps": 0
      }
    ],
    "interfaces": [
      {
        "created_at": "2026-01-15T10:30:00Z",
        "host_id": "550e8400-e29b-41d4-a716-446655440003",
        "id": "550e8400-e29b-41d4-a716-446655440005",
        "ip_address": "192.168.1.100",
        "mac_address": "DE:AD:BE:EF:CA:FE",
        "name": "eth0",
        "network_id": "550e8400-e29b-41d4-a716-446655440002",
        "position": 0,
        "subnet_id": "550e8400-e29b-41d4-a716-446655440004",
        "updated_at": "2026-01-15T10:30:00Z"
      }
    ],
    "is_locked": true,
    "is_stale": true,
    "last_refreshed": "2019-08-24T14:15:22Z",
    "name": "string",
    "network_id": "d6797cf4-42b9-4cad-8591-9dd91c3f0fc3",
    "nodes": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "infra_width": 0,
        "node_type": "SubnetNode",
        "position": {
          "x": 0,
          "y": 0
        },
        "size": {
          "x": 0,
          "y": 0
        },
        "header": "string"
      }
    ],
    "options": {
      "local": {
        "hide_edge_types": [
          "Interface"
        ],
        "hide_resize_handles": true,
        "left_zone_title": "string",
        "no_fade_edges": true,
        "tag_filter": {
          "hidden_host_tag_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "hidden_service_tag_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "hidden_subnet_tag_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ]
        }
      },
      "request": {
        "group_docker_bridges_by_host": true,
        "hide_ports": true,
        "hide_service_categories": [
          "NetworkCore"
        ],
        "hide_vm_title_on_docker_container": true,
        "left_zone_service_categories": [
          "NetworkCore"
        ],
        "show_gateway_in_left_zone": true
      }
    },
    "ports": [
      {
        "created_at": "2026-01-15T10:30:00Z",
        "host_id": "550e8400-e29b-41d4-a716-446655440003",
        "id": "550e8400-e29b-41d4-a716-446655440006",
        "network_id": "550e8400-e29b-41d4-a716-446655440002",
        "number": 80,
        "protocol": "Tcp",
        "type": "Http",
        "updated_at": "2026-01-15T10:30:00Z"
      }
    ],
    "removed_bindings": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "removed_groups": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "removed_hosts": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "removed_if_entries": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "removed_interfaces": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "removed_ports": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "removed_services": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "removed_subnets": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "services": [
      {
        "bindings": [
          {
            "created_at": "2026-03-02T07:10:08.140323Z",
            "id": "d5882b69-90a4-43cf-9791-b70516fd2583",
            "interface_id": "550e8400-e29b-41d4-a716-446655440005",
            "network_id": "550e8400-e29b-41d4-a716-446655440002",
            "port_id": "550e8400-e29b-41d4-a716-446655440006",
            "service_id": "550e8400-e29b-41d4-a716-446655440007",
            "type": "Port",
            "updated_at": "2026-03-02T07:10:08.140323Z"
          }
        ],
        "created_at": "2026-01-15T10:30:00Z",
        "host_id": "550e8400-e29b-41d4-a716-446655440003",
        "id": "550e8400-e29b-41d4-a716-446655440007",
        "name": "nginx",
        "network_id": "550e8400-e29b-41d4-a716-446655440002",
        "position": 0,
        "service_definition": "PeaNUT",
        "source": {
          "type": "Manual"
        },
        "tags": [],
        "updated_at": "2026-01-15T10:30:00Z",
        "virtualization": null
      }
    ],
    "subnets": [
      {
        "cidr": "192.168.1.0/24",
        "created_at": "2026-01-15T10:30:00Z",
        "description": "Local area network",
        "id": "550e8400-e29b-41d4-a716-446655440004",
        "name": "LAN",
        "network_id": "550e8400-e29b-41d4-a716-446655440002",
        "source": {
          "type": "Manual"
        },
        "subnet_type": "Lan",
        "tags": [],
        "updated_at": "2026-01-15T10:30:00Z"
      }
    ],
    "tags": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "locked_at": "2019-08-24T14:15:22Z",
    "locked_by": "7894ceea-9d1b-4c9c-9c58-84a3183301e7",
    "parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
    "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.14.10"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}
{
  "meta": {
    "api_version": 1,
    "server_version": "0.14.10"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}

Lock a topology

Previous Page

Delete Topology

Next Page