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
id
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.
Responses
204
No Content
Operation doesn't return any data structure
401
User is not authenticated
Operation doesn't return any data structure
403
Access to the resource is forbidden
Operation doesn't return any data structure
404
Not Found
Operation doesn't return any data structure
409
Conflict | CPA not initialized for the pod
Operation doesn't return any data structure
On This Page
Federation Operations
POST
Create Home Sites
POST
Create Site
DELETE
Delete Home Sites
DELETE
Delete Site
POST
Eject Pod
GET
Get Home Site
GET
Get Pod
GET
Get Pod Assignment
GET
Get Pod Endpoint
GET
Get Pod Federation
GET
Get Site
GET
Get Task
POST
Initialize CPA
POST
Join CPA
GET
List Home Sites
GET
List Pod Assignments
GET
List Pod Endpoint
GET
List Pods
GET
List Sites
GET
List Tasks
POST
Resolve Home Sites
POST
Rotate Key Pair
POST
Uninitialize CPA
POST
Unjoin CPA
PUT
Update Pod
PUT
Update Pod Federation
PUT
Update Site