REST API - get

esx settings depot content components versions: get

Returns information about a given component version in the depot.

Request:

HTTP request

GET https://{server}/api/esx/settings/depot-content/components/{name}/versions/{version}

Path Parameters

Name Type Description
Required
name string Name of the component.
version string Version of the component.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "summary""string",
    "urgency""CRITICAL",
    "release_date""2015-01-01T22:13:05.651Z",
    "vendor""string",
    "display_version""string",
    "kb""http://myurl.com",
    "contact""string",
    "description""string",
    "display_name""string",
    "category""SECURITY"
}

Headers:

None

Type:

Name Type Description
bold = required
- info Information about the given component.
-.display_name string Display name of the component.

-.vendor string Vendor of the component.

-.display_version string Human readable version of the component.

-.summary string Summary of the component version.

-.description string Discription of the component version.

-.category string Category of the component version.

Defines possible values of categories for a component. Value is one of:
SECURITY: Security
ENHANCEMENT: Enhancement
BUGFIX: Bugfix
RECALL: Recall
RECALL_FIX: Recall-fix
INFO: Info
MISC: Misc
GENERAL: General

-.urgency string Urgency of the component version.

Defines possible values of urgencies for a component. Value is one of:
CRITICAL: Critical
IMPORTANT: Important
MODERATE: Moderate
LOW: Low
GENERAL: General

-.kb URI Link to kb article related to this the component version.

-.contact string Contact email for the component version.

-.release_date date_time Release date of the component version.

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 component with given version is not found.
401 unauthenticated if the caller is not authenticated.
503 service_unavailable If the service is not available.