---
title: "Get node ARP cache"
method: GET
path: "/v1/objects/{object-id}/arp-cache"
tags: ["Objects"]
---

# Get node ARP cache

`GET /v1/objects/{object-id}/arp-cache`

Read the ARP cache of the given node. Entries are resolved against the object database where possible - the interface the entry was seen on and the node owning the IP address are reported by name when the caller has read access to them. Returns an empty entry list with a null timestamp when the ARP cache has never been collected for this node.

## Path parameters

- `object-id` integer, required

## Query parameters

- `forceRead` boolean

## Response `200`

ARP cache retrieved successfully

- ArpCache — ARP cache of a node
  - `timestamp` string, date-time, nullable — When the cache was collected. Null when it has never been collected for this node.
  - `entries` ArpCacheEntry[]
    - `ipAddress` InetAddress
      - `family` integer — IP address family
      - `address` string — IP address in text form. Omitted entirely for unset (AF_UNSPEC) addresses.
      - `prefixLength` integer — IP address prefix length
    - `macAddress` string — MAC address in colon-separated notation
    - `vendor` string, nullable — NIC vendor resolved from the OUI database. Null when the prefix is not known.
    - `interfaceIndex` integer — Interface index the entry was seen on (0 if unknown)
    - `interfaceName` string, nullable — Name of the matching interface object. Null when no interface object matches the index.
    - `nodeId` integer — ID of the node owning this IP address, or 0 when no node matches or the caller has no read access to it.
    - `nodeName` string, nullable — Name of the node owning this IP address. Null when nodeId is 0.

## Other responses

- `400` — Invalid object ID or object is not a node
- `401` — Unauthorized
- `403` — User does not have read access to given object
- `404` — Object with given ID does not exist

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/revisions/070b10a450e2/schema)