Edit vault proxy settings

Edit online

Configure proxy settings to provide transparent access to data stored in an S3 bucket, DDN WOS system, or another internal vault as if it were stored in a vault. Proxy is not supported by protected vaults.

Note: By default, vault proxy is turned off for all vaults.

Request

Edit online

Security

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

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/editVaultProxySettings.adm HTTP/1.1 Host:{manager.dsnet} id={vaultId}&enabled={true|false}&proxyType={s3|wos|internal}&endPointUrl={s3URL}&bucketName={bucket}&accessKeyId={accessKeyId}&secreteAccessKey={secretAccessKey}&username={username}&password={password}&internalProxyVaultId={vaultId}

Curl method

Edit online

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editVaultProxySettings.adm“ -d ”id={vaultId}&enabled={true|false}&proxyType={s3|wos|internal}&endPointUrl={s3URL}&bucketName={bucket}&accessKeyId={accessKeyId}&secreteAccessKey={secretAccessKey}&username={username}&password={password}&internalProxyVaultId={vaultId}“

Parameters

Edit online
Table 2. Request parameters for Edit Vault Proxy Settings (editVaultProxySettings) API method
Parameter Type Usage Default Description
id Long Required  

ID for vault.
enabled Boolean Required  

Enable device proxy settings on vault.
proxyType String Required  

Type of proxy to use (S3, DDN WOS, Internal).
endPointUrl String Optional  

Endpoint URL for vault proxy (for example, http://s3.amazonaws.com). Needed for S3 and DDN WOS proxies.
bucketName String Optional  

Bucket name for vault proxy.
accessKeyId String Optional  

Access Key ID for S3 vault proxy.
secretAccessKey String Optional  

Secret Access Key for S3 vault proxy.
username String Optional  

User name for DDN WOS vault proxy.
password String Optional  

Secret Access Key for DDN WOS vault proxy.
internalProxyVaultId Long Optional  

ID of the vault to internally proxy. Needed for internal proxy.