Apply a common change to multiple CSS records.

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

Applies the same partial update (e.g., a domain change) to all CSS records specified in computerSettingsIDs.

Request URL

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

Scope

OSDComputerSettings.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/computerSettingsDetails.v1+jsonapplication/computerSettingsDetails.v1+jsonCopied!
AcceptstringMandatory
application/computerSettingsModifiedStatus.v1+jsonapplication/computerSettingsModifiedStatus.v1+jsonCopied!

- Request Body

application/computerSettingsDetails.v1+json
JSON Object
Hide Sub-Attributes
computerSettingsIDsarrayMandatory

IDs of the CSS records to update.

computerDescriptionstringOptional

Free-form description to apply to all listed records. Max 1024 chars.

domainInfoJSON ObjectMandatory

Domain block to apply to every listed CSS record. Optional.

Show Sub-Attributes
domainIDlongMandatory

Internal ID of the configured Active Directory domain.

domainNamestringMandatory

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

credentialIDlongMandatory

ID of the stored credential used to join the domain.

ouInfoJSON ObjectOptional

Organizational Unit placement to apply to every listed CSS record. Optional.

Show Sub-Attributes
ouNamestringOptional

Friendly name of the target Organizational Unit.

distinguishedNamestringOptional

Full LDAP distinguished name of the target OU.

userAccountsJSON ObjectOptional

User account assignments to apply to every listed CSS record. Optional.

Show Sub-Attributes
localUsersJSON ObjectOptional

Local user IDs to provision on the deployed machine.

Show Sub-Attributes
userIDsarrayOptional

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

domainUsersJSON ArrayOptional

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

Show Sub-Attributes
JSON Object
Show Sub-Attributes
userNamestringOptional

SAM account name of the domain user.

groupNamestringOptional

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

guidstringOptional

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

deleteExistingUsersbooleanOptional

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

userProfileBackupJSON ObjectOptional

User profile backup settings to apply to every listed CSS record. Optional.

Show Sub-Attributes
backupIDlongOptional

ID of the user-profile backup set to restore.

userProfilesJSON ArrayOptional

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

Show Sub-Attributes
JSON Object
Show Sub-Attributes
backupUserIDlongOptional

ID of the backed-up user profile to restore.

passwordstringOptional

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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/emsapi/osdeployer/computersettings \
  --header 'Accept: application/computerSettingsModifiedStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/computerSettingsDetails.v1+json' \
  --data '{"domainInfo":{"domainName":"hq.example.com","credentialID":51,"domainID":1002},"computerSettingsIDs":[101,102,103]}'

Sample Request Body

Move multiple CSS records to a new domain

Copied!
  {
    "domainInfo": {
      "domainName": "hq.example.com",
      "credentialID": 51,
      "domainID": 1002
    },
    "computerSettingsIDs": [
      101,
      102,
      103
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/computerSettingsModifiedStatus.v1+json
JSON Object
Hide Sub-Attributes
computerSettingsModifiedStatusboolean

True if the CSS records were successfully updated.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

CSS records updated

Copied!
  {
    "computerSettingsModifiedStatus": true
  }
                
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.