GET /osImages/remoteFileServers/<id>

Use the GET method retrieve information about a specific remote file-server profile.

Note: This REST API requires Lenovo XClarity Administrator v1.3.0 or later.


Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/osImages/remoteFileServers/<id>

where <id> is the ID of an remote file-server profile. To obtain the ID, use the GET /osImages/remoteFileServers method.

Query parameters


Request body


Response codes

Code Description
200 OK. The request completed successfully.
404 Not found. The ID that was specified on the URL is not valid. A descriptive message is returned in the response body.
500 Internal server error. An internal error occurred. A descriptive message is returned in the response body.

Response body

Attributes Type Description
address String IP address of the remote file server
keyType String Type of encryption algorithm. This can be one of the following values.
  • RSA-2048

  • RSA-4096

  • ECDSA-521-secp521r1

port Integer Port number
protocol String Server protocol. This can be one of the following values.
  • HTTP


  • FTP

  • SFTP

serverId String Profile ID for the remote file server
serverPublicKey String XClarity Administrator generated public key
username String User name to connect to the remote file server.
result String Result 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.
messages Array Information about one or more messages
  explanation String Additional information to clarify the reason for the message
  id String Message identifier of a returned message
  recovery Array 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

Response example

   "address": "",
   "keyType": "RSA-2048",
   "port": 8080,
   "protocol": "SFTP",
   "serverId": "100",
   "serverPublicKey": "KLAJDSLFAKEUIJ387U28379…"
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "explanation": "",
      "recovery": {
         "text": "Informationonly;noactionisrequired.",
         "URL": ""
      "text": "Therequestcompletedsuccessfully."