Request format

The base URLs for all methods in the API are.

JSON	(https://{manager}/manager/api/json/1.0/{method}.adm)
XML	(https://{manager}/manager/api/xml/1.0/{method}.adm)

The string "manager" represents the location of the Manager and must be replaced with a valid host name or IP address.

Each method is accessible through two URLs. One provides JSON formatted response messages and the other provides XML formatted response messages.

Parameters and operations are the same for both URLs.

Note: All appliances must be approved and configured before you create and deploy vaults and storage pools. If an external Active Directory or LDAP server is used for authentication, it must be configured in the Manager UI before external accounts can be created.

JSONP support

Edit online

The Manager REST API supports JSONP requests. Add the parameter callback to any API call and the response is wrapped with a JavaScript function name equal to the value of the callback parameter.

The use of 'callback=alert' would cause the JSON response to be sent to the browser's default alert function.

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/createAccount.adm HTTP/1.1 Host:{manager.dsnet} name={accountName}&username={accountUsername}&password={password}&confirmPassword={password}&rolesMap[{role1}]={true|false}&rolesMap[{role2}]={true|false}&vaultUserPermissions[{vault1}]={disabled|readOnly|readWrite}&vaultUserPermissions[{vault2}]={disabled|readOnly|readWrite}

Curl method

Edit online

curl -X POST -u {admin}:{password} -k “https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/createAccount.adm”-d “{accountName}&username={accountUsername}&password={password}&confirmPassword={password}&rolesMap[{role1}]={true|false}&rolesMap[{role2}]={true|false}&vaultUserPermissions[{vault1}]={disabled|readOnly|readWrite}&vaultUserPermissions[{vault2}]={disabled|readOnly|readWrite}”

Parameters

Edit online

Each request can pass parameters to provide data to the requested API method.

Each API that can accept parameters has a listing of said parameters in a table with these headings:

Table 1. Acceptable values for API Method Parameter listings
Heading	Description
Parameter	Name of key / label that identifies data that is being sent.
Type	Data type of data that is being sent.
Usage	Circumstances under which parameter should be used:
	Value	Reason
	Required	Key/Value must be included in API call for successful response.
	Optional	Key/Value can be included in API call to provide extra data.
	Parameter={true\|false}	Key/Value must be included if listed parameter is true or false.
Default	Value for parameter if no other value is set for it.
Description	Purpose or contents of parameter.

Passwords

Edit online

All passwords are hashed and not sent as clear text.