Retrieve operating system details of a computer

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns the operating system information of a computer including OS name, version, service pack, architecture, and installation date.

Request URL

https://{server-hostname}:8383/dcapi/inventory/computers/{resourceID}/osInformation

Scope

Inventory.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/osInformation.v1+jsonapplication/osInformation.v1+jsonCopied!

- Path Parameters

resourceIDstringMandatory

Resource identifier of the computer. Obtain from the response of the Get Computers List API.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/inventory/computers/{resourceID}/osInformation \
  --header 'Accept: application/osInformation.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
operatingSystemstring

Operating system name with architecture

installedSystemDrivestring

System drive letter where OS is installed

registeredTOstring

Name the OS is registered to

osVersionstring

OS version string

osServicePackstring

OS service pack or version name

osBuildNumberstring

OS build number

productIDstring

OS product ID

licenseTypestring

License type - Retail, OEM, Volume, etc.

osCDKeystring

OS product key

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

UAC_UNAUTHORIZED - user lacks the required uem-roles or credentials are missing

error_descriptionstring

Authentication or authorization failure reason

- HTTP code 404

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

RESOURCE_NOT_AVAILABLE - the specified resourceID does not exist or is not accessible

error_descriptionstring

Resource not found message

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_codestring

INTERNAL_ERROR - unexpected exception in the service layer

error_descriptionstring

Internal server error message

Possible Response Codes

200HTTP code
401HTTP code
404HTTP code
500HTTP code

Sample Response: HTTP 200

OS details

Copied!
  {
    "installedSystemDrive": "C:",
    "registeredTO": "SampleUser",
    "licenseType": "Retail",
    "osBuildNumber": "26200.8246",
    "osVersion": "10.0.26200",
    "productID": "00000-00000-00000-AA000",
    "osServicePack": "Windows 11 Version 25H2 (x64)",
    "osCDKey": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "operatingSystem": "Windows 11 Professional Edition (x64)"
  }
                
Show full

Sample Response: HTTP 401

Missing credentials

Copied!
  {
    "error_description": "Unauthorized access",
    "error_code": "UAC_UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 404

Resource not found

Copied!
  {
    "error_description": "The specified resource was not found",
    "error_code": "RESOURCE_NOT_AVAILABLE"
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal server error",
    "error_code": "INTERNAL_ERROR"
  }
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.