Configure Accesser API

Edit online

Change the default Accesser protocol type, or change it on a per-device basis.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Configure Accesser API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/configureAccesserAPI.adm HTTP/1.1 Host:{manager.dsnet} globalAccesserProtocolType={soh|s3}&individualAccesserProtocolType[{device1}]={soh|s3}&individualAccesserProtocolType[{device2}]={soh|s3}

Curl method

Edit online

curl -u {admin}:{password} 
     -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/configureAccesserAPI.adm“ 
     -d ”globalAccesserProtocolType={soh|s3}
         &individualAccesserProtocolType[{device1}]={soh|s3}“

Parameters

Edit online
Table 2. Request parameters for Configure Accesser API (configureAccesserAPI) API
Parameter Type Usage Default Description
globalAccesserProtocolType String    
Protocol to use as default for all Accesser devices:
  • soh - Simple Object
  • s3 - Cloud Storage Object

When the system is in container mode, the Simple Object API Type is not supported.

Note: Only S3 is supported for protected vaults deployed on an access pool that supports other interfaces
individualAccesserProtocolType Map    

Protocol to use for given Accesser device.
accessServicePorts Map    
  • The complete set of Accesser device service ports on which the Accesser device is listening.
  • If given, the set is treated as complete and any unspecified service ports would be disabled.
  • Parameter must be given in map format: accessServicePorts[http/s]=8080
  • Value must be 80, 443, 8080, or 8443
  • Custom ports are not currently supported. [example] ====[source,http] ----

”http://localhost:8080/manager/api/json
/1.0/configureAccesserAPI.adm“ -d
”globalAccesserProtocolType=s3
&individualAccesserProtocolType[3]=openstack
&individualAccesserProtocolType[188]=s3
&accessServicePorts[http]=80
&accessServicePorts[http]=8080
&accessServicePorts[https]=443
&accessServicePorts[https]=8443“ ---- ====