Hypervisor User Groups Api Create Hypervisor User Group

Hypervisor User Groups Api Create Hypervisor User Group
Create a group

Creates a group (ADMIN). 400 INVALID_HYPERVISOR_USER_GROUP; 409 DUPLICATE_GROUP_NAME.

Request
URI
POST
https://{api_host}/api/v1/hypervisor-user-groups
COPY
Request Body

The new group: its name and an optional description.

CreateHypervisorUserGroupRequest of type(s) application/json
Required  

Show optional properties

{
    "name": "string"
}
{
    "name": "Production Operators",
    "description": "Operators who may log in to production ESXi hosts over SSH"
}
string
name
Required  
Constraints: minLength: 1 maxLength: 128

1-128 characters, no control characters

string
description
Optional
Constraints: maxLength: 512

Optional description of at most 512 characters, newlines allowed and other control characters refused; a blank value is stored as null

Authentication
This operation uses the following authentication methods.
Responses
201

201 Created successful response envelope. The created group

Returns HypervisorUserGroupSummaryDto of type(s) application/json
{
    "id": 1,
    "name": "Production Operators",
    "description": "Operators who may log in to production ESXi hosts over SSH",
    "memberCount": 0,
    "mfaIneligibleMemberCount": 0,
    "createdAt": "2026-01-15T09:36:00Z",
    "updatedAt": "2026-01-15T09:36:00Z"
}
integer As int64 As int64
id
Required  

Identifier of the group, assigned when it is created

string
name
Required  

Name of the group, stored trimmed; unique case-insensitively, 1 to 128 characters without control characters

string
description
Optional

Optional description of at most 512 characters; null when none was set

integer As int32 As int32
memberCount
Required  

Number of Hypervisor MFA Users in the group

integer As int32 As int32
mfaIneligibleMemberCount
Required  

Number of members who cannot pass SSH MFA: not enrolled (Pending or Revoked) or disabled

string As date-time As date-time
createdAt
Required  

Time the group was created

string As date-time As date-time
updatedAt
Required  

Time the group was last changed


400

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

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

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)

Returns ForbiddenWrite of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

409 Conflict: DUPLICATE_GROUP_NAME when a group with the name already exists

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name":"string"}' https://{api_host}/api/v1/hypervisor-user-groups