---
title: "Get All Tenant Neighbors"
method: GET
path: "/service/{tenant_name}/bgp/neighbor"
tags: ["service - routing - BGP"]
---

# Get All Tenant Neighbors

`GET /service/{tenant_name}/bgp/neighbor`

## Path parameters

- `tenant_name` unknown, required

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- ItemsListUnionNBNeighborNBDiaNeighbor
  - `items` union[], required
    - union
      - NBNeighbor
        - `tenant_name` string, nullable
        - `remote_router_ip` string, required
        - `remote_asn` integer, required
        - `update_source` string, nullable
        - `password` string, nullable
        - `passive` boolean
        - `route_map_in_id` integer, nullable
        - `route_map_out_id` integer, nullable
        - `max_pfx_in` integer, required
        - `max_pfx_out` integer, required
        - `keepalive` integer, nullable
        - `hold` integer, nullable
        - `open_delay` integer, required
        - `shutdown` boolean, required
        - `description` string, nullable
        - `bfd_config` BfdConfig
          - `transmit_interval` integer
          - `receive_interval` integer
          - `detect_multiplier` integer
          - `passive_mode` boolean
        - `enable` boolean
        - `id` integer, required
        - `autonomous_system_id` integer, required
        - `autonomous_system` AutonomousSystem, required
          - `asn` integer, required
          - `keepalive` integer, required
          - `hold` integer, required
          - `id` integer, nullable
          - `tenant_name` string, required
        - `connected_vi` string
        - `pfx_list_in` string, nullable
        - `pfx_list_out` string, nullable
        - `is_dia` boolean
      - NBDiaNeighbor
        - `tenant_name` string, required
        - `remote_router_ip` string, required
        - `remote_asn` string, nullable
        - `password` string, nullable
        - `passive` boolean
        - `keepalive` integer
        - `hold` integer
        - `open_delay` integer
        - `shutdown` boolean
        - `description` string, nullable
        - `autonomous_system` NBDiaAutonomousSystem, required
          - `asn` string, nullable
        - `connected_vi` string, required
        - `is_dia` boolean
  - `count` integer
  - `total_count` integer

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/zayo/apis/niro-api.md) · [All operations](https://skmtc.net/zayo/apis/niro-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zayo/niro-api/revisions/c52ac26e1766/schema)