API schemas: U

UpdateAlarmRequest

Change an alarm definition (PUT /v1/alarms/{id}). Absent fields keep their value; the body of POST /v1/alarms is accepted as it is (a full replacement). The states stay unless the trigger or the scope changes.

Name	Type	Description
`actions`	array of `AlarmAction` or `null`	Actions (replaces the list).
`description`	`string` or `null`	Description.
`enabled`	`boolean` or `null`	Enabled. A disabled alarm is not evaluated.
`expectedVersion`	`integer` (int64) or `null`	Version the client read (`version` of the alarm record); `CONFLICT` when it changed.
`name`	`string` or `null`	Name.
`scopeId`	`string` or `null`	Scope entity id. A new scope needs `Alarm.Create` there and clears the states.
`trigger`	`AlarmTrigger` or `null`

UpdateDistributedPortgroupRequest

Body of PUT /v1/distributed-portgroups/{id}: the fields to change; null for ipv4 or ipv6 removes the settings.

Name	Type	Required	Description
`expectedVersion`	`integer` (int64)	yes	Version the change is based on.
`ipv4`	`HostBridgeIpv4Request` or `null`
`ipv6`	`PortgroupIpv6Request` or `null`
`name`	`string` or `null`		Name.
`staticAddresses`	`object` or `null`		Fixed IPv4 addresses by MAC (replaces the map).
`vlanId`	`integer` (int32) or `null`		VLAN id (clears `vni`).
`vni`	`integer` (int32) or `null`		VNI (replaces the VLAN).

UpdateDistributedSwitchRequest

Body of PUT /v1/distributed-switches/{id}: the fields to change.

Name	Type	Required	Description
`expectedVersion`	`integer` (int64)	yes	Version the change is based on.
`hostUplinks`	array of `HostUplinksRequest` or `null`		The physical NICs of member hosts (replaces the list).
`hosts`	array of `string` or `null`		Member hosts.
`mtu`	`integer` (int32) or `null`		MTU.
`name`	`string` or `null`		Name.
`uplinkNames`	array of `string` or `null`		Uplink names.
`uplinks`	`integer` (int32) or `null`		Number of uplinks.

UpdateGroupRequest

Body of PUT /v1/identity/groups/{name}. Absent fields keep their value.

Name	Type	Required	Description
`description`	`string` or `null`		New description.
`name`	`string` or `null`		New name. Memberships of users and groups and the permissions granted to the group follow the rename.

UpdateNetworkRequest

Update a host-bridge network (PUT /v1/networks/{id}).

Compare-and-set on expectedVersion. Omitted fields keep their current value. Existing DHCP leases are preserved when the backing is rewritten.

Name	Type	Required	Description
`backing`	`HostBridgeBackingRequest` or `null`
`expectedVersion`	`integer` (int64)	yes	Version the client read; fails with `CONFLICT` if it changed.
`hosts`	array of `string` or `null`		Replace the hosts list.
`name`	`string` or `null`		New display name.
`vlanId`	`integer` (int32) or `null`		New VLAN id.

UpdateObjectRequest

Inventory update request (compare-and-set).

Name	Type	Required	Description
`data`	`ObjectBody`	yes	New body, in the kind's schema.
`expectedVersion`	`integer` (int64)	yes	Version the client read; the update fails with `CONFLICT` if it changed.

UpdateSessionFileView

File on an update session.

Name	Type	Required	Description
`bytesTransferred`	`integer` (int64)	yes	Bytes transferred.
`errorMessage`	`string` or `null`		Error message when status is ERROR.
`name`	`string`	yes	File name.
`size`	`integer` (int64) or `null`		Expected or actual size.
`sourceType`	`string`	yes	`PUSH`.
`status`	`string`	yes	Transfer status.
`uploadEndpoint`	`string` or `null`		Relative upload URI for PUSH.

UpdateSessionView

Content library update session (GET/POST /v1/content/update-sessions).

Name	Type	Required	Description
`clientProgress`	`integer` (int64)	yes	Client progress 0..=100.
`creationTime`	`string`	yes	Creation time.
`errorMessage`	`string` or `null`		Error message when state is ERROR.
`expirationTime`	`string`	yes	Expiration time.
`id`	`string`	yes	Session id.
`lastModifiedTime`	`string`	yes	Last modification time.
`libraryItemId`	`string`	yes	Library item being updated.
`state`	`string`	yes	`ACTIVE`, `DONE`, `ERROR`, or `CANCELED`.

UpdateSubscriptionRequest

Body of PUT /v1/webhooks/{id}: the fields of the create request. Absent optional fields keep their value; an absent secret keeps the stored one.

Name	Type	Required	Description
`enabled`	`boolean` or `null`		On or off.
`eventTypes`	array of `string` or `null`		Event types (empty: all).
`labels`	array of `string` or `null`		Labels that alarm actions reference.
`maxAttempts`	`integer` (int32) or `null`		Attempts per event.
`name`	`string`	yes	Name.
`secret`	`string` or `null`		New shared secret (at least 16 bytes); absent keeps the stored one.
`tenant`	`string` or `null`		Tenant filter (`tenant-N`); `null` removes it.
`url`	`string`	yes	Target URL (`https://`; loopback and private addresses need an allow-list entry).

UpdateTagCategoryRequest

Body of PUT /v1/tag-categories/{id}. Absent fields keep their value. Cardinality can change from single to multiple only, and associable kinds can only be added: both would otherwise break existing assignments.

Name	Type	Description
`associableKinds`	array of `string` or `null`	The new list of associable kinds (a superset of the current one).
`cardinality`	`string` or `null`	`multiple`.
`description`	`string` or `null`	New description.
`expectedVersion`	`integer` (int64) or `null`	Version the client read; `CONFLICT` when the category changed since.
`name`	`string` or `null`	New name.

UpdateTagRequest

Body of PUT /v1/tags/{id}. Absent fields keep their value.

Name	Type	Description
`description`	`string` or `null`	New description.
`expectedVersion`	`integer` (int64) or `null`	Version the client read; `CONFLICT` when the tag changed since.
`name`	`string` or `null`	New name.

UpdateUserRequest

Body of PUT /v1/identity/users/{username}. Absent fields keep their value.

Name	Type	Description
`displayName`	`string` or `null`	Display name.
`email`	`string` or `null`	E-mail address.
`groups`	array of `string` or `null`	The local groups the user is a direct member of (replaces the set; groups that come from an identity provider stay).

UplinkMode

How a host-bridge network reaches the provider's network.

Values: "bridged", "proxy"

UsageLineView

One usage line.

Name	Type	Required	Description
`key`	`string`	yes	Group id.
`name`	`string`	yes	Group name.
`netRxBytes`	`integer` (int64)	yes	Bytes received.
`netRxGib`	`number` (double)	yes	GiB received.
`netTxBytes`	`integer` (int64)	yes	Bytes sent.
`netTxGib`	`number` (double)	yes	GiB sent.
`period`	`string`	yes	`YYYY-MM-DD`, `YYYY-MM` or `from/to`.
`poweredOnHours`	`number` (double)	yes	Powered-on hours.
`provisionedGibHours`	`number` (double)	yes	GiB-hours of provisioned storage.
`ramGibHours`	`number` (double)	yes	GiB-hours of configured memory while powered on.
`usedGibHours`	`number` (double)	yes	GiB-hours of used storage.
`vcpuHours`	`number` (double)	yes	vCPU-hours.
`vms`	`integer` (int32)	yes	Distinct VMs.

UsageReportView

A usage report.

Name	Type	Required	Description
`from`	`string`	yes	First day.
`groupBy`	`string`	yes	Grouping.
`lines`	array of `UsageLineView`	yes	Lines.
`period`	`string`	yes	Period.
`to`	`string`	yes	Last day (inclusive).

UserView

Secret-free user view.

Name	Type	Required	Description
`apiTokens`	array of `ApiTokenView`		API tokens (without secrets).
`breakGlass`	`boolean`	yes	Break-glass account.
`displayName`	`string`	yes	Display name.
`email`	`string`	yes	E-mail.
`enabled`	`boolean`	yes	Enabled.
`groups`	array of `string`	yes	Groups.
`lastLogin`	`string` or `null`		Last login.
`locked`	`boolean`		True while the account is locked after too many failed logins (`lockedUntil` is in the future); an administrator reads it here before lifting the lockout.
`lockedUntil`	`string` or `null`		Locked until.
`mfaEnrolled`	`boolean`	yes	MFA enrolled.
`passwordRotationRequired`	`boolean`	yes	Must rotate password.
`recoveryCodesRemaining`	`integer`		Unused TOTP recovery codes.
`serviceAccount`	`boolean`		Service account (automation only; no browser login).
`source`	`string`	yes	`local` or `oidc`.
`tenant`	`string` or `null`		The tenant of a tenant user (`tenant-N`).
`username`	`string`	yes	Username.