REST API - get

esx settings hosts software commits: get

Returns the information about a specific commit. 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/commits/{commit}

Path Parameters

Name	Type	Description
Required
host	string	Identifier of the host.
commit	string	Identifier of the specific commit.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "author" : "string",
    "description" : "string",
    "apply_status" : "APPLIED",
    "commit_time" : "2015-01-01T22:13:05.651Z"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Information about the commit.
-.author	string	Author of the commit. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.commit_time	date_time	Creation time of the commit. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.description	string	Description accompanying this commit. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.apply_status	string	Apply status of the commit. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Defines possible values regarding the application of this commit. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: APPLIED: Commit has been applied to the host. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. NOT_APPLIED: Commit hasn't been applied to the host. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

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 working copy of the software document 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.