Activate Anomaly Detection
# Activate Anomaly Detection ### `PUT /intelligence/anomaly/settings` Activates Anomaly Detection for an account ID and sets the initial thresholds for detection triggers. ## HTTP Request [PUT https://thingspace.verizon.com/api/m2m/v1/intelligence/anomaly/settings](/docs/premium-apis/thingspace-intelligence/api-endpoints/anomaly-settings/activateanomalydetection) ## Resource Path and Query Parameters None. ## Header Parameters The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON. For more details on how to get these tokens, visit [Getting Started](https://thingspace.verizon.com/documentation/api-documentation.html#/http/session-management/guides/getting-started). | Parameter Name | Data Type | Description | |:-----------------------|:-----------|:-----------------------------------------------------------------------------| | **Authorization** <br> _required_ | string | HTTP Authorization bearer token: <br> `Authorization: Bearer {token}` | | **VZ-M2M-Token** <br> _required_ | string | A valid session token: <br> `VZ-M2M-Token: {M2Mtoken}` | | **Content-Type** <br> _required_ | string | Must be application/json: <br> `Content-Type: application/json` | ## Request Body The request body identifies the account that Anomaly Detection willl be activated for and sets initial maximums for abnormal and very abnormal and if abnormal, very abnormal or both will be monitored. | Parameter Name | Data Type | Description | |:----------------------------------------------------------------------|:---------|:--------------------------------------------------------------------------------------------------------------------------------------------| | **accountName** _(required)_ | string | The name of a billing account. An account name is usually numeric, and must include any leading zeros. | | **requestType** *(required)* | string | The type of request being made. `anomaly` is the request to activate Anomaly Detection | | **sensitivityParameter** | object | The initial values and monitoring state for abnormal and very abnormal. | | **sensitivityParameter.abnormalMaxValue** <br> *(required if being monitored)* | string | The maximum value of the threshold in the units being measured. | | **sensitivityParameter.enableAbnormal** *(required)* | boolean | If abnomal values are being monitored. <br> `true` - Monitor for abnormal values, <br> `false` - Do not monitor for abnormal values | | **sensitivityParameter.enableVeryAbnormal** *(required)* | boolean | If very abnomal values are being monitored. <br> `true` - Monitor for very abnormal values <br> `false` - Do not monitor for very abnormal values | | **sensitivityParameter.veryAbnormalMaxValue** <br> *(required if being monitored)* | string | The maximum value of the threshold in the units being measured. | ### Example Request ``` json { "accountName": "0000123456-00001", "requestType": "anomaly", "sensitivityParameter": [ { "abnormalMaxValue": 1.1, "enableAbnormal": true, "enableVeryAbnormal": true, "veryAbnormalMaxValue": 0.55 } ] } ``` ## Success Responses Status 200 ### Example Success Response ``` json { "status": "Success" } ``` ## Failure Responses Status 400 All error messages are returned in this format: ``` json { "errorCode": "error code string", "errorMessage": "error message string" } ```