---
title: "Retrieve miner network information"
method: GET
path: "/api/v1/network/"
tags: ["Network"]
---

# Retrieve miner network information

`GET /api/v1/network/`

## Request

- Base URL: `http://miner`
- URL: `http://miner/api/v1/network/`
- Auth: none declared
- TypeScript: <https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/docs/api/v1/network/get.ts> (a function with typed inputs; its response is checked against the schema)

Fetches detailed information about the miner's network, including interfaces, MAC addresses, DNS settings, and default gateway.

## Response `200`

Successful response containing miner network information.

- GetNetworkInfoResponse: Response message for GetCurrentNetworkConfiguration Represents the current network configuration for the default network interface. Only IPv4 is supported.
  - `default_gateway` string, nullable: Default gateway/route for the interface
  - `dns_servers` string[], required: List of configured DNS servers
  - `hostname` string, nullable: Miner hostname
  - `mac_address` string, nullable: MAC address of the network interface
  - `name` string, required: Name of the network interface
  - `networks` IpNetwork[], required: List of assigned IP addresses
    - `address` string, required
    - `netmask` string, required
  - `protocol` integer, nullable: Network protocol

---

[API](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api.md) - [All operations](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/256foundation/apis/braiins-os-public-rest-api/revisions/d341c8e1d506?raw)