Update a single CSS record

Updates an existing Computer Specific Settings record identified by computerSettingsId.

Endpoints

put /emsapi/osdeployer/computersettings/{computerSettingsId}

Copy full URL

Request URL

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

Scope

OSDComputerSettings.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/computerSettingsDetails.v1+jsonCopied!

AcceptstringMandatory

application/computerSettingsModifiedStatus.v1+jsonCopied!

- Path Parameters

computerSettingsIdstringMandatory

ID of OS Deployment ComputerSettings

- Request Body

application/json

JSON Object

Hide Sub-Attributes

serialOrMACstringMandatory

Target machine identifier — serial number or MAC address. Length 4-255, alphanumeric/colon/hyphen allowed.

computerNamestringMandatory

Computer name to be assigned post-deployment. Matches osd_machinename regex.

computerDescriptionstringOptional

Free-form description for the target machine. Max 1024 chars.

domainInfoJSON ObjectMandatory

Domain to join after image deployment. 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 within the domain. Optional.

Show Sub-Attributes

ouNamestringOptional

Friendly name of the target Organizational Unit.

distinguishedNamestringOptional

Full LDAP distinguished name of the target OU.

userAccountsJSON ObjectOptional

Local and domain user accounts to provision on the deployed machine.

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 to restore on the deployed machine. 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/{computerSettingsId} \
  --header 'Accept: application/computerSettingsModifiedStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/computerSettingsDetails.v1+json' \
  --data '{"userProfileBackup":{"backupID":9002,"userProfiles":[{"password":"********","backupUserID":8}]},"domainInfo":{"domainName":"hq.example.com","credentialID":51,"domainID":1002},"computerName":"WIN-DESK-001","serialOrMAC":"AA:BB:CC:DD:EE:FF","ouInfo":{"distinguishedName":"OU=HQ-Sales,DC=hq,DC=example,DC=com","ouName":"HQ-Sales"},"userAccounts":{"deleteExistingUsers":true,"localUsers":{"userIDs":[1]},"domainUsers":[]},"computerDescription":"Re-imaged sales laptop"}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/emsapi/osdeployer/computersettings/{computerSettingsId}"))
        .header("Content-Type", "application/computerSettingsDetails.v1+json")
        .header("Accept", "application/computerSettingsModifiedStatus.v1+json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"userProfileBackup\":{\"backupID\":9002,\"userProfiles\":[{\"password\":\"********\",\"backupUserID\":8}]},\"domainInfo\":{\"domainName\":\"hq.example.com\",\"credentialID\":51,\"domainID\":1002},\"computerName\":\"WIN-DESK-001\",\"serialOrMAC\":\"AA:BB:CC:DD:EE:FF\",\"ouInfo\":{\"distinguishedName\":\"OU=HQ-Sales,DC=hq,DC=example,DC=com\",\"ouName\":\"HQ-Sales\"},\"userAccounts\":{\"deleteExistingUsers\":true,\"localUsers\":{\"userIDs\":[1]},\"domainUsers\":[]},\"computerDescription\":\"Re-imaged sales laptop\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"userProfileBackup\":{\"backupID\":9002,\"userProfiles\":[{\"password\":\"********\",\"backupUserID\":8}]},\"domainInfo\":{\"domainName\":\"hq.example.com\",\"credentialID\":51,\"domainID\":1002},\"computerName\":\"WIN-DESK-001\",\"serialOrMAC\":\"AA:BB:CC:DD:EE:FF\",\"ouInfo\":{\"distinguishedName\":\"OU=HQ-Sales,DC=hq,DC=example,DC=com\",\"ouName\":\"HQ-Sales\"},\"userAccounts\":{\"deleteExistingUsers\":true,\"localUsers\":{\"userIDs\":[1]},\"domainUsers\":[]},\"computerDescription\":\"Re-imaged sales laptop\"}"

headers = {
    'Content-Type': "application/computerSettingsDetails.v1+json",
    'Accept': "application/computerSettingsModifiedStatus.v1+json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/emsapi/osdeployer/computersettings/{computerSettingsId}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/computerSettingsDetails.v1+json");
    headersMap.put("Accept", "application/computerSettingsModifiedStatus.v1+json");

    data=Map();
    data.put("serialOrMAC","value");
    data.put("computerName","value");
    data.put("computerDescription","value");
    data_domainInfo=Map();
    data_domainInfo.put("domainID","1");
    data_domainInfo.put("domainName","value");
    data_domainInfo.put("credentialID","1");
    data.put("domainInfo",data_domainInfo);
    data_ouInfo=Map();
    data_ouInfo.put("ouName","value");
    data_ouInfo.put("distinguishedName","value");
    data.put("ouInfo",data_ouInfo);
    data_userAccounts=Map();
    data_userAccounts_localUsers=Map();
    data_userAccounts_localUsers_userIDs=List();
    data_userAccounts_localUsers_userIDs.add("1");
    data_userAccounts_localUsers.put("userIDs",data_userAccounts_localUsers_userIDs);
    data_userAccounts.put("localUsers",data_userAccounts_localUsers);
    data_userAccounts_domainUsers=List();
    data_userAccounts_domainUsers_item1=Map();
    data_userAccounts_domainUsers_item1.put("userName","value");
    data_userAccounts_domainUsers_item1.put("groupName","value");
    data_userAccounts_domainUsers_item1.put("guid","value");
    data_userAccounts_domainUsers.add(data_userAccounts_domainUsers_item1);
    data_userAccounts.put("domainUsers",data_userAccounts_domainUsers);
    data_userAccounts.put("deleteExistingUsers",true);
    data.put("userAccounts",data_userAccounts);
    data_userProfileBackup=Map();
    data_userProfileBackup.put("backupID","1");
    data_userProfileBackup_userProfiles=List();
    data_userProfileBackup_userProfiles_item1=Map();
    data_userProfileBackup_userProfiles_item1.put("backupUserID","1");
    data_userProfileBackup_userProfiles_item1.put("password","value");
    data_userProfileBackup_userProfiles.add(data_userProfileBackup_userProfiles_item1);
    data_userProfileBackup.put("userProfiles",data_userProfileBackup_userProfiles);
    data.put("userProfileBackup",data_userProfileBackup);

    response = invokeUrl
    [
        url: "https://appDomain/emsapi/osdeployer/computersettings/{computerSettingsId}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/computerSettingsDetails.v1+json")
$headers.Add("Accept", "application/computerSettingsModifiedStatus.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/emsapi/osdeployer/computersettings/{computerSettingsId}' -Method PUT -Headers $headers -ContentType 'application/computerSettingsDetails.v1+json' -Body '{"userProfileBackup":{"backupID":9002,"userProfiles":[{"password":"********","backupUserID":8}]},"domainInfo":{"domainName":"hq.example.com","credentialID":51,"domainID":1002},"computerName":"WIN-DESK-001","serialOrMAC":"AA:BB:CC:DD:EE:FF","ouInfo":{"distinguishedName":"OU=HQ-Sales,DC=hq,DC=example,DC=com","ouName":"HQ-Sales"},"userAccounts":{"deleteExistingUsers":true,"localUsers":{"userIDs":[1]},"domainUsers":[]},"computerDescription":"Re-imaged sales laptop"}'

Sample Request Body

Update domain and OU of an existing CSS record

Copied!

  {
    "userProfileBackup": {
      "backupID": 9002,
      "userProfiles": [
        {
          "password": "********",
          "backupUserID": 8
        }
      ]
    },
    "domainInfo": {
      "domainName": "hq.example.com",
      "credentialID": 51,
      "domainID": 1002
    },
    "computerName": "WIN-DESK-001",
    "serialOrMAC": "AA:BB:CC:DD:EE:FF",
    "ouInfo": {
      "distinguishedName": "OU=HQ-Sales,DC=hq,DC=example,DC=com",
      "ouName": "HQ-Sales"
    },
    "userAccounts": {
      "deleteExistingUsers": true,
      "localUsers": {
        "userIDs": [
          1
        ]
      },
      "domainUsers": []
    },
    "computerDescription": "Re-imaged sales laptop"
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/computerSettingsModifiedStatus.v1+json

JSON Object

Hide Sub-Attributes

computerSettingsModifiedStatusboolean

True if the CSS record was successfully updated.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

CSS record 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.