REST API - get
  1. Operations
  2. esx
  3. settings
  4. clusters
  5. software
  6. commits

esx settings clusters software commits: get

Returns the information about a specific commit.

Request:

HTTP request

GET https://{server}/api/esx/settings/clusters/{cluster}/software/commits/{commit}

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster.
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.
-.commit_time date_time Creation time of the commit.
-.description string Description accompanying this commit.
-.apply_status string Apply status of the commit.

The apply_status_type structure defines possible values regarding the application of this commit. Value is one of:
APPLIED: Commit has been applied to the cluster.
NOT_APPLIED: Commit hasn't been applied to the cluster.

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 cluster associated with cluster in the system or if desired specification commit is not found.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.