Create Site

Create 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
POST
https://{api_host}/rest/federation/v1/sites
COPY
Request Body
SiteCreateSpec of type(s) application/json
Required

Show optional properties

{
    "name": "US Site"
}
{
    "description": "This is US site",
    "name": "US Site"
}
string
description
Optional
Constraints: minLength: 0 maxLength: 1024

Detailed description of the site.

string
name
Required
Constraints: minLength: 0 maxLength: 64

The name of the site.

Authentication
This operation uses the following authentication methods.
Responses
201

Created

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

409

Conflict | CPA not initialized for the pod

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}' https://{api_host}/rest/federation/v1/sites
On This Page
Federation Operations
GET
Get Pod Federation
PUT
Update Pod Federation
POST
Eject Pod
POST
Initialize CPA
POST
Join CPA
POST
Rotate Key Pair
POST
Uninitialize CPA
POST
Unjoin CPA
GET
List Tasks
GET
Get Task
DELETE
Delete Home Sites
GET
List Home Sites
POST
Create Home Sites
POST
Resolve Home Sites
GET
Get Home Site
GET
List Pod Assignments
GET
Get Pod Assignment
GET
List Pods
GET
Get Pod
PUT
Update Pod
GET
List Pod Endpoint
GET
Get Pod Endpoint
GET
List Sites
POST
Create Site
DELETE
Delete Site
GET
Get Site
PUT
Update Site