DELETE /managementServer/data/<UUID>

Use this DELETE method to delete a Lenovo XClarity Administrator backup from a specific location.

Note: This API requires Lenovo XClarity Administrator v2.2.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

DELETE https://<management_server_IP>/Server/data/<UUID>

Where <UUID> is the UUID of the package to be downloaded. To obtain the package UUID, use the GET /managementServer/data method.

Query parameters

Parameters Required / Optional Description
location=<location> Required Location from where to delete the backup. This can be one of the following value.
  • all. Deletes the backup from all locations (XClarity Administrator local repository and remote shares).

  • internal. Deletes the backup in the XClarity Administrator local repository.

  • <mount_point>. Deletes the backup from the remote share that is configured using the specified mount point.

To obtain the list of locations where the package exists use the GET /managementServer/data method.

The following example deletes the backup from only the XClarity Administrator local repository.
DELETE https://192.0.2.0/managementServer/data/4edf27ff-08d1-49b5-b7f3-7e8edc4fd278?
location=internal
The following example deletes the package only from the specified remote share.
DELETE https://192.0.2.0/managementServer/data/4edf27ff-08d1-49b5-b7f3-7e8edc4fd278?
location=/mnt/my_remote_share

Request body

None

Response codes

Code Description
200 OK
400 Bad request
403 Forbidden
500 Internal server error

Response body

Attributes Type Description
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

{
   "result": "success",
   "message": []
}