---
title: "Get a system"
method: GET
path: "/system/{system_name}"
tags: ["system"]
---

# Get a system

`GET /system/{system_name}`

## Path parameters

- `system_name` unknown, required

## Response `200`

Successful Response

- NBSystemResponse
  - `name` string, required
  - `active_node` string, nullable
  - `status` string, required
  - `location` string, required
  - `wg_conf` object, nullable
  - `nodes` Node[], required
    - `system_name` string, nullable
    - `role` 'active' | 'standby'
    - `location` string, nullable
    - `description` string, nullable
    - `type` 'nsos-v' | 'nsos-500' | 'nsos-1000' | 'nsos-6000' | 'nsos-6004'
    - `version` string, nullable
    - `build_number` integer, nullable
    - `build_sha` string, nullable
    - `iso_epoch` integer, nullable
    - `vendor` string, nullable
    - `model` string, nullable
    - `serial` string, nullable
    - `virtual` boolean, nullable
    - `cpu_type` string, nullable
    - `cpu_isolated` string, nullable
    - `cpu_socket_count` integer, nullable
    - `cpu_core_per_socket` integer, nullable
    - `cpu_cores_total` integer, nullable
    - `mem_total` integer, nullable
    - `disk_total` integer, nullable
    - `health_score` integer, nullable
    - `last_role_change` string, date-time, nullable
    - `id` integer, required
    - `name` string, nullable
    - `address` string, required
    - `status` 'registered' | 'ready' | 'syncing' | 'desynced' | 'invalid_cert' | 'unavailable' | 'new' | 'discovered'
    - `availability` 'up' | 'down' | 'partial'
    - `ha_status` 'auto' | 'manual' | 'disabled'

## 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/versions/c52ac26e1766/schema)