ONoneuptime
Network Interface

Get Network Interface

Endpoint to retrieve a single Network Interface by ID

post/network-interface/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Network Interface to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "alias": true,
    "macAddress": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "networkDeviceId": "123e4567-e89b-12d3-a456-426614174000",
    "interfaceIndex": 42,
    "name": "GigabitEthernet0/1",
    "alias": "Uplink to core-sw-02",
    "macAddress": "aa:bb:cc:dd:ee:ff",
    "interfaceType": 42,
    "isMonitored": true,
    "isOperationallyUp": true,
    "isAdministrativelyUp": true,
    "speedInMbps": 42,
    "inRateMbps": 42,
    "outRateMbps": 42,
    "utilizationPercent": 42,
    "errorsPerSecond": 42,
    "lastSeenAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.