---
title: "Update network configuration"
method: PATCH
path: "/api/v1/network/configuration"
tags: ["Network"]
---

# Update network configuration

`PATCH /api/v1/network/configuration`

## Request

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

Updates the miner's network configuration. Users can modify one or more fields, such as the hostname, network protocol, or DNS settings.

## Request body

- SetNetworkConfigurationRequest
  - `hostname` string, nullable: Hostname. Existing value will be preserved if this field is not set.
  - `protocol` union: Network protocol. Existing value will be preserved if this field is not set.
    - object
      - `dhcp` Dhcp, required
    - object
      - `static` Static, required
        - `address` string, required: IP address
        - `dns_servers` string[], required: DNS servers
        - `gateway` string, required: Gateway
        - `netmask` string, required: Netmask

## Response `200`

Successfully updated network configuration.

- NetworkConfiguration
  - `hostname` string, required: Hostname
  - `protocol` union: Network protocol
    - object
      - `dhcp` Dhcp, required
    - object
      - `static` Static, required
        - `address` string, required: IP address
        - `dns_servers` string[], required: DNS servers
        - `gateway` string, required: Gateway
        - `netmask` string, required: Netmask

---

[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)