Edit mirror access control

Update the IP addresses that have access to write to vaults in a mirror.

Request

Security

Table 1. Roles capable of executing the Edit Mirror Access Control (editMirrorAccessControl) API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

POST /manager/api/{apiResponseType}/1.0/editMirrorAccessControl.adm HTTP/1.1 Host:{manager.dsnet} id={mirrorId}&allowedIps={ip1}&accessMap[{ip2},{ip3}]={add|remove}

Curl method

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editMirrorAccessControl.adm“ -d ”id={mirrorId}&allowedIps={ip1}&accessMap[{ip2}]={add|remove}“

Parameters

Table 2. Request Parameters for Edit Mirror Access Control (editMirrorAccessControl) API method
Parameter Type Usage Default Description
id Long Required  

ID of the mirror.

allowedIps String Optional  
  • A list of IP addresses to provide access to mirror.
  • Should contain full set of IP addresses for mirror.
accessPoolMap Map[{ipAddress}] Optional  

IDs of Access Pools to grant or revoke access to this vault template with value of `{add.

Response

Returns success or failure status.

HTTP response codes

  • 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

{
  ”responseStatus“: ”ok“,
  ”responseHeader“: {
    ”status“: ”ok“,
    ”now“: 1394746536546,
    ”requestId“: null
  },
  ”responseData“: {}
}