topic Re: Adding an additional URL to a Custom URL Category using XML-API in Automation/API Discussions

Adding an additional URL to a Custom URL Category using XML-API

SCASDNetwork — Tue, 19 Feb 2013 19:45:32 GMT

How can I add an additional URL to an existing Custom URL Category using XML-API. I have been trying variations of the following command:

https://00.0.0.00/api/?type=config&action=set&key=authkey&path=/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys1']/profiles/custom-url-category/entry[@name='MS_WHITE']&element=<member>www.goodsite.com</member>

When I enter this command it returns this error:

<![CDATA[ unexpected here ]]>

Does anyone know how I can make this work. Thank you.

Re: Adding an additional URL to a Custom URL Category using XML-API

SRA — Wed, 20 Feb 2013 01:11:02 GMT

http(s)://hostname/api/?type=config&action=set&xpath=/config/devices/entry/vsys/entry[@name='vsys1']/profiles/custom-url-category/entry[@name='xmltest urlcat']/list&element=<list><member>www.somesite.com</member></list>

Check the FAQ section in the API guide for this and other examples.

Re: Adding an additional URL to a Custom URL Category using XML-API

SCASDNetwork — Wed, 20 Feb 2013 19:03:05 GMT

Hi Savasarala. Thank you for your help. I see the examples in the API Guide now. When I use this command, I geth the following error:

<![CDATA[ -> list -> list has unexpected text. ]]>

Thoughts?

Re: Adding an additional URL to a Custom URL Category using XML-API

cully_bennefield — Thu, 21 Feb 2013 17:19:43 GMT

I have also tried and received the same error...

<msg>

<line>

<![CDATA[ list -> list has unexpected text. ]]>

</line>

</msg>

</response>

Re: Adding an additional URL to a Custom URL Category using XML-API

cully_bennefield — Thu, 21 Feb 2013 21:27:42 GMT

I was able to successfully make this work using the following URL (specific to my site...please excuse the personalized / non obfuscated naming)

https://panorama/api/?type=config&action=set&xpath=/config/shared/profiles/custom-url-category/entry[@name='cully-api-test']/list&element=<member>www.apitest.com</member><member>www.apitest2.com</member><member>www.apitest3.com</member>

I got some info about cli debug from the following thread that was very helpful

https://live.paloaltonetworks.com/message/11766#11766

basically, the <list></list> tags seemed to be interfering with the /list in the URI (I think...)

I'm not sure if this would be a supported method, however it did work

Thanks

Cully

Re: Adding an additional URL to a Custom URL Category using XML-API

SCASDNetwork — Fri, 22 Feb 2013 15:03:25 GMT

Cully's method also worked for me! I simply removed the <list></list> tags from my command and it worked. Thanks Cully!

-CS

Re: Adding an additional URL to a Custom URL Category using XML-API

cully_bennefield — Sat, 23 Feb 2013 04:35:16 GMT

Glad I could help...you wouldn't happen to know anything about using curl to make the api calls would you? I'm struggling with a 'User Not Authorized' error

Re: Adding an additional URL to a Custom URL Category using XML-API

ksteves1 — Mon, 25 Feb 2013 01:11:18 GMT

See the below. The key is use -d for the key= so it is not URL-encoded and --data-urlencode for other parameters.

panxapi from PAN-perl will handle this for you and is a more friendly way to do configuration management using the API without knowing all the API details.

$ cat element.xml

<ip-netmask>10.16.1.10/32</ip-netmask>

$ KEY='cBwvtXHyrHp9EkOmJ/3PxYV5QG9XiMEsJRoBMhhh1Vw='

$ XPATH="/config/devices/entry/vsys/entry/address/entry[@name='smtp-relay']"

$ ELEMENT=`cat element.xml`

$ curl -k https://172.29.9.253/api/ -d "type=config&action=set&key=$KEY" \

> --data-urlencode "xpath=$XPATH" --data-urlencode "element=$ELEMENT"

<response status="success" code="20"><msg>command succeeded</msg></response>

Re: Adding an additional URL to a Custom URL Category using XML-API

cully_bennefield — Tue, 26 Feb 2013 15:04:30 GMT

Awesome - thank you!

after successful tests there I came up with a template for doing it in python (my preferred language). Here's an example of that, this function creates a custom url category and returns the response given by the web server - in case anyone is interested in that.

For debugging / testing it also prints out the URL that would have been passed to the API

import urllib, urllib2

#cat_desc is a description of the url category

#cat_name is the name of the custom url category

def create_url_cat(self, cat_name, cat_desc, action='set'):

self.parameters = dict()

self.parameters['key'] = 'Y/Xt9o0IK8ISYNnzTF4oJ8SpTis7cYMKb2NiNniMuPUPutJN4CuDASu5ni79twT6'

self.parameters['type'] = 'config'

self.parameters['action'] = 'set'

self.url = 'https://panorama/api/?'

self.parameters['action'] = action

self.parameters['xpath'] = '/config/shared/profiles/custom-url-category/entry[@name=\''+ cat_name + '\']'

self.parameters['element'] = '<description>' + cat_desc + '</description>'

params = urllib.urlencode(self.parameters)

response = urllib2.urlopen(self.url, params)

print self.url + str(params)

return response.read()