Raspberry API

Appearance

Return to top
On this page

Host overview

Endpoint

GET /v1/hosts

Returns a comprehensive view of a host, including both static information such as kernel and platform versions, hostname, and dynamic data like current resource utilization and active processes

Responses

json
{
   "id":{
      "type":"string"
   },
   "raspModel":{
      "type":"string"
   },
   "hostname":{
      "type":"string"
   },
   "upTime":{
      "type":"uint64"
   },
   "bootTime":{
      "type":"uint64"
   },
   "os":{
      "type":"string"
   },
   "platform":{
      "type":"string"
   },
   "platformFamily":{
      "type":"string"
   },
   "platformVersion":{
      "type":"string"
   },
   "kernelVersion":{
      "type":"string"
   },
   "kernelArch":{
      "type":"string"
   },
   "cpus":{
      "type":"uint8"
   },
   "hyperThreading":{
      "type":"bool"
   },
   "vcores":{
      "type":"uint8"
   },
   "virtMemTotal":{
      "type":"uint64"
   },
   "cpuPercent":{
      "type":"float64"
   },
   "virtMemUsedPercent":{
      "type":"float64"
   },
   "swapMemUsedPercent":{
      "type":"float64"
   },
   "load1":{
      "type":"float64"
   },
   "load5":{
      "type":"float64"
   },
   "load15":{
      "type":"float64"
   },
   "processes":{
      "type":"uint64"
   },
   "activeVirtualUsers":{
      "type":"uint16"
   },
   "temperature":{
      "type":"float32"
   },
   "disks":{
      "type":"array",
      "items":{
         "type":"object",
         "properties":{
            "id":{
               "type":"string"
            },
            "filesystem":{
               "type":"string"
            },
            "fstype":{
               "type":"string"
            },
            "mountpoints":{
               "type":"object",
               "properties":{
                  "mountpoint":{
                     "type":"string"
                  },
                  "fstype":{
                     "type":"string"
                  },
                  "opts":{
                     "type":"string"
                  },
                  "total":{
                     "type":"uint64"
                  },
                  "free":{
                     "type":"uint64"
                  },
                  "used":{
                     "type":"uint64"
                  },
                  "usedPercent":{
                     "type":"float64"
                  },
                  "inodesTotal":{
                     "type":"uint64"
                  },
                  "inodesUsed":{
                     "type":"uint64"
                  },
                  "inodesFree":{
                     "type":"uint64"
                  },
                  "inodesUsedPercent":{
                     "type":"float64"
                  }
               }
            }
         }
      }
   },
   "nets":{
      "type":"array",
      "items":{
         "type":"object",
         "properties":{
            "id":{
               "type":"int"
            },
            "name":{
               "type":"string"
            },
            "flags":{
               "type":"array",
               "items":{
                  "type":"string"
               }
            },
            "ipv4":{
               "type":"string"
            },
            "bytesSent":{
               "type":"uint64"
            },
            "bytesRecv":{
               "type":"uint64"
            },
            "packetsSent":{
               "type":"uint64"
            },
            "packetsRecv":{
               "type":"uint64"
            }
         }
      }
   },
   "users":{
      "type":"array",
      "items":{
         "type":"object",
         "properties":{
            "user":{
               "type":"string"
            },
            "terminal":{
               "type":"string"
            },
            "started":{
               "type":"int"
            }
         }
      }
   }
}