Update Pod | View Rest API

Update Pod

Only site ID can be updated for cloud managed pods from on-premise interfaces. All the listed privileges are required -

Privileges	Description
FEDERATED_LDAP_MANAGE	Caller should have permission to this privilege, to perform this operation.

Request

URI

PUT

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

COPY

Path Parameters

string

Required

ID of the Pod.

Request Body

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