---
title: "Get site topology"
method: GET
path: "/{org_slug}/sites/{id}/topology"
tags: ["Sites"]
---

# Get site topology

`GET /{org_slug}/sites/{id}/topology`

## Request

- Base URL: `https://api.obelinf.com`
- URL: `https://api.obelinf.com/{org_slug}/sites/{id}/topology`
- Auth: HTTP bearer

Get site topology

## Path parameters

- `org_slug` string, required
- `id` string, required

## Response `200`

Site topology

- object
  - `cables` object[], required
    - `id` string, required
    - `term_side_a_id` string, required
    - `term_side_b_id` string, required
    - `label` string, nullable
    - `length` number, nullable
    - `length_unit` string, nullable
    - `term_side_a_device_id` string, nullable
    - `term_side_a_device_name` string, nullable
    - `term_side_a_interface_name` string, nullable
    - `term_side_b_device_id` string, nullable
    - `term_side_b_device_name` string, nullable
    - `term_side_b_interface_name` string, nullable
    - `type` string, nullable
  - `circuits` object[], required
    - `id` string, required
    - `name` string, required
    - `site_a_id` string, required
    - `slug` string, required
    - `circuit_group_name` string, nullable
    - `description` string, nullable
    - `provider_name` string, nullable
    - `site_a_name` string, nullable
    - `site_b_id` string, nullable
    - `site_b_name` string, nullable
    - `status` string, nullable
    - `type_name` string, nullable
  - `cluster_groups` object[], required
    - `id` string, required
    - `name` string, required
  - `clusters` object[], required
    - `id` string, required
    - `name` string, required
    - `cluster_group_id` string, nullable
  - `devices` object[], required
    - `created_at` string, required
    - `id` string, required
    - `name` string, required
    - `rack_id` string, required
    - `slug` string, required
    - `cluster_group_id` string, nullable
    - `cluster_id` string, nullable
    - `cluster_name` string, nullable
    - `device_type_name` string, nullable
    - `height` number, nullable
    - `manufacturer_name` string, nullable
    - `platform_name` string, nullable
    - `position` number, nullable
    - `rack_name` string
    - `status` string, nullable
  - `interfaces` object[], required
    - `device_id` string, required
    - `id` string, required
    - `name` string, required
    - `type` string, nullable
  - `ip_assignments` object[], required
    - `device_id` string, required
    - `subnet_id` string, required
  - `rack_groups` object[], required
    - `id` string, required
    - `name` string, required
    - `slug` string, required
  - `racks` object[], required
    - `created_at` string, required
    - `height` number, required
    - `id` string, required
    - `name` string, required
    - `site_id` string, required
    - `slug` string, required
    - `rack_group_id` string, nullable
  - `site` object, required
    - `id` string, required
    - `name` string, required
    - `slug` string, required
    - `site_group_id` string, nullable
    - `site_group_name` string, nullable
  - `subnets` object[], required
    - `cidr` string, required
    - `created_at` string, required
    - `id` string, required
    - `ip_count` number, required
    - `name` string, required
    - `description` string, nullable
    - `gateway` string, nullable
    - `vlan_id` string, nullable
    - `vlan_name` string, nullable
    - `vrf_id` string, nullable
    - `vrf_name` string, nullable
  - `tags` object[], required
    - `id` string, required
    - `tag_id` string, required
    - `tag_name` string, required
    - `tag_color` string, nullable
  - `vm_interfaces` object[], required
    - `id` string, required
    - `name` string, required
    - `vm_id` string, required
    - `mac_address` string, nullable
    - `mtu` number, nullable
  - `vm_ip_assignments` object[], required
    - `address` string, required
    - `subnet_id` string, required
    - `vm_id` string, required
  - `vms` object[], required
    - `created_at` string, required
    - `id` string, required
    - `name` string, required
    - `slug` string, required
    - `cluster_group_id` string, nullable
    - `cluster_id` string, nullable
    - `cluster_name` string, nullable
    - `device_id` string, nullable
    - `device_name` string, nullable
    - `disk` number, nullable
    - `memory` number, nullable
    - `os` string, nullable
    - `status` string, nullable
    - `vcpus` number, nullable
  - `wireless_links` object[], required
    - `id` string, required
    - `term_side_a_id` string, required
    - `term_side_b_id` string, required
    - `distance` number, nullable
    - `distance_unit` string, nullable
    - `ssid` string, nullable
    - `status` string, nullable
    - `term_side_a_device_id` string, nullable
    - `term_side_a_device_name` string, nullable
    - `term_side_a_interface_name` string, nullable
    - `term_side_b_device_id` string, nullable
    - `term_side_b_device_name` string, nullable
    - `term_side_b_interface_name` string, nullable

## Other responses

- `404`: Not found

---

[API](https://skmtc.dev/obelinf/apis/obelinf-api.md) · [All operations](https://skmtc.dev/obelinf/apis/obelinf-api/llms.txt) · [OpenAPI document](https://skmtc.dev/obelinf/apis/obelinf-api/revisions/463fcf791828?raw)