firewall_zones¶

Overview¶

API to add, delete, get, modify firewall zones

Version information¶

Version : v2

URI scheme¶

Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP

Tags¶

firewall_zones : Operations related to firewall_zones

Paths¶

POST operation for firewall_zones¶

POST /firewall_zones

Description¶

Use this operation to add firewall zones

Responses¶

HTTP Code	Description	Schema
200	Resource successfully added	firewall_zones_post_success_schema
400	Failed: bad input parameter	ErrorSchema
401	Unauthorized: Failed Authentication	ErrorSchema
403	Unauthorized: Forbidden	ErrorSchema
405	Failed: Data format unacceptable	ErrorSchema
415	Failed: Data format unacceptable	ErrorSchema
500	Failed: Internal Server Error	ErrorSchema

Produces¶

application/json

Tags¶

firewall_zones

Get operation for firewall_zones¶

GET /firewall_zones

Description¶

Use this operation to get the firewall zones

Responses¶

HTTP Code	Description	Schema
200	API Successfully executed	firewall_zones_response_schema
400	Failed: bad input parameter	ErrorSchema
401	Unauthorized: Failed Authentication	ErrorSchema
403	Unauthorized: Forbidden	ErrorSchema
405	Failed: Data format unacceptable	ErrorSchema
415	Failed: Data format unacceptable	ErrorSchema
500	Failed: Internal Server Error	ErrorSchema

Produces¶

application/json

Tags¶

firewall_zones

PUT operation for firewall_zones¶

PUT /firewall_zones

Description¶

Use this operation to modify firewall zones

Parameters¶

Type	Name	Schema
Body	body optional	firewall_zones_request_schema

Responses¶

HTTP Code	Description	Schema
200	Resource modified added	firewall_zones_put_success_schema
400	Failed: bad input parameter	ErrorSchema
401	Unauthorized: Failed Authentication	ErrorSchema
403	Unauthorized: Forbidden	ErrorSchema
405	Failed: Data format unacceptable	ErrorSchema
415	Failed: Data format unacceptable	ErrorSchema
500	Failed: Internal Server Error	ErrorSchema

Consumes¶

application/json

Produces¶

application/json

Tags¶

firewall_zones

DELETE operation for firewall_zones¶

DELETE /firewall_zones/{deletePathParam}

Description¶

Use this operation to delete firewall zones

Parameters¶

Type	Name	Description	Schema
Path	deletePathParam required	Object Primary Key for DELETE operation	object

Responses¶

HTTP Code	Description	Schema
200	Resource delete added	firewall_zones_delete_success_schema
400	Failed: bad input parameter	ErrorSchema
401	Unauthorized: Failed Authentication	ErrorSchema
403	Unauthorized: Forbidden	ErrorSchema
405	Failed: Data format unacceptable	ErrorSchema
415	Failed: Data format unacceptable	ErrorSchema
500	Failed: Internal Server Error	ErrorSchema

Produces¶

application/json

Tags¶

firewall_zones

Definitions¶

ErrorSchema¶

Name	Schema
errorcode optional	integer
errormessage optional	string

firewall_zones¶

Name	Schema
id optional	id
name optional	name
package_name optional	package_name

firewall_zones_delete_success_schema¶

Name	Schema
firewall_zones optional	firewall_zones

firewall_zones

Name	Description	Schema
message optional	Example : `"resource deleted succesfully"`	string

firewall_zones_post_success_schema¶

Name	Schema
firewall_zones optional	firewall_zones

firewall_zones

Name	Description	Schema
message optional	Example : `"resource added succesfully"`	string

firewall_zones_put_success_schema¶

Name	Schema
firewall_zones optional	firewall_zones

firewall_zones

Name	Description	Schema
message optional	Example : `"resource modified succesfully"`	string

firewall_zones_request_schema¶

Name	Schema
firewall_zones optional	firewall_zones

firewall_zones_response_schema¶

Type : < firewall_zones_response_schema > array

firewall_zones_response_schema

Name	Schema
id optional	id
name optional	name
package_name optional	package_name

id¶

Auto-generated ID to uniquely identify the firewall zone

Type : integer

name¶

The name for the firewall zone

Type : string

package_name¶

Config package name using which the API operation should be performed.

Type : string