Endpoints Operations Move To Group
Moves the listed endpoints to the target Group and returns them as updated. Requires the ADMIN or SECURITY_OPERATOR role.
The target Group and the ids of the endpoints to move. Both are required.
Show optional properties
{
"targetGroupId": 0,
"endpointIds": [
{}
]
}
{
"targetGroupId": 2,
"endpointIds": [
"2",
"4"
]
}
Identifier of the Security Group the endpoints are moved to; required, and the request is refused with 404 GROUP_NOT_FOUND when no such Group exists. The whole batch moves or none does
Endpoint ids, as in EndpointSummary.id
200 OK successful response envelope. The moved endpoints as they are after the move
[
{
"id": "2",
"hostname": "esx02.example.com",
"ipAddress": "192.0.2.12",
"macAddress": "00:00:5e:00:53:02",
"agentVersion": "1.4.2",
"inventoryAssociation": "CURRENT",
"esxiVersion": "8.0.2",
"lifecycleState": "ACTIVE",
"commStatus": "ONLINE",
"healthStatus": "OK",
"policySyncState": "PENDING",
"appliedPolicyVersion": 3,
"agentDisabledStatus": false,
"groupId": "2",
"groupName": "Staging Servers",
"enforcementMode": "ENFORCE",
"lastHeartbeatAt": "2026-01-15T09:29:30Z",
"registeredAt": "2026-01-12T10:15:00Z"
},
{
"id": "4",
"hostname": "esx04.example.com",
"ipAddress": "192.0.2.14",
"macAddress": "00:00:5e:00:53:04",
"agentVersion": "1.4.2",
"inventoryAssociation": "CURRENT",
"esxiVersion": "8.0.2",
"lifecycleState": "ACTIVE",
"commStatus": "OFFLINE",
"healthStatus": "OK",
"policySyncState": "PENDING",
"appliedPolicyVersion": 3,
"agentDisabledStatus": false,
"groupId": "2",
"groupName": "Staging Servers",
"enforcementMode": "ENFORCE",
"lastHeartbeatAt": "2026-01-14T09:30:00Z",
"registeredAt": "2026-01-12T10:15:00Z"
}
]
Summary representation of an endpoint in inventory listing
400 Bad Request: TARGET_GROUP_REQUIRED, ENDPOINT_IDS_REQUIRED, INVALID_ENDPOINT_ID or MALFORMED_REQUEST
{
"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 or CSRF_ERROR. 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: GROUP_NOT_FOUND or ENDPOINT_NOT_FOUND
"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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"targetGroupId":"integer","endpointIds":["string"]}' https://{api_host}/api/v1/endpoints/move