Fetch Vcenter By Names

Fetch Vcenter By Names

This API is to be used for fetching the vCenter based on vCenter names.

Request
URI
POST
https://{api_host}/hybridity/api/ztp/v1/vcenters/fetch-by-names
COPY
Request Body

The request payload for Fetch vCenter By Names API.

InlineZtpV1VcentersFetchByNamesRequestBody of type(s) application/json
Required 
{
    "vcenters": [
        "string"
    ]
}
array of string
vcenters
Required

The name of the VCenters.

Authentication
This operation uses the following authentication methods.
Responses
200

Response includes list of vCenter as specified by the vCenter names.

Returns InlineZtpV1VcentersFetchByNames200Response of type(s) application/json 
{
    "vcenters": [
        {
            "id": "string",
            "version": 0,
            "name": "string",
            "datacenter": "string",
            "type": "string",
            "parentDomainId": "string",
            "parentDomainName": "cdc1",
            "location": {
                "city": "string",
                "country": "string",
                "address": "string",
                "longitude": "number",
                "latitude": "number"
            },
            "licenses": {
                "esxi": [
                    "string"
                ],
                "vsan": [
                    "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"
            },
            "status": "string",
            "isVcpResyncNeeded": false,
            "createdTimestamp": 0,
            "lastUpdatedTimestamp": 0,
            "messages": {
                "warnings": [
                    {
                        "code": "string",
                        "message": "string",
                        "stack": "string"
                    }
                ],
                "errors": [
                    {
                        "code": "string",
                        "message": "string",
                        "stack": "string"
                    }
                ]
            }
        }
    ],
    "notfound": [
        "string"
    ]
}
array of object
vcenters
Optional

The list of vcenters available.

array of string
notfound
Optional

The list of vcenter names which are not available.


301

API endpoint has permanently moved.

Returns InlineZtpV1VcentersFetchByNames301Response 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 InlineZtpV1VcentersFetchByNames400Response 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

422

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

Returns InlineZtpV1VcentersFetchByNames422Response 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 InlineZtpV1VcentersFetchByNames500Response 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