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.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
address | String | Hardware address, such as MAC, to get provisioning for. | Yes | |
model | String | Model of requesting handset. | Yes | |
format | String | "templates" to return completed templates, "raw" to return raw data. | No | "templates" |
mac | String | Alias for address, for backwards compatibility. | No | Empty string. |
password | String | Password for requesting handset. | No | Empty string. |
server | String | Server value passed to template. | No | Empty string. |
source | String | IP address of requesting handset. | No | Empty string. |
url_base | String | URL base value passed to template. | No | Empty string. |
Responses
Code | Description |
---|---|
200 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
404 | No 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
Version | Changes |
---|---|
4.1 | password input parameter added. |
3.14 | format input parameter added. mac input parameter renamed to address, with mac alias for backwards compatibility. |
3.13 | Function added. |