Vcenter System hello

Vcenter System hello

Negotiates common parameters for API communication.

This operation selects mutually supported choices from the Vcenter System HelloSpec.api_releases list.

This operation was added in vSphere API 8.0.2.0.

Request
URI
POST
https://{api_host}/api/vcenter/system?action=hello
COPY
Request Body

Client capabilities including list of supported API release IDs.

Vcenter System HelloSpec of type(s) application/json
Required

Show optional properties

{
    "api_releases": [
        {}
    ]
}
{
    "api_releases": [
        "string"
    ]
}
array of string
api_releases
Required

List of API release IDs that the client can work with in order of preference. The server will select the first mutually supported release ID.

This property was added in vSphere API 8.0.2.0.

Authentication
This operation uses the following authentication methods.
Responses
200

Common parameters for API communication.

Returns Vcenter System HelloResult of type(s) application/json 
"Vcenter System HelloResult Object"
string
api_release
Required

The ID of a mutually-supported API release. This ID should be used in subsequent API calls to the current vCenter system.

If there is no mutually-supported API release, the value will be an empty string, e.g. "". Typically, this is a case where one of the parties is much older than the other party.

This property was added in vSphere API 8.0.2.0.


400

if the list of client provided release IDs (Vcenter System HelloSpec.api_releases) is empty or the list is longer then 128 releases or given release ID is longer then 64 characters.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"api_releases":["string"]}' https://{api_host}/api/vcenter/system?action=hello
On This Page
Vcenter Operations
POST
Vcenter System hello