Raspberry API

Appearance

Return to top
On this page

Retrieve a network interface

Endpoint

GET /v1/nets/{id}

Retrieves a network interface connected to a Raspberry Pi


Path Parameters

id REQUIRED type INTEGER

A network interface id

Responses

json
{
   "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"
   }
}
text
Failed to retrieve a network interface due to an invalid type for the network interface id. It should be an integer.
text
Failed to retrieve a network interface with given id.