Edit system device level API configuration
Enable or disable an API on each device, which allows access to state information outside of the Manager. Two APIs are available: statistics and health.
Request
Security
| Any | Storage Account Admin | |||
| Super User | ✔ | Vault Provisioner | ||
| System Admin | ✔ | Elastic Device Provisioner | ||
| Security Officer | ||||
| Operator |
HTTP method
POST /manager/api/{apiResponseType}/1.0/editSystemDeviceLevelAPIConfiguration.adm HTTP/1.1
Host:{manager.dsnet}
enabled={true|false}&httpEnabled={true|false}&httpsEnabled={true|false}&deviceTypes={deviceType1}&deviceTypes={deviceType2}&deviceTypes={deviceType3}&authenticated={true|false}
Curl method
curl -u {admin}:{password} -k
"https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editSystemDeviceLevelAPIConfiguration.adm"
-d
"enabled={true|false}&httpEnabled={true|false}&httpsEnabled={true|false}&deviceTypes={deviceType1}&deviceTypes={deviceType2}&deviceTypes={deviceType3}&authenticated={true|false}"
Parameters
Request parameters for Edit System Device Level API
Configuration (editSystemDeviceLevelAPIConfiguration) API method
| Parameter | Type | Usage | Default | Description |
|---|---|---|---|---|
| enabled | Boolean | Required |
Enable device level APIs for at least one of the device types in the system. |
|
| httpEnabled | Boolean | Optional | True when enabled=true | Enable HTTP on port 8192 |
| httpsEnabled | Boolean | Optional | Enable HTTPS on port 8193 | |
| deviceTypes | Set[{deviceType}] | enabled=true |
List of device types to enable device level API. Device types are:
|
|
| authenticated | Boolean | Optional | Enable basic authentication |
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.