Get Devices

POST https://{{crosswork_ip}}:30603/crosswork/ztp/v1/devices/query

Use this API to get the ZTP Device information from Crosswork

HEADERS

RESPONSES

status: OK

{"ztpnodes":[{"uuid":"\u003cstring\u003e","hostName":"\u003cstring\u003e","serialNumber":"\u003cstring\u003e","credentialProfile":"\u003cstring\u003e","ipAddress":{"inetAddressFamily":"\u003cstring\u003e","ipaddrs":"\u003cstring\u003e","mask":"\u003cinteger\u003e","type":"\u003cstring\u003e"},"macAddress":"\u003cstring\u003e","osPlatform":"\u003cstring\u003e","deviceFamily":"\u003cstring\u003e","image":"\u003cstring\u003e","config":"\u003cstring\u003e","version":"\u003cstring\u003e","profileName":"\u003cstring\u003e","status":"\u003cstring\u003e","providerInfo":{"providerName":"\u003cstring\u003e","providerDeviceKey":"\u003cstring\u003e"},"connectivityDetails":[{"protocol":"\u003cstring\u003e","inetAddr":[{"inetAddressFamily":"\u003cstring\u003e","ipaddrs":"\u003cstring\u003e","mask":"\u003cinteger\u003e","type":"\u003cstring\u003e"},{"inetAddressFamily":"\u003cstring\u003e","ipaddrs":"\u003cstring\u003e","mask":"\u003cinteger\u003e","type":"\u003cstring\u003e"}],"port":"\u003clong\u003e","timeout":"\u003cuint64\u003e"},{"protocol":"\u003cstring\u003e","inetAddr":[{"inetAddressFamily":"\u003cstring\u003e","ipaddrs":"\u003cstring\u003e","mask":"\u003cinteger\u003e","type":"\u003cstring\u003e"},{"inetAddressFamily":"\u003cstring\u003e","ipaddrs":"\u003cstring\u003e","mask":"\u003cinteger\u003e","type":"\u003cstring\u003e"}],"port":"\u003clong\u003e","timeout":"\u003cuint64\u003e"}],"message":"\u003cstring\u003e","lastUpdated":"\u003cint64\u003e","imageName":"\u003cstring\u003e","configName":"\u003cstring\u003e","isImageInvalid":"\u003cboolean\u003e","isConfigInvalid":"\u003cboolean\u003e","additionalAttributes":"\u003cobject\u003e","inventoryId":"\u003cstring\u003e"},{"uuid":"\u003cstring\u003e","hostName":"\u003cstring\u003e","serialNumber":"\u003cstring\u003e","credentialProfile":"\u003cstring\u003e","ipAddress":{"inetAddressFamily":"\u003cstring\u003e","ipaddrs":"\u003cstring\u003e","mask":"\u003cinteger\u003e","type":"\u003cstring\u003e"},"macAddress":"\u003cstring\u003e","osPlatform":"\u003cstring\u003e","deviceFamily":"\u003cstring\u003e","image":"\u003cstring\u003e","config":"\u003cstring\u003e","version":"\u003cstring\u003e","profileName":"\u003cstring\u003e","status":"\u003cstring\u003e","providerInfo":{"providerName":"\u003cstring\u003e","providerDeviceKey":"\u003cstring\u003e"},"connectivityDetails":[{"protocol":"\u003cstring\u003e","inetAddr":[{"inetAddressFamily":"\u003cstring\u003e","ipaddrs":"\u003cstring\u003e","mask":"\u003cinteger\u003e","type":"\u003cstring\u003e"},{"inetAddressFamily":"\u003cstring\u003e","ipaddrs":"\u003cstring\u003e","mask":"\u003cinteger\u003e","type":"\u003cstring\u003e"}],"port":"\u003clong\u003e","timeout":"\u003cuint64\u003e"},{"protocol":"\u003cstring\u003e","inetAddr":[{"inetAddressFamily":"\u003cstring\u003e","ipaddrs":"\u003cstring\u003e","mask":"\u003cinteger\u003e","type":"\u003cstring\u003e"},{"inetAddressFamily":"\u003cstring\u003e","ipaddrs":"\u003cstring\u003e","mask":"\u003cinteger\u003e","type":"\u003cstring\u003e"}],"port":"\u003clong\u003e","timeout":"\u003cuint64\u003e"}],"message":"\u003cstring\u003e","lastUpdated":"\u003cint64\u003e","imageName":"\u003cstring\u003e","configName":"\u003cstring\u003e","isImageInvalid":"\u003cboolean\u003e","isConfigInvalid":"\u003cboolean\u003e","additionalAttributes":"\u003cobject\u003e","inventoryId":"\u003cstring\u003e"}],"code":"\u003cinteger\u003e","message":"\u003cstring\u003e","paginationDetails":{"SortBy":"\u003cstring\u003e","PageSize":"\u003clong\u003e","PageNum":"\u003clong\u003e","Descending":"\u003cboolean\u003e","MatchCase":"\u003cboolean\u003e","Criteria":"\u003cstring\u003e","TotalCount":"\u003clong\u003e"}}