ONoneuptime
Network Device

Get Network Device

Endpoint to retrieve a single Network Device by ID

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

Request

Path parameters

idstring uuid required

ID of the Network Device to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "hostname": true,
    "discoveredName": true,
    "discoveredNameSource": 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",
    "name": "core-switch-1",
    "slug": "example-slug-value",
    "description": "Core switch in the US East datacenter",
    "hostname": "10.0.0.1",
    "dnsName": "core-sw-01.corp.example.com",
    "otherAddresses": "10.255.0.1, 192.168.1.1",
    "discoveredName": "WB0024KDS03",
    "discoveredNameSource": "netbios-name",
    "discoveredDetails": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "macAddress": "aa:bb:cc:dd:ee:ff",
    "isMacAddressLearned": true,
    "probeId": "123e4567-e89b-12d3-a456-426614174000",
    "siteId": "123e4567-e89b-12d3-a456-426614174000",
    "oidTemplateId": "123e4567-e89b-12d3-a456-426614174000",
    "snmpCredentialProfileId": "123e4567-e89b-12d3-a456-426614174000",
    "currentMonitorStatusId": "123e4567-e89b-12d3-a456-426614174000",
    "monitoringMethod": "SNMP",
    "deviceRole": "switch",
    "networkDeviceRoleId": "123e4567-e89b-12d3-a456-426614174000",
    "monitorId": "123e4567-e89b-12d3-a456-426614174000",
    "snmpVersion": "V2c",
    "snmpCommunityString": "public",
    "snmpPort": 42,
    "snmpV3Auth": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "snmpV3SecurityLevel": "authPriv",
    "snmpV3Username": "monitoring",
    "snmpV3AuthProtocol": "SHA",
    "snmpV3AuthKey": "This is an example of longer text content that might be stored in this field.",
    "snmpV3PrivProtocol": "AES",
    "snmpV3PrivKey": "This is an example of longer text content that might be stored in this field.",
    "isPollingEnabled": true,
    "pollingIntervalInMinutes": 42,
    "walkInterfaces": true,
    "collectEndpoints": true,
    "snmpOids": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "snmpTables": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "autoApplyVendorHealthTemplate": true,
    "nextPollAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastWalkLog": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "sysDescr": "Cisco IOS Software, C2960 Software",
    "sysName": "core-sw-01.example.com",
    "sysObjectId": "1.3.6.1.4.1.9.1.1208",
    "sysLocation": "DC1, Rack 14",
    "sysContact": "netops@example.com",
    "vendor": "Cisco",
    "deviceModel": "WS-C2960X-48TS-L",
    "serialNumber": "FOC1932X0K1",
    "firmwareVersion": "15.2(2)E7",
    "softwareVersion": "15.2(2)E7",
    "lastRebootedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "cdpNeighbors": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "lldpNeighbors": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "snmpTableSnapshot": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "transceiverSnapshot": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "lastSeenAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastPolledAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "isReachable": true,
    "isSnmpReachable": true,
    "lastSnmpSeenAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "refreshRequestedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "interfacesTotal": 42,
    "interfacesUp": 42,
    "interfacesDown": 42,
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "isArchived": true,
    "archivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ]
  }
}

Changes

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