Zone APIs

A protected zone is an object comprised of a group of IP addresses and/or subnets, ports, and protocols that provide a service and are protected as a single entity.

 

Operation	Method	URL Path	Payload
List all Zone APIs	GET	/api/v2/agapi/v1/ddos/zone/?device_group={device-id}
Create a Zone API		/api/v2/agapi/v1/ddos/zone/{zone-id}/schedule/push/	Create a Zone API
Update a Zone API		/api/v2/agapi/v1/ddos/zone//?oper_status=device_cfg_err
Bulk Delete Zone APIs		/api/v2/agapi/v1/ddos/zone-bulk/?action=delete	Bulk Delete Zone APIs
Sync to Device	POST	/api/v2/agapi/v1/ddos/zone/{zone-id}/schedule/push/	Sync to a Device
Search a Device Group in a Zone	GET	/api/v2/agapi/v1/ddos/zone/?device_group={device-id}
Search a Detector Group in a Zone	GET	/api/v2/agapi/v1/ddos/zone/?detector_group={device-id}
Search a Mitigator in a Zone	GET	/api/v2/agapi/v1/ddos/zone/?status=mitigation
Search an Oper Status in a Zone	GET	/api/v2/agapi/v1/ddos/zone/?oper_status=device_cfg_err

Create a Zone API

This creates a zone API.

Sample Request

{"sync_bgp":true}

Sync to a Device

This syncs to a TPS device.

Sample Request

{
    "message": "Zone configuration push scheduled successfully.",
    "code": 200,
    "detail": "1eebf25d-2c1f-4811-b3fa-91bfbdad9f3b"
}

Bulk Delete Zone APIs

Sample Request

{"zone_ids": ["30735de8-fa95-4f56-85ca-976ff561fcd1","d7762774-61a0-45c0-acd9-d0f0e14abcb6"],"force_delete": true }

Response Codes

See Common Response Codes.