APB Rule Templates

Manage rule templates

Get rule templates

get

Returns array of all the available rule templates.

Responses

200

successful operation

No content

default

Unexpected error

get

/ruletemplates

HTTPcURLJavaScriptPython

GET /ruletemplates HTTP/1.1
Accept: */*

No content

Create rule template

post

Create a new rule template

Body

application/json

objectOptionalExample: {"name":"template1","description":"template description","rule":{"action":"PERMIT","counters":"ENABLE","matchAll":"DISABLE","type":"ip4","overrideAction":"PUSH_VLAN","protocol":"ipv4","srcIp":"1.1.1.1","srcMask":"2.2.2.2","dstIp":"3.3.3.3","dstMask":"4.4.4.4","ttl":"10","overrideActionValue":1}}

Responses

200

successful operation

No content

default

unexpected error

post

/ruletemplates

HTTPcURLJavaScriptPython

POST /ruletemplates HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "name": "template1",
  "description": "template description",
  "rule": {
    "action": "PERMIT",
    "counters": "ENABLE",
    "matchAll": "DISABLE",
    "type": "ip4",
    "overrideAction": "PUSH_VLAN",
    "protocol": "ipv4",
    "srcIp": "1.1.1.1",
    "srcMask": "2.2.2.2",
    "dstIp": "3.3.3.3",
    "dstMask": "4.4.4.4",
    "ttl": "10",
    "overrideActionValue": 1
  }
}

No content

Update rule template

put

Update an existing rule template by ID.

Path parameters

templateIdstringRequired

ID of the rule template to update.

Body

application/json

objectOptionalExample: {"name":"template1","description":"template description","rule":{"action":"PERMIT","counters":"ENABLE","matchAll":"DISABLE","type":"ip4","overrideAction":"PUSH_VLAN","protocol":"ipv4","srcIp":"1.1.1.1","srcMask":"2.2.2.2","dstIp":"3.3.3.3","dstMask":"4.4.4.4","ttl":"10","overrideActionValue":1}}

Responses

200

Rule template updated successfully.

No content

default

Unexpected error.

put

/ruletemplates/{templateId}

HTTPcURLJavaScriptPython

PUT /ruletemplates/{templateId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "name": "template1",
  "description": "template description",
  "rule": {
    "action": "PERMIT",
    "counters": "ENABLE",
    "matchAll": "DISABLE",
    "type": "ip4",
    "overrideAction": "PUSH_VLAN",
    "protocol": "ipv4",
    "srcIp": "1.1.1.1",
    "srcMask": "2.2.2.2",
    "dstIp": "3.3.3.3",
    "dstMask": "4.4.4.4",
    "ttl": "10",
    "overrideActionValue": 1
  }
}

No content

Delete rule template

delete

Delete a rule template by ID.

Path parameters

templateIdstringRequired

ID of the rule template to delete.

Responses

200

Rule template deleted successfully.

No content

default

Unexpected error.

delete

/ruletemplates/{templateId}

HTTPcURLJavaScriptPython

DELETE /ruletemplates/{templateId} HTTP/1.1
Accept: */*

No content