POST /controllersite

POST /controllersite

/controllersite

Request
URI
POST
https://api_host/api/controllersite
COPY
Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body
ControllerSite of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "address": "string",
    "configpb_attributes": {
        "version": 0
    },
    "name": "string",
    "port": 0,
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
address
Required

IP Address or a DNS resolvable, fully qualified domain name of the Site Controller Cluster. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

string
name
Required

Name for the Site Controller Cluster. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
port
Optional

The Controller Site Cluster's REST API port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Reference for the Tenant. It is a reference to an object of type Tenant. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

Reference for the Site Controller Cluster. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Responses
200

OK

Returns ControllerSite of type(s) application/json 
{
    "_last_modified": "string",
    "address": "string",
    "configpb_attributes": {
        "version": 0
    },
    "name": "string",
    "port": 0,
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
address
Required

IP Address or a DNS resolvable, fully qualified domain name of the Site Controller Cluster. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

string
name
Required

Name for the Site Controller Cluster. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
port
Optional

The Controller Site Cluster's REST API port number. Allowed values are 1-65535. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Reference for the Tenant. It is a reference to an object of type Tenant. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

Reference for the Site Controller Cluster. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

On This Page
Controller Site Operations
DELETE
DELETE /controllersite/{uuid}
GET
GET /controllersite
GET
GET /controllersite/{uuid}
PATCH
PATCH /controllersite/{uuid}
POST
POST /controllersite
PUT
PUT /controllersite/{uuid}