APB Maps

Manage device maps

Get all the maps

get

Returns array of all the available maps.

Responses

200

successful operation

No content

default

Unexpected error

get

/maps

HTTPcURLJavaScriptPython

GET /maps HTTP/1.1
Accept: */*

No content

Create map

post

Create a new map

Body

application/json

aliasstringOptionalExample: map1

commentstringOptionalExample: map 1 comment

fromDevicestringOptionalExample: deviceId

toDevicestringOptionalExample: deviceId

fromPortsarrayOptionalExample: ["Ethernet0","Ethernet1"]

toPortsarrayOptionalExample: ["Ethernet0","Ethernet1"]

rulesarrayOptionalExample: [{"comment":"","action":"PERMIT","counters":"ENABLE","matchAll":"DISABLE","type":"ip4","overrideAction":"NONE","protocol":"ipv4","ruleId":1,"srcIp":"1.1.1.1","srcMask":"2.2.2.2","dstIp":"3.3.3.3","dstMask":"4.4.4.4","ttl":"10"}]

Responses

200

successful operation

No content

default

unexpected error

post

/maps

HTTPcURLJavaScriptPython

POST /maps HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "alias": "map1",
  "comment": "map 1 comment",
  "fromDevice": "deviceId",
  "toDevice": "deviceId",
  "fromPorts": [
    "Ethernet0",
    "Ethernet1"
  ],
  "toPorts": [
    "Ethernet0",
    "Ethernet1"
  ],
  "rules": [
    {
      "comment": "",
      "action": "PERMIT",
      "counters": "ENABLE",
      "matchAll": "DISABLE",
      "type": "ip4",
      "overrideAction": "NONE",
      "protocol": "ipv4",
      "ruleId": 1,
      "srcIp": "1.1.1.1",
      "srcMask": "2.2.2.2",
      "dstIp": "3.3.3.3",
      "dstMask": "4.4.4.4",
      "ttl": "10"
    }
  ]
}

No content

Update a map

put

Update an existing map by ID.

Path parameters

mapIdstringRequired

map identifier

Body

application/json

aliasstringOptionalExample: map1

commentstringOptionalExample: map 1 comment

fromDevicestringOptionalExample: deviceId

toDevicestringOptionalExample: deviceId

fromPortsarrayOptionalExample: ["Ethernet0","Ethernet1"]

toPortsarrayOptionalExample: ["Ethernet0","Ethernet1"]

rulesarrayOptionalExample: [{"comment":"","action":"PERMIT","counters":"ENABLE","matchAll":"DISABLE","type":"ip4","overrideAction":"NONE","protocol":"ipv4","ruleId":1,"srcIp":"1.1.1.1","srcMask":"2.2.2.2","dstIp":"3.3.3.3","dstMask":"4.4.4.4","ttl":"10"}]

Responses

200

successful operation

No content

default

unexpected error

put

/maps/{mapId}

HTTPcURLJavaScriptPython

PUT /maps/{mapId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "alias": "map1",
  "comment": "map 1 comment",
  "fromDevice": "deviceId",
  "toDevice": "deviceId",
  "fromPorts": [
    "Ethernet0",
    "Ethernet1"
  ],
  "toPorts": [
    "Ethernet0",
    "Ethernet1"
  ],
  "rules": [
    {
      "comment": "",
      "action": "PERMIT",
      "counters": "ENABLE",
      "matchAll": "DISABLE",
      "type": "ip4",
      "overrideAction": "NONE",
      "protocol": "ipv4",
      "ruleId": 1,
      "srcIp": "1.1.1.1",
      "srcMask": "2.2.2.2",
      "dstIp": "3.3.3.3",
      "dstMask": "4.4.4.4",
      "ttl": "10"
    }
  ]
}

No content

Delete a map

delete

Delete a specific map by ID.

Path parameters

mapIdstringRequired

map identifier

Responses

200

successful operation

No content

default

unexpected error

delete

/maps/{mapId}

HTTPcURLJavaScriptPython

DELETE /maps/{mapId} HTTP/1.1
Accept: */*

No content

Get map status

get

Returns the status of a specific map by ID.

Path parameters

mapIdstringRequired

map identifier

Responses

200

successful operation

No content

default

unexpected error

get

/maps/{mapId}/status

HTTPcURLJavaScriptPython

GET /maps/{mapId}/status HTTP/1.1
Accept: */*

No content

Get map counters

get

Returns the counters of a specific map by ID.

Path parameters

mapIdstringRequired

map identifier

Responses

200

successful operation

No content

default

unexpected error

get

/maps/{mapId}/counters

HTTPcURLJavaScriptPython

GET /maps/{mapId}/counters HTTP/1.1
Accept: */*

No content

Get map rule status

get

Returns the status of a specific rule within a map.

Path parameters

mapIdstringRequired

map identifier

ruleIdstringRequired

rule identifier

Responses

200

successful operation

No content

default

unexpected error

get

/maps/{mapId}/rules/{ruleId}/status

HTTPcURLJavaScriptPython

GET /maps/{mapId}/rules/{ruleId}/status HTTP/1.1
Accept: */*

No content