REST API for Fleet Patching and Provisioning

Deletes the specified image name

delete

/rhp-restapi/rhp/images/{imageId}

Delete the gold image represented by the given image name.

Request

Supported Media Types

application/json

Path Parameters

imageId(required): string

Name of the image.

Response

Supported Media Types

application/json
text/html

200 Response

OK. A JSON object containing an image resource representation with multiple properties and the links array with at least the "self" link. Only if it was successfully deleted.

Root Schema : imageResource

Type: object

Show Source

clientName: string
complete: boolean
containsNonRollingPatch: boolean
groupsConfigured: string
homePath: string
imageId: string
imageSize: integer
imageState: string
imageType: string
links: array links
owner: string
parentImage: string
patches: array patches
platform: string
roles: array roles
templateWithDataFiles: array templateWithDataFiles
templateWithoutDataFiles: array templateWithoutDataFiles
version: string

{
    "type":"object",
    "properties":{
        "imageId":{
            "type":"string"
        },
        "clientName":{
            "type":"string"
        },
        "roles":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "patches":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "parentImage":{
            "type":"string"
        },
        "homePath":{
            "type":"string"
        },
        "imageState":{
            "type":"string"
        },
        "imageType":{
            "type":"string"
        },
        "imageSize":{
            "type":"integer"
        },
        "version":{
            "type":"string"
        },
        "owner":{
            "type":"string"
        },
        "complete":{
            "type":"boolean"
        },
        "platform":{
            "type":"string"
        },
        "containsNonRollingPatch":{
            "type":"boolean"
        },
        "groupsConfigured":{
            "type":"string"
        },
        "templateWithDataFiles":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "templateWithoutDataFiles":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResourceLinks"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object singleResourceLinks

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/singleResourceLinks"
    }
}

Nested Schema : patches

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : roles

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : templateWithDataFiles

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : templateWithoutDataFiles

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : singleResourceLinks

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Specify the type of relationship the link has with the described resource.",
            "enum":[
                "self",
                "collection",
                "up",
                "describedBy"
            ]
        },
        "href":{
            "type":"string",
            "description":"The referenced hyperlink element provided in an absolute format."
        }
    }
}

Default Response

Unexpected error. A JSON object containing error details of the issue while executing the operation.

Root Schema : errorResource

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorDetails":{
            "type":"array",
            "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
            "items":{
                "$ref":"#/definitions/errorResource"
            }
        },
        "errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code, related to the error message shown at tittle."
        }
    }
}

Nested Schema : errorDetails

Type: array

If multiple errors are reported they can be organized in a hierarchical structure in this array.

Show Source

Array of: object errorResource

{
    "type":"array",
    "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
    "items":{
        "$ref":"#/definitions/errorResource"
    }
}

Examples

The following example shows how to delete a gold image from the Fleet Patching and Provisioning Server by submitting a DELETE request on the REST resource using cURL.

curl -u restUser -X DELETE "https://RHP_node_name:8894/rhp-restapi/rhp/images/DB_Image1"

HTTP Status Code and Response Headers

The following shows an example of the response header.

HTTP/1.1 202
Location: https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,PATCH,OPTIONS
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Content-Length, Authorization
Connection: keep-alive
Content-Type: application/json
Content-Length: 159
Date:  Tue, 19 Jun 2018 14:03:23 GMT

Response Body

{
     "links": [{
         "uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
         "rel": "self"
      }],
     "jobId": "1",
     "output": {  }
}