Raspberry API

Appearance

Return to top
On this page

Retrieve a disk

Endpoint

GET /v1/disks/{id}

Retrieves a disk connected to a Raspberry Pi


Path Parameters

id REQUIRED no type

A disk id

Responses

json
{
   "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"
         }
      }
   }
}
text
Failed to retrieve disk with given id