• Network
  • Read the configuration
    • path: /network/zerotier
    • method: GET
  • Edit the configuration
    • path: /network/zerotier
    • method: PUT
  • data
    • format: json object
    • fields:
      • network_id: string in ZeroTier address format or null if not configured (read/write): zero_tier_address_constraint, default: null
      • state: state_object: The current state of ZeroTier. (read-only)
      • status: The ZeroTier status string or null in case service is not configured (read-only)
      • last_error_state: state object or null
      • license_available: bool, enabling ZeroTier is allowed by the license (read-only)
      • license_expiry: nullable string (currently null is a fallback to: 2022.06), in YYYY.MM|0 format: ZeroTier license expiry (read-only)
  • state_object * format: json object * fields: * text: string * possible values: * "ZeroTier is disabled" * "Enabling ZeroTier" * "Failed to enable ZeroTier" * "Restarting ZeroTier" * "Failed to restart ZeroTier" * "Disabling ZeroTier" * "Failed to disable ZeroTier" * "Configuring ZeroTier" * "The network ID is invalid" * "Failed to configure ZeroTier" * "Zerotier access is not permitted by the license" * "ZeroTier is configured" * "ZeroTier is connected" * type: string, "notification" or "error" * id: disabled | enabling | enabling_failed | restarting | restarting_failed | disabling | disabling_failed | configuring | configuring_failed | invalid_network_id | license_unavailable | configured | connected
  • Examples:

  {
      "network_id":"916af8664d123123",
      "state":{"text":"Enabling ZeroTier..","type":"notification", "id":"enabling"},
      "status":null,
      "last_error_state":null,
      "license_available": true,
      "license_expiry": "2021.09"
  }

  {
      "network_id":"916af8664d123123",
      "state":{"text":"ZeroTier is connected.","type":"notification", "id":"connected"},
      "status":"-status from zerotier-",
      "last_error_state":null
      "license_available": true,
      "license_expiry": "2021.09"
  }

  {
      "network_id":"916af8664d123123",
      "state":{"text":"Failed to enable ZeroTier.","type":"error", "id":"enabling_failed"},
      "status":null,
      "last_error_state":{"text":"Failed to enable ZeroTier.","type":"error", "id":"enabling_failed"}}
      "license_available": true,
      "license_expiry": "2021.09"
  }

Back to Index