Get
/api/v2/devices
Security
HTTP
Type bearer
Query parameters
name
string
groupName
string
timezone
string
ExampleAsia/Kolkata
orgId
string
hostname
string
ip
string
connectionType
array of string
Filter devices by connection type. Availabe values are SSH/RDP/HTTP/HTTPS/VNC/TELNET
sitename
string
city
string
country
string
size
integer
The number of records to return per page
Default25
page
integer
The page number. The page number start from 1
Default1
sort
array of string
Sorting criteria in the format: field:asc|desc, field defaults to whenCreated and direction defaults to DESC. Example fields are: ['name', 'hostname', 'ip', 'whenCreated', 'whenChanged']
DefaultwhenCreated:DESC
Example[
"name:asc"
]
tags
array of string
Filter device by tags
siteId
string
The ID of a particular site to filter
deviceType
string
Filter device by Type
Responses
200
A list of all devices
object
authorization
boolean
data
object
page
integer
results
Array of object (Device)
object
actualIP
string
connectionEndpointAttributes
object (ConnectionEndpoint)
applicationProtocol
string
ExampleSSH/RDP/HTTP/HTTPS/VNC/TELNET
attributes
object (ConnectionEndpointAttributes)
enableFileTransfer
string
Exampletrue/false
enableWallpaper
string
Exampletrue/false
fileTransferPath
string
password
string
privatekey
string
privatekey_filename
string
username
string
cepFstate
integer
cepId
integer
deviceId
integer
fixedSubdomain
string
groups
Array of object (GroupGUID)
object
name
string
objectGUID
string
label
string
networkProtocol
string
ExampleTCP
ouId
Array of string
string
port
integer
subdomain
string
description
string
fState
integer
fqdn
string
hostname
string
id
string
ip
string
ipType
string
locationAttributes
object (LocationAttributes)
city
string
continent
string
continentCode
string
country
string
countryCode
string
countryLatitude
number
countryLongitude
number
latitude
number
longitude
number
state
string
street
string
zipcode
string
name
string
organization
object
id
string
level
integer
name
string
repnetIP
string
site
object
id
string
name
string
network
object
id
string
name
string
site
object
id
string
name
string
status
string
timezone
string
whenChanged
string
whenCreated
string
size
integer
totalCount
integer
totalPage
integer
error_code
integer
error_message
string
error_status
boolean
Examplefalse
401
Unauthorized
object
error_code
integer
error_message
string
error_status
boolean
500
Could not get devices - Internal Server Error
object
authorization
boolean
data
Array of string
Example[]
string
error_code
integer | null
error_message
string | null
error_status
boolean