Skip to main content

DELETE /aicc/service/sftp/locks/{id}

Use this method to release a specific SFTP service lock by deleting a specific lock ID and, if all locks are deleted, stop (disable) the SFTP service (unless dbgshell account exist on the Lenovo XClarity Administrator instance).

Note
  • You must be a member of a user group to which the predefined Supervisor role is assigned.
  • This REST API requires Lenovo XClarity Administrator v4.1.0 or later.

Authentication​

Authentication with username and password is required.

Request URL​

DELETE https://{management_server_IP}/aicc/service/sftp/locks/{id}

where {id} is the ID of the SFTP service lock. To obtain the lock ID, use GET /aicc/service/sftp/locks.

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
403ForbiddenThe 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.

For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions.

404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned if the request is successful.
{
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "explanation": "",
      "text": "The request completed successfully.",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      }
   }]
}