Firewall Plan¶

This page describes operations you can perform on firewall_plans. List, and get details for.

List Firewall Plan¶

List all visible firewall_plans.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

GET

HTTP Request Path¶

{endpoint}/v2.0/firewall_plans

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
description	query	string	-	-	Description of the Firewall Plan	no
id	query	string	hyph-uuid	-	Unique ID of the Firewall Plan	no
name	query	string	-	-	Name of the Firewall Plan	no
vendor	query	string	-	[‘vyatta’]	Firewall Type	no
version	query	string	-	-	Firewall Type	no

Response¶

HTTP Response Code List¶

Response Code	Description
200	OK
400	Bad Request
401	UnAuthorized
404	Not Found
500	Internal Server Error

HTTP Response Parameters¶

Parameter	Type	Format	Description
firewall_plans	array<object>	Firewall Plan	-
description	string	-	Description of the Firewall Plan
enabled	boolean	-	Is user allowed to create new firewalls with this plan.
id	string	hyph-uuid	Unique ID of the Firewall Plan
name	string	-	Name of the Firewall Plan
vendor	string	-	Firewall Type
version	string	-	Firewall Type

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "firewall_plans": [
    {
      "description": "",
      "enabled": true,
      "id": "2b757ea7-f346-4297-a598-4d054bc0ae58",
      "name": "firewall-2core-4interface",
      "vendor": "vyatta",
      "version": "3.5R6"
    },
    {
      "description": "aa",
      "enabled": false,
      "id": "693fc635-dba7-457a-a480-56027e75f0f8",
      "name": "test2-1-3_change",
      "vendor": "vyatta",
      "version": "aa"
    }
  ]
}

Show Firewall Plan¶

Show details for firewall_plan.