ddos violation-actions¶

Violation Actions Configuration

violation-actions Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name violation-actions-list

Collection URI /axapi/v3/ddos/violation-actions

Element Name violation-actions

Element URI /axapi/v3/ddos/violation-actions/{name}

Element Attributes violation-actions_attributes

Partition Visibility shared

Schema violation-actions schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ddos/violation-actions	violation-actions attributes
POST /axapi/v3/ddos/violation-actions/ Payload: { "violation-actions": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/ddos/violation-actions	violation-actions attributes
Get Object	GET	/axapi/v3/ddos/violation-actions/{name}	violation-actions attributes
GET /axapi/v3/ddos/violation-actions/a Reponse: { "violation-actions": { "name": "a", "send-notification-only": 0, "uuid": "1f91a2c8-50a3-11ee-a2fd-001fa015fd06", "user-tag": "a", "a10-url": "/axapi/v3/ddos/violation-actions/a" } }
Get List	GET	/axapi/v3/ddos/violation-actions	violation-actions-list
Modify Object	POST	/axapi/v3/ddos/violation-actions/{name}	violation-actions attributes
Replace Object	PUT	/axapi/v3/ddos/violation-actions/{name}	violation-actions attributes
PUT /axapi/v3/ddos/violation-actions/a Payload: { "violation-actions": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/ddos/violation-actions	violation-actions-list
Delete Object	DELETE	/axapi/v3/ddos/violation-actions/{name}	violation-actions attributes
DELETE /axapi/v3/ddos/violation-actions/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

violation-actions-list¶

violation-actions-list is JSON List of violation-actions attributes

violation-actions-list : [

{ violation-actions attributes },

{ violation-actions attributes },

…

]

violation-actions attributes¶

blackhole

Description Blackhole the zone (in minute, 0 means infinite)

Type: number

Range: 0-30

blacklist-src

Description Blacklist-src (in min) (applied only for source action)

Type: number

Range: 1-30

execute-script

Description Specify DDOS script to run (applied only for zone action)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

execute-script-timeout

Description Timeout for script execution (in seconds) (applied only for zone action)

Type: number

Range: 5-20

name

Description DDOS violation-actions name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

notification

Type: List

send-notification-only

Description Forces TPS to only send out notification for the violation-action

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

notification¶

Specification Value

Type list

Block object keys

notification-template

Description Specify the notification template name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ddos/notification-template