JSON API » provisioning » provisioning/files/get

Gets provisioning files for a given hardware address, such as a MAC address.

Input parameters

Does not require authentication.

NameTypeDescriptionRequiredDefault value
addressStringHardware address, such as MAC, to get provisioning for.Yes
modelStringModel of requesting handset.Yes
formatString"templates" to return completed templates, "raw" to return raw data.No"templates"
macStringAlias for address, for backwards compatibility.NoEmpty string.
passwordStringPassword for requesting handset.NoEmpty string.
serverStringServer value passed to template.NoEmpty string.
sourceStringIP address of requesting handset.NoEmpty string.
url_baseStringURL base value passed to template.NoEmpty string.

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
404No provisioning file found for specified address and model.

Data returned

Provisioning files with data for specified address.

Example: With required parameters (files truncated for brevity)

http://enswitch.example.com/api/json/provisioning/files/get/?address=00:11:22:33:44:55;model=digium

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "template1":"...", "template2":"", "template_directory":"" } }

Change history

VersionChanges
4.1password input parameter added.
3.14format input parameter added. mac input parameter renamed to address, with mac alias for backwards compatibility.
3.13Function added.