Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get Information About a Device

 

Use this API to retrieve information such as serial number, hostname, and associated organization, of a specific device.

URI

https://[host]/api/juniper/servicenow/device-management/devices/{id} (HTTP method = GET)

URI Parameters

Parameter

Type

Required

Description

id

Integer

Yes

ID of the device for which information is to be retrieved

Consumes

None

Produces

  • application/vnd.juniper.servicenow.device-management.device+xml;version=7

  • application/vnd.juniper.servicenow.device-management.device+json;version=7

Response Elements

Element

Type

Description

uri

String

URI of the device

hostName

String

Hostname of the device

serialNumber

String

Serial number of the device

product

String

Product name of the device

softwareRelease

String

Release number of the Junos OS software installed on the device

scriptBundle

String

Version of the script bundle installed on the device

routingEngine

String

Routing Engine model used in the device

osPlatform

String

Operating system installed on the device

eventProfileInstalltionStatus

String

Status of event profile installation on the device

For an end customer, this element is set to Not Applicable.

connectionStatus

String

Status of the connection between device and Juniper Support Systems (JSS)

For an end-customer device, this element is set to Not Applicable.

ipAddr

String

IP address of the device

deviceFamily

String

Device family to which the device belongs

domain-id

Integer

ID of the Junos Space domain to which the device belongs

domain-name

String

Domain to which the device belongs

rsiFileCollectionConfiguration

String

Request Support Information (RSI) file collection configuration on the device

logFileCollectionConfiguration

String

Log file collection configuration on the device

organization

String

Organization to which the device belongs

deviceGroup

String

Device group to which the device belongs

message

String

Error messages generated on the device; for example, message when there is an error in deleting JMB files from the device while copying the JMB files to Service Now

installed-profile

String

Event profile installed on the device

device-analysis

String

Specifies details such as of Routing Engine, status of BIOS validation, and the time BIOS validation was performed

method

String

A method applicable to the device

Sample Output

Sample XML Output

Sample JSON Output

Error Codes

Message

Description

204 No Content

No devices found