NetworkSettings

backendNetworkBackendrequired

Detected host network backend.

Possible values: [ifupdown, networkmanager, systemd-networkd, unknown]

editablebooleanrequired

True only when the backend is ifupdown.

readOnlyReasonstring

Why addressing cannot be edited, when editable is false.

interfaces object[]required

Array [

namestringrequired

Kernel interface name, e.g. enp1s0.

macstring

Hardware address, if known.

methodNetworkAddressMethodrequired

How this interface obtains its address.

Possible values: [dhcp, static]

addressstring

Configured IPv4 or IPv6 address without prefix.

prefixinteger

Prefix length for address.

Possible values: >= 0 and <= 128

gatewaystring

Default gateway for this interface, if any.

dnsstring[]

DNS nameservers used with this configuration.

statestringrequired

Link operational state.

Possible values: [up, down]

]

pending object

interfacestringrequired

Interface the pending confirm-or-revert applies to.

expiresAtstring<date-time>required

When the previous configuration is restored if unconfirmed.

remainingSecondsintegerrequired

Whole seconds left in the confirm window.

Possible values: >= 0

certificate objectrequired

kindTLSCertificateKindrequired

How the current TLS certificate was issued.

Possible values: [self_signed, lets_encrypt]

notAfterstring<date-time>required

Certificate expiry instant.

daysRemainingintegerrequired

Whole days until expiry; negative if already expired.

domainstring

DNS name the Let's Encrypt certificate covers. Absent for a self-signed certificate.

letsEncrypt objectrequired

configuredbooleanrequired

True when DNS-01 credentials are stored.

enabledbooleanrequired

True when unattended renewal is armed.

domainstring

Hostname configured for DNS-01.

providerDNS01Provider

DNS-01 providers in v1: Cloudflare's API and generic RFC 2136. HTTP-01 and TLS-ALPN-01 are not offered.

Possible values: [cloudflare, rfc2136]

hasSecretboolean

True when a DNS credential is stored; the secret itself is never returned.

lastErrorstring

Last issue or renewal failure. Omitted after a success.

allowAllSourcesbooleanrequired

When false (default), the TCP listener accepts only LAN-ish sources. When true, every source address is accepted.

listenPortintegerrequired

TCP port the TLS UI/API currently listens on.

Possible values: >= 1 and <= 65535

listenPortRestartRequiredboolean

True when a persisted listen-port change has not been bound yet.

NetworkSettings

{
  "backend": "ifupdown",
  "editable": true,
  "readOnlyReason": "string",
  "interfaces": [
    {
      "name": "string",
      "mac": "string",
      "method": "dhcp",
      "address": "string",
      "prefix": 0,
      "gateway": "string",
      "dns": [
        "string"
      ],
      "state": "up"
    }
  ],
  "pending": {
    "interface": "string",
    "expiresAt": "2024-07-29T15:51:28.071Z",
    "remainingSeconds": 0
  },
  "certificate": {
    "kind": "self_signed",
    "notAfter": "2024-07-29T15:51:28.071Z",
    "daysRemaining": 0,
    "domain": "string"
  },
  "letsEncrypt": {
    "configured": true,
    "enabled": true,
    "domain": "string",
    "provider": "cloudflare",
    "hasSecret": true,
    "lastError": "string"
  },
  "allowAllSources": true,
  "listenPort": 0,
  "listenPortRestartRequired": true
}