Skip to content

Add documentation for IPv6 address generation mode & privacy extensions #2670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2025
Merged

Add documentation for IPv6 address generation mode & privacy extensions #2670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions docs/api/supervisor/endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2383,16 +2383,27 @@ Update the settings for a network interface.

| key | type | optional | description |
| ------- | ------ | -------- | ---------------------------------------------------------------------- |
| enabled | bool | True | Enable/Disable an ethernet interface / VLAN got removed with disabled |
| ipv4 | dict | True | A struct with ipv4 interface settings |
| enabled | bool | True | Enable/Disable an ethernet interface / VLAN got removed with disabled |
| ipv6 | dict | True | A struct with ipv6 interface settings |
| ipv4 | dict | True | A struct with ipv4 interface settings |
| wifi | dict | True | A struct with Wireless connection settings |

**ipv4 / ipv6:**
**ipv6:**

| key | type | optional | description |
| ------------- | ------ | -------- | --------------------------------------------------------------------------------------------------- |
| method | string | True | Set IP configuration method can be `auto` for DHCP or Router Advertisements, `static` or `disabled` |
| addr_gen_mode | string | True | Address generation mode can be `eui64`, `stable-privacy`, `default-or-eui64` or `default` |
| ip6_privacy | string | True | Privacy extensions options are `disabled`, `enabled-prefer-public`, `enabled` or `default` |
| address | list | True | The new IP address for the interface in the ::/XX format as list |
| nameservers | list | True | List of DNS servers to use |
| gateway | string | True | The gateway the interface should use |

**ipv4:**

| key | type | optional | description |
| ----------- | ------ | -------- | ------------------------------------------------------------------------------------- |
| method | string | True | Set IP configuration method can be `auto` for DHCP or Router Advertisements (only IPv6), `static` or `disabled` |
| method | string | True | Set IP configuration method can be `auto` for DHCP, `static` or `disabled` |
| address | list | True | The new IP address for the interface in the X.X.X.X/XX format as list |
| nameservers | list | True | List of DNS servers to use |
| gateway | string | True | The gateway the interface should use |
Expand All @@ -2401,7 +2412,7 @@ Update the settings for a network interface.

| key | type | optional | description |
| ------ | ------ | -------- | ------------------------------------------------------------------------------ |
| mode | string | True | Set the mode `infrastructure` (default), `mesh`, `adhoc` or `ap` |
| mode | string | True | Set the mode `infrastructure` (default), `mesh`, `adhoc` or `ap` |
| auth | string | True | Set the auth mode: `open` (default), `web`, `wpa-psk` |
| ssid | string | True | Set the SSID for connect into |
| psk | string | True | The shared key which is used with `web` or `wpa-psk` |
Expand All @@ -2418,7 +2429,7 @@ Return a list of available [Access Points](api/supervisor/models.md#access-point

| key | description |
| ------------ | ---------------------------------------------------------------------- |
| accesspoints | A list of [Access Points](api/supervisor/models.md#access-points) |
| accesspoints | A list of [Access Points](api/supervisor/models.md#access-points) |

**Example response:**

Expand Down Expand Up @@ -2448,8 +2459,8 @@ Create a new VLAN *id* on this network interface.

| key | type | optional | description |
| ------- | ------ | -------- | ---------------------------------------------------------------------- |
| ipv4 | dict | True | A struct with ipv4 interface settings |
| ipv6 | dict | True | A struct with ipv6 interface settings |
| ipv4 | dict | True | A struct with ipv4 interface settings |

</ApiEndpoint>

Expand Down Expand Up @@ -2673,8 +2684,8 @@ Move datadisk to a new location, **This will also reboot the device!**

**Payload:**

| key | type | description |
| ------- | ------ | ----------------------------------------------------------------- |
| key | type | description |
| ------- | ------ | ------------------------------------------------------------------------------- |
| device | string | ID of the disk device which should be used as the target for the data migration |

</ApiEndpoint>
Expand Down
55 changes: 33 additions & 22 deletions docs/api/supervisor/models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,19 +93,30 @@ These models are describing objects that are getting returned from the superviso

## Network interface

| key | type | description |
| ----------- | ------- | ---------------------------------------------------------------------------- |
| interface | string | The interface name i.e eth0. |
| type | string | The interface type: `ethernet`, `wireless` or `vlan`. |
| enabled | boolean | Return True if the interface is enabled. |
| connected | boolean | Return True if the interface is connected to the network. |
| primary | boolean | `true` if it's the primary network interface. |
| ipv4 | struct or null | An IP config struct with IPv4 connection details. |
| ipv6 | struct or null | An IP config struct with IPv6 connection details. |
| wifi | struct or null | A Wifi config struct with wireless connection details. |
| vlan | struct or null | A Vlan config struct with details about the vlan. |

### IP configuration
| key | type | description |
| ----------- | ------- | --------------------------------------------------------------------------------------------- |
| interface | string | The interface name i.e eth0. |
| type | string | The interface type: `ethernet`, `wireless` or `vlan`. |
| enabled | boolean | Return True if the interface is enabled. |
| connected | boolean | Return True if the interface is connected to the network. |
| primary | boolean | `true` if it's the primary network interface. |
| ipv6 | struct or null | An [IPv6 configuration](#ipv6-configuration) struct with IPv6 connection details. |
| ipv4 | struct or null | An [IPv4 configuration](#ipv4-configuration) struct with IPv4 connection details. |
| wifi | struct or null | A [Wifi configuration](#wifi-configuration) struct with wireless connection details. |
| vlan | struct or null | A [VLAN configuration](#vlan-configuration) struct with details about the vlan. |

### IPv6 configuration

| key | type | description |
| ------------- | ------- | ------------------------------------------------------------------------------------------- |
| method | string | The method used to set the IP can be `static`, `auto` or `disabled`. |
| addr_gen_mode | string | Address generation mode can be `eui64` or `stable-privacy`, `default-or-eui64` or `default` |
| ip6_privacy | string | Privacy extensions options are `disabled`, `enabled-prefer-public`, `enabled` or `default` |
| address | list | A list with IP address and the netmask in a ::/XXX format. |
| gateway | string | The IP address of the gateway. |
| nameservers | list | A list containing the IP addresses of the configured nameservers as strings. |

### IPv4 configuration

| key | type | description |
| ----------- | ------- | ---------------------------------------------------------------------------- |
Expand Down Expand Up @@ -169,15 +180,15 @@ These models are describing objects that are getting returned from the superviso

## Backup

| key | type | description |
| --------- | ------- | --------------------------------------------------------------------- |
| slug | string | A generated slug for the backup |
| date | string | ISO date string representation of the date the backup was created |
| name | string | The name given to the backup |
| type | string | The type of backup (full, partial) |
| protected | boolean | `true` if the backup is password protected |
| content | dictionary | A dictionary describing the content of the backup |
| compressed | boolean | `true` if the backup is saved in a compressed archive |
| key | type | description |
| --------- | ------- | -------------------------------------------------------------------------- |
| slug | string | A generated slug for the backup |
| date | string | ISO date string representation of the date the backup was created |
| name | string | The name given to the backup |
| type | string | The type of backup (full, partial) |
| protected | boolean | `true` if the backup is password protected |
| content | dictionary | Details of the backup content. See [Backup -> content](#backup---content) |
| compressed | boolean | `true` if the backup is saved in a compressed archive |

### Backup -> content

Expand Down