REST API - get

esx settings clusters software add on: get

Returns the desired OEM add-on specification for a given cluster.


HTTP request

GET https://{server}/api/esx/settings/clusters/{cluster}/software/add-on

Path Parameters

Name Type Description
cluster string Identifier of the cluster.


HTTP Status Code: 200

Response Body Structure:





Name Type Description
bold = required
- add_on_info Desired OEM add-on specification.
-.details add_on_details Details about the add-on.

Optional. unset if add-on is not present in the depot.

-.details.display_name string Display name of the OEM add-on.

-.details.vendor string Vendor of the OEM add-on.

-.details.display_version string Human readable version of the OEM add-on. string Name of the add-on

-.version string Version of the add-on


HTTP Status Code Type Description
500 error If there is unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no cluster associated with cluster in the system or if desired OEM add-on specification is not found.
503 service_unavailable If the service is not available.
401 unauthenticated if the caller is not authenticated.