Sign in
Topologies
internal

Create topology

post/api/v1/topology

Request body

is_lockedboolean required
is_staleboolean required
last_refreshedstring date-time required
locked_atstring date-time nullable
locked_bystring uuid nullable
namestring required
network_idstring uuid required
parent_idstring uuid nullable
removed_bindingsstring[] required
removed_dependenciesstring[] required
removed_hostsstring[] required
removed_interfacesstring[] required
removed_ip_addressesstring[] required
removed_portsstring[] required
removed_servicesstring[] required
removed_subnetsstring[] required
tagsstring[] required
created_atstring date-time required
idstring uuid required
updated_atstring date-time required

Example request

{
  "bindings": [
    {
      "created_at": "2026-04-20T04:23:43.712189Z",
      "id": "2907a66b-305c-480c-a08c-46046e98643f",
      "ip_address_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-04-20T04:23:43.712189Z"
    }
  ],
  "dependencies": [
    {
      "color": "Blue",
      "created_at": "2026-01-15T10:30:00Z",
      "dependency_type": "RequestPath",
      "description": "HTTP/HTTPS services dependency",
      "edge_style": "Bezier",
      "id": "550e8400-e29b-41d4-a716-446655440008",
      "members": {
        "service_ids": [],
        "type": "Services"
      },
      "name": "Web Services",
      "network_id": "550e8400-e29b-41d4-a716-446655440002",
      "source": {
        "type": "Manual"
      },
      "tags": [],
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "entity_tags": [
    {
      "color": "Green",
      "created_at": "2026-01-15T10:30:00Z",
      "description": "Production environment resources",
      "id": "550e8400-e29b-41d4-a716-44665544000a",
      "is_application": false,
      "name": "production",
      "organization_id": "550e8400-e29b-41d4-a716-446655440001",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "hosts": [
    {
      "created_at": "2026-01-15T10:30:00Z",
      "credential_assignments": [],
      "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
    }
  ],
  "ip_addresses": [
    {
      "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"
    }
  ],
  "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"
    }
  ],
  "services": [
    {
      "bindings": [
        {
          "created_at": "2026-04-20T04:23:43.712081Z",
          "id": "8e7faba1-f325-42db-a982-c7d70a90d0d7",
          "ip_address_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-04-20T04:23:43.712081Z"
        }
      ],
      "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": "APC",
      "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"
    }
  ]
}

Response

Topology created

errorstring nullable
successboolean required

Example response

{
  "data": {
    "bindings": [
      {
        "created_at": "2026-04-20T04:23:43.712189Z",
        "id": "2907a66b-305c-480c-a08c-46046e98643f",
        "ip_address_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-04-20T04:23:43.712189Z"
      }
    ],
    "dependencies": [
      {
        "color": "Blue",
        "created_at": "2026-01-15T10:30:00Z",
        "dependency_type": "RequestPath",
        "description": "HTTP/HTTPS services dependency",
        "edge_style": "Bezier",
        "id": "550e8400-e29b-41d4-a716-446655440008",
        "members": {
          "service_ids": [],
          "type": "Services"
        },
        "name": "Web Services",
        "network_id": "550e8400-e29b-41d4-a716-446655440002",
        "source": {
          "type": "Manual"
        },
        "tags": [],
        "updated_at": "2026-01-15T10:30:00Z"
      }
    ],
    "entity_tags": [
      {
        "color": "Green",
        "created_at": "2026-01-15T10:30:00Z",
        "description": "Production environment resources",
        "id": "550e8400-e29b-41d4-a716-44665544000a",
        "is_application": false,
        "name": "production",
        "organization_id": "550e8400-e29b-41d4-a716-446655440001",
        "updated_at": "2026-01-15T10:30:00Z"
      }
    ],
    "hosts": [
      {
        "created_at": "2026-01-15T10:30:00Z",
        "credential_assignments": [],
        "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
      }
    ],
    "ip_addresses": [
      {
        "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"
      }
    ],
    "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"
      }
    ],
    "services": [
      {
        "bindings": [
          {
            "created_at": "2026-04-20T04:23:43.712081Z",
            "id": "8e7faba1-f325-42db-a982-c7d70a90d0d7",
            "ip_address_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-04-20T04:23:43.712081Z"
          }
        ],
        "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": "APC",
        "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"
      }
    ]
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.16.1"
  }
}

Changes