Hypervisor User Groups Api Update Hypervisor User Group
Renames or re-describes a group (ADMIN). 400 INVALID_HYPERVISOR_USER_GROUP; 404 HYPERVISOR_USER_GROUP_NOT_FOUND; 409 DUPLICATE_GROUP_NAME.
Group id
1
The group fields to change: name and description. A field that is left out keeps its stored value.
{
"name": "Production Operators",
"description": "Operators who may log in to production ESXi hosts over SSH, including vCenter-managed hosts"
}
New name, 1 to 128 characters without control characters and unique case-insensitively (409 DUPLICATE_GROUP_NAME otherwise); null leaves the current name unchanged
New description of at most 512 characters; null leaves the current value unchanged and a blank value clears it
200 OK successful response envelope. The updated group
{
"id": 1,
"name": "Production Operators",
"description": "Operators who may log in to production ESXi hosts over SSH, including vCenter-managed hosts",
"memberCount": 2,
"mfaIneligibleMemberCount": 1,
"createdAt": "2026-01-15T09:36:00Z",
"updatedAt": "2026-01-15T09:41:00Z"
}
Identifier of the group, assigned when it is created
Name of the group, stored trimmed; unique case-insensitively, 1 to 128 characters without control characters
Optional description of at most 512 characters; null when none was set
Number of Hypervisor MFA Users in the group
Number of members who cannot pass SSH MFA: not enrolled (Pending or Revoked) or disabled
Time the group was created
Time the group was last changed
400 Bad Request: INVALID_HYPERVISOR_USER_GROUP when name is blank, too long or holds control characters, or description is too long; MALFORMED_REQUEST when the body cannot be read; INVALID_ARGUMENT when the id path variable is not a number
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
404 Not Found: HYPERVISOR_USER_GROUP_NOT_FOUND when no hypervisor user group has the id
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
409 Conflict: DUPLICATE_GROUP_NAME when another group has the name
"ApiErrorResponse Object"
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/v1/hypervisor-user-groups/{id}