topic API + (new) zones in General Topics

API + (new) zones

Torsten_Greulich — Tue, 08 Jan 2019 11:52:50 GMT

Hey all,

i have started to work with the API and Postman lately in order help with making the setup process of new boxes a little easier & faster. While I have been able to get most of the basics done (Management IP, DNS, NTP, etc.) I am now struggling with creating new objects in the configuration through the API, starting with the zones that I want to use.

When I run some tests and use "get" in order to check for some existing objects everything seems to work fine, but as soon as I switch to "set" and try to define new objects I always get a "Malformed Request" feedback through Postman.

Here is one example I have used for testing today:

https://{{HOST}}/api/?type=config&key={{key}}&action=set&xpath=/config/devices/entry/vsys/entry/zone/entry[@name='{{zone-intern}}']&element=<network><layer3><member>ethernet1/3</member></layer3></network>

Any clues on how to approach those issues (not for zone settings only)? Are there any elementy that MUST be included (like the network type) when creating certain objects that are documented somewhere?

Thanks!

Torsten

edit: corrected a mistake in the code part

Re: API + (new) zones

Torsten_Greulich — Tue, 08 Jan 2019 12:09:07 GMT

Update: made a little progress, been testing around with using the "complete" action for a bit and seeing what next commands I could use or try out. Am now able to at least create the zone using this command:

https://{{HOST}}/api/?type=config&key={{key}}&action=set&xpath=/config/devices/entry/vsys/entry/zone&element=<entry name='{{zone-dmz}}'/>

Now to find a way to add additional configuration elements (layer, interface, etc.).

Re: API + (new) zones

Torsten_Greulich — Tue, 08 Jan 2019 12:21:02 GMT

Ok, found it. Only had to swap some details around.

https://{{HOST}}/api/?type=config&key={{key}}&action=set&xpath=/config/devices/entry/vsys/entry/zone/entry[@name='{{zone-dmz}}']&element=<network><layer3><member>ethernet1/3</member></layer3></network>

Now to optimize this whole setup...