Propagate image to targets
post
/rhp-restapi/rhp/images/{imageId}/actions/deploy
Deploys an image to a specific node in a client cluster.
Request
Supported Media Types
- application/json
Path Parameters
-
imageId(required): string
Name of the image.
Header Parameters
-
Authorization(required): string
Base64 encoding of the user name and password of the user making the request. For more information, see Authentication for Fleet Patching and Provisioning.
Root Schema : DeployImageBody
Type:
Show Source
object
-
auth:
string
Use an authentication plugin to access the remote node
-
authArgs:
object authArgs
Additional Properties Allowed: additionalPropertiesAdditional properties for the selected authentication plugin
-
client:
string
Client cluster name
-
cred:
string
Credential name to associate the user/password credentials to access a remote node
-
imageName:
string
Name of the image
-
path:
string
Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME)
-
root:
boolean
Default Value:
false
Use root credentials to access the remote node -
skipcopy:
string
Skips copying the content
-
targetNode:
string
Node on which operation needs to be executed
Nested Schema : authArgs
Type:
object
Additional Properties Allowed
Show Source
Additional properties for the selected authentication plugin
Security
-
basicAuthentication: basic
Type:
basic
Response
Supported Media Types
- application/json
- text/html
202 Response
Accepted. A JSON object containing job resource details of the accepted operation to obtain status and output of the progress.
Headers
-
Location: string
URL to the job that will execute the operation
Root Schema : jobResource
Type:
Show Source
object
-
jobId:
string
-
links:
array links
-
operation:
string
-
output:
object jobOutputResource
-
status:
string
Allowed Values:
[ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ]
Nested Schema : jobOutputResource
Type:
Show Source
object
-
hasMore:
boolean
Default Value:
false
-
limit:
integer
-
links:
array links
-
offset:
integer
-
output:
string
Nested Schema : singleResourceLinks
Type:
Show Source
object
-
href:
string
The referenced hyperlink element provided in an absolute format.
-
rel:
string
Allowed Values:
[ "self", "collection", "up", "describedBy" ]
Specify the type of relationship the link has with the described resource.
Nested Schema : collectionResourceLinks
Type:
Show Source
object
-
href:
string
The referenced hyperlink element provided in an absolute format with the correct URL parameters.
-
rel:
string
Allowed Values:
[ "next", "prev", "first", "last" ]
Specify the type of relationship the link has with the described resource.
400 Response
Bad Request. A JSON object containing error details of the issue found while parsing a parameter value or name.
Root Schema : errorResource
Type:
Show Source
object
-
errorCode:
string
Application specific error code, related to the error message shown at tittle.
-
errorDetails:
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath:
string
XPath or JSON path to indicate where the error occurs.
-
instance:
string
URI to the link that provides more detail about the error.
-
status:
integer
HTTP status code.
-
title:
string
Summary error message.
-
type:
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
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:
string
Application specific error code, related to the error message shown at tittle.
-
errorDetails:
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath:
string
XPath or JSON path to indicate where the error occurs.
-
instance:
string
URI to the link that provides more detail about the error.
-
status:
integer
HTTP status code.
-
title:
string
Summary error message.
-
type:
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