REST API - get
  1. Operations
  2. esx
  3. settings
  4. hosts
  5. software
  6. add on

esx settings hosts software add on: get

Returns the desired OEM add-on specification for a given host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/esx/settings/hosts/{host}/software/add-on

Path Parameters

Name Type Description
Required
host string Identifier of the host.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "name" : "string",
    "details" : {
        "vendor" : "string",
        "display_version" : "string",
        "display_name" : "string"
    },
    "version" : "string"
}

Headers:

None

Type:

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.
-.name string Name of the add-on
-.version string Version of the add-on

Errors:

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 host associated with host 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.
400 unsupported If the host is not a standlone host, but instead part of a cluster.