Fetch a single CSS record by ID

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 complete Computer Specific Settings record, including domain, OU, user accounts, and profile backup details.

Request URL

https://{server-hostname}:8383/emsapi/osdeployer/computersettings/{computerSettingsId}

Scope

OSDComputerSettings.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

computerSettingsIdstringMandatory

ID of OS Deployment ComputerSettings

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/emsapi/osdeployer/computersettings/{computerSettingsId} \
  --header 'Accept: application/computerSettingsDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/computerSettings.v1+json
JSON Object
Hide Sub-Attributes
serialOrMACstring

Serial number or MAC address of the machine this CSS record applies to.

computerNamestring

Computer name configured for this machine. Present only if a computer name has been set.

computerDescriptionstring

Description configured for this machine. Present only if a description has been set.

domainInfoJSON Object

Domain or workgroup join configuration. Present only if domain settings have been configured.

Show Sub-Attributes
domainIDlong

Internal ID of the configured Active Directory domain.

domainNamestring

DNS name of the AD domain to join (e.g., corp.example.com).

credentialIDlong

ID of the stored credential used to join the domain.

ouInfoJSON Object

Active Directory OU placement. Present only if OU settings have been configured.

Show Sub-Attributes
ouNamestring

Friendly name of the target Organizational Unit.

distinguishedNamestring

Full LDAP distinguished name of the target OU.

userAccountsJSON Object

User account configuration. Present only if user accounts have been configured.

Show Sub-Attributes
localUsersJSON Object

Local user IDs to provision on the deployed machine.

Show Sub-Attributes
userIDsarray

IDs of pre-configured local users in OS Deployer. Max 5000 entries.

domainUsersJSON Array

Domain users / groups to add to the machine. Max 5000 entries.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
userNamestring

SAM account name of the domain user.

groupNamestring

Local group on the deployed machine to add the user to (e.g., Administrators).

guidstring

Object GUID of the domain user, used for lookup if userName changes.

deleteExistingUsersboolean

If true, existing local accounts are removed before applying this configuration.

userProfileBackupJSON Object

User profile backup/restore configuration. Present only if profile backup has been configured.

Show Sub-Attributes
backupIDlong

ID of the user-profile backup set to restore.

userProfilesJSON Array

Individual user profiles to restore from the backup. Min 1, max 5000.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
backupUserIDlong

ID of the backed-up user profile to restore.

passwordstring

Password to set for the restored profile. SECRET — never logged.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

CSS record with all optional sections populated; restored passwords are masked

Copied!
  {
    "userProfileBackup": {
      "backupID": 9001,
      "userProfiles": [
        {
          "password": "********",
          "backupUserID": 7
        }
      ]
    },
    "domainInfo": {
      "domainName": "corp.example.com",
      "credentialID": 50,
      "domainID": 1001
    },
    "computerName": "WIN-DESK-001",
    "serialOrMAC": "AA:BB:CC:DD:EE:FF",
    "ouInfo": {
      "distinguishedName": "OU=Sales,DC=corp,DC=example,DC=com",
      "ouName": "Sales"
    },
    "userAccounts": {
      "deleteExistingUsers": false,
      "localUsers": {
        "userIDs": [
          1,
          2
        ]
      },
      "domainUsers": [
        {
          "groupName": "Administrators",
          "guid": "abc-123",
          "userName": "jdoe"
        }
      ]
    },
    "computerDescription": "Sales laptop"
  }
                
Show full

Duration: 1 minute | Threshold: 50 | 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.