Update Vcenter

Update Vcenter

Update the specified vCenter.

Request
URI
PUT
https://{api_host}/hybridity/api/ztp/v1/vcenters/{vcenter_id}
COPY
Path Parameters
string
vcenter_id
Required

The ID of the vCenter.

Request Body

The request payload for Update vCenter API.

InlineZtpV1VcentersVcenter_idRequestBody of type(s) application/json
Required 
{
    "id": "string",
    "version": 0,
    "name": "vCenter-001",
    "type": "string",
    "location": {
        "city": "string",
        "country": "string",
        "address": "string",
        "longitude": "number",
        "latitude": "number"
    },
    "licenses": {
        "esxi": [
            "string"
        ],
        "vsan": [
            "string"
        ]
    },
    "datacenter": "string",
    "vcenter": {
        "fqdn": "string",
        "username": "string",
        "password": "string",
        "thumbprintSha256": "06:69:51:27:c6:bc:32:3e:02:a4:e4:3c:2e:9e:75:78:9e:b7:d4:9c:11:51:72:cc:c4:45:13:22:a4:36:f3:e5"
    }
}
string As uuid As uuid
id
Optional

The unique ID of the domain. This is optional when creating domains and required when updating domain(s) in the absence of domain ID as API Path Param. This field is required and cannot be updated during Domain Update.

integer
version
Optional

The version of this domain entity. This field must be specified during Domain Update.

string As ^[^\s]+$
name
Required

The name of the domain. This field cannot be updated during Domain Update.

string
type
Required

The type of the domain. This field cannot be updated during Domain Update.

object
location
Optional

The location of the domain.

object
licenses
Optional

The license keys required for the domain.

string
datacenter
Optional

The name of datacenter.

object
vcenter
Required

Vcenter details for center side domain

Authentication
This operation uses the following authentication methods.
Responses
200

The specified vCenter has been updated successfully.

Returns InlineZtpV1VcentersVcenter_id200Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


301

API endpoint has permanently moved.

Returns InlineZtpV1VcentersVcenter_id301Response of type(s) application/json 
{
    "redirectURL": "string"
}
string
redirectURL
Optional

redirectURL

Response Headers

string
Location

URI where the client will find the new endpoint.


400

Response may include details of why the request is bad.

Returns InlineZtpV1VcentersVcenter_id400Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


401

User is not authenticated to invoke this endpoint.

Operation doesn't return any data structure

403

User is not authorized to invoke this endpoint.

Operation doesn't return any data structure

404

The specified vCenter was not found.

Operation doesn't return any data structure

422

The request payload couldn't be processed by the server.

Returns InlineZtpV1VcentersVcenter_id422Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


500

An internal server error has occurred.

Returns InlineZtpV1VcentersVcenter_id500Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


On This Page
V Center Operations
POST
Create Vcenters
DELETE
Delete Vcenter
POST
Fetch Vcenter By Names
GET
Get Status For Vcenter
GET
Get Vcenter
GET
Get V Center Certificate
GET
Get Vcenters
PATCH
Patch Vcenter
POST
Resync Vcenters
PUT
Update Vcenter
PUT
Update Vcenters
POST
Validate Vcenter