Sign in
Clients

Update a client

Edit a client's display name and/or its config. Two ways to change the config: config replaces it wholesale, and set changes named fields over the config read inside the write transaction — prefer set, because a whole-config round-trip composed from a stale read reverts whatever landed in between.

Config edits require expectedConfigId and renames require expectedName. A stale token is 409 CONFLICT whose details carries the current value: re-read the client and retry. A config edit that resolves to byte-identical settings writes nothing at all.

Guest callers are denied (a write).

patch/projects/{projectId}/clients/{client}

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

clientstring required

Client name or ID. A name is matched case-insensitively and must be unique in the project; an ambiguous name is refused with 409 CONFLICT listing the candidate ids rather than resolved to one of them.

Request body

OR
OR

Response

The updated client settings.

idstring required
namestring required
configIdstring

The concurrency token — see Client.configId.

configobject required

Client config v2 DTO. Opaque object; shape mirrors the inspector's client editor.

ownerScopeobject nullable required
hasComputerboolean
createdAtnumber

Unix epoch milliseconds.

updatedAtnumber

Unix epoch milliseconds.

Changes