Display the configuration of the specified image
get
/rhp-restapi/rhp/images/{imageId}
Display the details of the gold image associated to the given image name.
Request
Supported Media Types
- application/json
Path Parameters
-
imageId: string
Name of the image.
Query Parameters
-
dbtemplate(optional): boolean
Displays template file names in the default template directory.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
OK. A JSON object containing an image resource representation with multiple properties and the links array with at least the "self" link.
Root Schema : imageResource
Type:
Show Source
object
-
clientName(optional):
string
-
complete(optional):
boolean
-
containsNonRollingPatch(optional):
boolean
-
groupsConfigured(optional):
string
-
homePath(optional):
string
-
imageId(optional):
string
-
imageSize(optional):
integer
-
imageState(optional):
string
-
imageType(optional):
string
-
links(optional):
array links
-
owner(optional):
string
-
parentImage(optional):
string
-
patches(optional):
array patches
-
platform(optional):
string
-
roles(optional):
array roles
-
templateWithDataFiles(optional):
array templateWithDataFiles
-
templateWithoutDataFiles(optional):
array templateWithoutDataFiles
-
version(optional):
string
Nested Schema : singleResourceLinks
Type:
Show Source
object
-
href(optional):
string
The referenced hyperlink element provided in an absolute format.
-
rel(optional):
string
Allowed Values:
[ "self", "collection", "up", "describedBy" ]
Specify the type of relationship the link has with the described resource.
Default Response
Unexpected error. A JSON object containing error details of the issue while executing the operation.
Root Schema : errorResource
Type:
Show Source
object
-
errorCode(optional):
string
Application specific error code, related to the error message shown at tittle.
-
errorDetails(optional):
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
status(optional):
integer
HTTP status code.
-
title(optional):
string
Summary error message.
-
type(optional):
string
Link to HTTP error code page.
Nested Schema : errorDetails
Type:
array
If multiple errors are reported they can be organized in a hierarchical structure in this array.
Show Source