Download list of devices in csv format

  • Published on Jul 21, 2025
  • 1 minute(s) read
Prev Next
Get
/api/v2/devices/download
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
tags
array of string

Filter device by tags

siteId
string

The ID of a particular site to filter

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" ]
_fields
string

Filter the specified fields in the devices csv file. Available values are: ['devicename','ipaddress','repnetip','connectionport','connectiontype','connectionname','hostname','description','street','city','state','country','zipcode','sitename','createdat','tags']

Responses
200

Download list of all devices in csv

string
401

Unauthorized

object
error_code
integer
error_message
string
error_status
boolean
404

Not Found

Expand All
object
authorization
boolean
Exampletrue
data
object
message
string
error_code
integer | null
error_message
string | null
error_status
boolean
500

Could not download devices - Internal Server Error

object
authorization
boolean
data
Array of string
Example[]
string
error_code
integer | null
error_message
string | null
error_status
boolean