topic Rest API not seeing template variables in Automation/API Discussions

Rest API not seeing template variables

mrzepa2 — Sun, 30 Oct 2022 15:47:46 GMT

I'm trying to use the REST API to get/set variables on the template stack.

According to the restapi-doc for PANOS 10.1, under the "devices" object, there is an "entry" object which has an Array of objects that contain 2 more objects, the first being "@name" which is the serial number and the second being "variable" which is an object that contains an "entry" and an Array of objects repressing the variable (name, type and value).

When I do my get call, all the info is returned except the "variable" object.

[{'@name': 'sample_Stack',
'description': 'sample description',
'devices': {'entry': [{'@name': '0128001123456'}]},
'templates': {'member': ['sample1',
'sample2',
'sample3']}}]

Anyone else try this and gotten it to work?

From the restapi-doc:

Array

@name

required

string <object-name> <= 63 characters

Alphanumeric string [ 0-9a-zA-Z._-]

description

string <= 255 characters

Description of template stack

devices

object

Device serial numbers

entry

Array of objects

Array

@name

required

string <= 64 characters

Device serial number

variable

object

entry

Array of objects

Array

@name required	string <= 63 characters Variables need to begin with '$'
type required

Re: Rest API not seeing template variables

JimmyHolland — Mon, 31 Oct 2022 13:44:59 GMT

Hi @mrzepa2,

I get the same behaviour, I will investigate further.

Meantime, you can use the XML API, for example:

https://{{host}}/api/?key={{key}}&type=config&action=show&xpath=/config/devices/entry[@name='localhost.localdomain']/template-stack/entry[@name='{{template-stack-name}}']/devices/entry[@name='{{lab-vm1-serial}}']/variable

Re: Rest API not seeing template variables

mrzepa2 — Wed, 02 Nov 2022 15:18:18 GMT

Thanks for the feedback. I look forward to knowing what happened to the REST API access to the variables.

Re: Rest API not seeing template variables

JimmyHolland — Thu, 28 Sep 2023 11:27:49 GMT

FYI: This was fixed in 11.0.2, I just tested successfully on 11.0.2 Panorama. The fix for 10.2 is currently due to be released in 10.2.8 but check release notes in future 10.2.x releases for full confirmation.