Update Pod | VMware Horizon Server API

Update Pod

Only site ID can be updated for cloud managed pods from on-premise interfaces.

Required Privileges : (This server version allows only Administrators on Root access group to login. These privileges are NOT relevant currently but will be applicable in later server versions.)

All the listed privileges are required -

Privileges	Description
FEDERATED_LDAP_MANAGE	This privilege is required to update a Pod.

Request

URI

PUT

https://{api_host}//localhost/rest/federation/v1/pods/{id}

COPY

Path Parameters

string

Required

ID of the Pod.

Request Body

Pod object to be updated.

PodUpdateSpec of type(s) application/json

Required

{
    "cloud_managed": true,
    "description": "Pod Description.",
    "name": "Cluster-CS-1",
    "site_id": "9a892821-8c3d-4e61-9d65-69dfec7b70dc"
}

boolean

cloud_managed

Optional

Indicates whether this pod is managed from cloud. Default value is false.

string

description

Optional

Description of this pod.

string

name

Required

Name of this pod.

string

site_id

Required

ID of the site this pod belongs to.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

204

No Content