REST API - get

esx settings clusters software components: get

Returns the component version for the given component in the desired software specification.


HTTP request

GET https://{server}/api/esx/settings/clusters/{cluster}/software/components/{component}

Path Parameters

Name Type Description
cluster string Identifier of the cluster.
component string Identifier of the component.


HTTP Status Code: 200

Response Body Structure:





Name Type Description
bold = required
- component_info Optional. Details about the component version.
-.version string Version of the component.

Optional. unset if version is not specified.

-.details component_details Details about the component.

Optional. unset if component is not present in the depot.

-.details.display_name string Display name of the component.

-.details.vendor string Vendor of the component.

-.details.display_version string Human readable version of the component.

Optional. unset if no version is provided for the component.


HTTP Status Code Type Description
500 error If there is unknown internal error. The accompanying error message will give more details about the failure.
400 invalid_argument If invalid component name is provided.
404 not_found If there is no cluster associated with cluster in the system or or no component associated with component in the system.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.