List devices

List the approved devices in the system.

Request

Security

Table 1. Roles capable of executing the List Devices API method
Any	Super User	System Admin	Security Admin	Operator
	superUser	systemAdmin (readOnly and read/write)

HTTP method

Edit online

GET /manager/api/{apiResponseType}/1.0/listDevices.adm HTTP/1.1 Host:{manager.dsnet}

Curl method

Edit online

curl -u {admin}:{password} -k “https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/listDevices.adm”

Parameters

Edit online

None other than the default response parameters shown in Common response parameters.

Response

Edit online

All approved devices in the system, including ID, UUID, hostname, alias, IP, site ID.

JSON response example

Edit online

{
  “responseStatus”:“ok”,
  “responseData”:{
    “devices”:[
      {
      “haPeerDeviceId”:null,
      “ip”:“192.168.14.212”,
      “site”:2,
      “hardwareProfile”:388,
      “id”:11,
      “uuid”:“71411e7c-c067-40fb-a2f9-4a97b2d5b339”,
      “alias”:“”,
      “hostname”:“vm-slicestor-3.cleversafelabs.com”,
      “hostCertificate”:35,
      “deviceType”:“slicestor”,
      “certificates”:[
        35
      ],
      “haPeerIp”:null,
      “csr”:“
      -----BEGIN CERTIFICATE REQUEST-----\n...\n-----END CERTIFICATE REQUEST-----\n”,
      “approvedThroughDate”:“Tue, 21 Apr 2015 22:12:12 +0000”,
      "approvedThroughTimestamp":"1448934321000"
      “protocolType”:null,
      “driveFailureErrorCount”:null,
      “externalCertificateChain”:null,
      “creationDate”:“Mon, 21 Apr 2014 22:12:12 +0000”,
      "timestamp":"1448934321000",
      “orphaned”:false,
      “driveFailureWarningCount”:null,
      “archiveVault”:null,
      “haSharedIp”:null,
      “autorenew”:true
      },
      ...
    ]
  }
}

Parameters

Edit online

Table 2. Response parameters for List Devices (listDevices) API method
Parameter	Type	Description
devices	array	Devices that are known to the Manager.
id	Long	Device ID given by the Manager.
uuid	String	Universal unique identifier for device in the system.
creationDate	date	Date device was added to the Manager.
hostname	String	Device host name.
alias	String	Device Alias.
ip	String	Device IP address.
deviceType	String	Device type (Manager, Accesser, or Slicestor).
hostCertificate	Integer	ID of host certificate in the Manager or null if unset.
site	Integer	ID of site to which device belongs in the Manager or null if unset.
orphaned	Boolean	Set to true manually when an unavoidable conflict occurred on device during device registration process. Manager limits capabilities of orphaned devices.
approvedThroughDate	date	Date until which Device is approved with the Manager.
autorenew	Boolean	Renew device certificate automatically when certificate nears expiration. Default is true for every device.
driveFailureWarningCount	Integer	Number of drives offline to trigger Slicestor appliance warning or null if unset. Note: A global setting for this option exists.
driveFailureErrorCount	Integer	Number of drives offline to trigger Slicestor appliance error or null if unset. Note: A global setting for this option exists.
protocolType	String	Protocol type for Accesser set when not the default or null if unset.
hardwareProfile	variable	ID of hardware profile that is assigned in the Manager unless the hardware profile relationship is requested via the View System API. In that case, it is an object that contains hardware information, including device version, serial, and drive information.
archiveVault	Long	ID of archive vault that is assigned to device or null if unset.
csr	text	CSR (in PEM format) of device.
certificates	array	Any certificate IDs owned by device.
externalCertificateChain	array	Any external certificate IDs on device.
timestamp	Long	UNIX time of device's addition to the Manager.
approvedThroughTimestamp	Long	UNIX time through which device is approved with the Manager.