Update Site

Update Site

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/sites/{id}
COPY
Path Parameters
string
id
Required

id

Request Body
SiteUpdateSpec of type(s) application/json
Required 
{
    "description": "This is US site",
    "name": "US Site"
}
string
description
Optional

Detailed description of the site.

string
name
Required

The name of the site.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

400

Bad Request

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