GET /managementServer/data/repository

Use this method to determine the amount of disk space that is used for backups in the Lenovo XClarity Administrator local repository.

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

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/managementServer/data/repository

Query parameters

Parameters Required / Optional Description
packageSize={size} Optional Size, in bytes, of the XClarity Administrator backup that you want to import
The following example verifies whether the management server has enough disk space to import the backup.
GET https://192.0.2.0 /managementServer/data/repository?packageSize=18270472
The following example retrieves disk space status.
GET https://192.0.2.0 /managementServer/data/repository

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
403 Forbidden The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
spaceUsed String Amount of disk space that is being used by the backup repository
totalSpace String Amount of total disk space that is allocated for the backup repository
result String Result of the request. This can be one of the following values.
  • success. The request completed successfully.

    If the packageSize query parameter was specified, this result means that the management server has enough disk space available to import the backup.

  • failed. The request failed. A descriptive error message is returned.

    If the packageSize query parameter was specified, this result means that the management server does not have enough disk space available to import the backup.

message Object Information about the error message
  explanation String Additional information to clarify the reason for the message
  id String Message identifier of a returned 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
  text String Message text associated with the message identifier
The following example is returned if the request is successful.
{
   "spaceUsed": "5.1 GB",
   "totalSpace": "50 GB",
   "result": "success",
   "message": []
}