Delete a mirror

Edit online

Delete a mirror.

Note: It does not delete vaults that are associated with the mirror, but it removes the restrictions that the mirror placed upon those vaults.
CAUTION:
The Delete Mirror API will be deprecated in a follow-on release. As a result we strongly encourage users to replace the Delete Mirror API with the Break Mirror API.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Delete Mirror (deleteMirror) API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/deleteMirror.adm HTTP/1.1 Host:{manager.dsnet} id={mirrorId}&password={adminPassword}

Curl method

Edit online

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/deleteMirror.adm“ -d ”id={mirrorId}&password={adminPassword}“

Parameters

Edit online
Table 2. Request Parameters for Delete Mirror (deleteMirror) API method
Parameter Type Usage Default Description
id Long Required  

ID of the mirror to delete.
password String Required  

Password of user that is making the request.
vaultId Long Optional    

Response

Edit online

Returns success or failure status.

HTTP response codes

Edit online
  • When using an incorrect mirror ID, the request responds with the 422 HTTP status code and the The given mirror id is invalid HTTP status message.

JSON response example

Edit online
{
  ”responseStatus“: ”ok“,
  ”responseHeader“: {
    ”status“: ”ok“,
    ”now“: 1399577922741,
    ”requestId“: ”U2vdQsCoDkMAACkJCP0AAAAI“
  },
  ”responseData“: {}
}