Skip to main content
POST
Search ARP Entries

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A search term to filter by IP address, MAC address, hostname, or manufacturer.

Example:

"192.168.1.10"

sites
string<uuid>[]

An array of Site UUIDs to include in the search. If omitted, all accessible sites are searched.

Example:
page
integer
default:1

The page number for pagination.

per_page
integer
default:10

The number of results to return per page.

sort
enum<string>
default:ip_address

The field to sort the results by.

Available options:
ip_address,
mac_address,
hostname,
manufacturer,
alias,
range
order
enum<string>
default:asc

The sort order.

Available options:
asc,
desc

Response

A paginated list of ARP entries matching the search criteria.

current_page
integer
data
object[]
first_page_url
string<uri>
from
integer
last_page
integer
last_page_url
string<uri>
next_page_url
string<uri> | null
path
string<uri>
per_page
integer
prev_page_url
string<uri> | null
to
integer
total
integer