This API has a deprecated equivalent from v7.0U1.
Get Deployment Type
Get the type of the vCenter appliance.
Request
URLURL
https://{api_host}/api/vcenter/system-config/deployment-type
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SystemConfigDeploymentTypeInfo
of type application/json
The type of the vCenter appliance.
{
"type": "VCSA_EMBEDDED"
}
type
Required
The ApplianceType enumerated type defines the vCenter appliance types.
VCSA_EMBEDDED : vCenter Server Appliance with an embedded Platform Services Controller.
VCSA_EXTERNAL : vCenter Server Appliance with an external Platform Services Controller.
PSC_EXTERNAL : An external Platform Services Controller.
Possible values are: VCSA_EMBEDDED , VCSA_EXTERNAL , PSC_EXTERNAL
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if appliance is not in CONFIGURED state.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetSystemConfigDeploymentType
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/system-config/deployment-type
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/system-config/deployment-type
x-vmw-doc-operation: get
Availability
Added in 7.0U2
