PATCH /siteversion/{uuid}

PATCH /siteversion/{uuid}

/siteversion/{uuid}

Request
URI
PATCH
https://{api_host}/api/siteversion/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

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

SiteVersion object creation

SiteVersion of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_last_modified": "string",
    "datetime": "string",
    "name": "string",
    "prev_target_version": 0,
    "replication_state": "string",
    "site_id": "string",
    "target_timeline": "string",
    "target_version": 0,
    "tenant_ref": "string",
    "timeline": "string",
    "url": "string",
    "uuid": "string",
    "version": 0,
    "version_type": "string"
}
Responses
200

OK

Returns SiteVersion of type(s) application/json 
"SiteVersion Object"
string
_last_modified
Optional

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

string
datetime
Optional

This field represents the creation time of the federateddiff. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

Name of the Site. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int64 As int64
prev_target_version
Optional

Previous targer version for a site. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
replication_state
Optional

Replication state for a site. Enum options - REPLICATION_STATE_FASTFORWARD, REPLICATION_STATE_FORCESYNC, REPLICATION_STATE_STREAMING, REPLICATION_STATE_SUSPENDED, REPLICATION_STATE_INIT, REPLICATION_STATE_WAIT, REPLICATION_STATE_NOT_APPLICABLE. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
site_id
Optional

Cluster UUID of the site. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
target_timeline
Optional

Target timeline of the site. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int64 As int64
target_version
Optional

Target version of the site. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
timeline
Optional

Timeline of the site. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the SiteVersion object. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int64 As int64
version
Optional

Version of the site. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
version_type
Optional

Type of message for which version is maintained. Enum options - CONFIG_VERSION, HEALTH_STATUS_VERSION. Field introduced in 20.1.1. 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

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}'
On This Page
Site Version Operations
GET
GET /siteversion
POST
POST /siteversion
GET
GET /siteversion/{uuid}
PUT
PUT /siteversion/{uuid}
PATCH
PATCH /siteversion/{uuid}
DELETE
DELETE /siteversion/{uuid}