Destroy a mirror
Destroys a mirror and associated vaults from the system, if it is empty.
The Destroy Mirror API may not work properly with SOH objects.
There should be no active writes during a Destroy Mirror action on standard or protected mirrors since it can result in destruction of object data.
The Destroy action is not supported if both name index and recover listing are disabled (See managerapi430.html.)
Request
Security
| Any | Super User | System Admin | Security Admin | Operator |
|---|---|---|---|---|
| superUser | systemAdmin |
HTTP method
POST /manager/api/{apiResponseType}/1.0/destroyMirror.adm HTTP/1.1
Host:{manager.dsnet}
action={deny|delete}&id={objectIDnumber}&password={password}Curl method
curl -u {admin}:{password} -k
'https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/destroyMirror.adm' -d
'action={deny|delete}&id={objectIDnumber}&password={password}'Parameters
| Parameter | Type | Usage | Default | Description |
|---|---|---|---|---|
| action | string | deny|delete |
The vault deletion action for multi-user vault during destroy mirror request. |
|
| id | long |
Manager-generated ID of the object to delete. |
||
| password | string |
Password of the user making the request |
Response
Returns success or failure status.
JSON response example
Default JSON success or failure response that is shown in Default JSON success response and Default JSON failure response.
Parameters
None other than the default response parameters shown in Common response parameters.