visibility anomaly-detection¶

Anomaly detection parameters

anomaly-detection Specification¶

Parameter Value

Type Configuration Resource

Element Name anomaly-detection

Element URI /axapi/v3/visibility/anomaly-detection

Element Attributes anomaly-detection_attributes

Partition Visibility shared

Schema anomaly-detection schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/visibility/anomaly-detection	anomaly-detection attributes
POST /axapi/v3/visibility/anomaly-detection Payload: { "anomaly-detection": { "feature-status": "enable" } }
Get Object	GET	/axapi/v3/visibility/anomaly-detection	anomaly-detection attributes
GET /axapi/v3/visibility/anomaly-detection Reponse: { "anomaly-detection": { "feature-status": "enable", "logging": "disable", "uuid": "db1e4536-6612-11d9-9a27-692335d4f00d", "a10-url": "/axapi/v3/visibility/anomaly-detection" } }
Modify Object	POST	/axapi/v3/visibility/anomaly-detection	anomaly-detection attributes
Replace Object	PUT	/axapi/v3/visibility/anomaly-detection	anomaly-detection attributes
PUT /axapi/v3/visibility/anomaly-detection Payload: { "anomaly-detection": { "feature-status": "disable" } }
Delete Object	DELETE	/axapi/v3/visibility/anomaly-detection	anomaly-detection attributes
DELETE /axapi/v3/visibility/anomaly-detection Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

anomaly-detection attributes¶

feature-status

Description ‘enable’: Enable anomaly-detection (Not valid for source-nat-ip and source monitor types); ‘disable’: Disable anomaly detection (default);

Type: string

Supported Values: enable, disable

Default: disable

logging

Description ‘per-entity’: Enable per entity logging; ‘per-metric’: Enable per metric logging with threshold details; ‘disable’: Disable anomaly notifications (Default);

Type: string

Supported Values: per-entity, per-metric, disable

Default: disable

restart-learning-on-anomaly

Description Relearn anomaly detection parameters after detecting an anomaly

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sensitivity

Description ‘high’: Highly sensitive anomaly detection. Can lead to false positives; ‘low’: Low sensitivity anomaly detection. Can cause delay in detection and might not detect certain attacks. (default);

Type: string

Supported Values: high, low

Default: low

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters