JSON API » provisioning » provisioning/provision1/get

Gets provisioning options available in /etc/enswitch/provision/provision1.conf.

Input parameters

Requires authentication and the residential, user, or wholesale role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes

Responses

CodeDescription
200Success.
204Request successful, but provision1 is not enabled, the file does not exist, or contains no data.
401The authentication details provided are invalid.
402Your role does not allow this.

Data returned

Example: With data in /etc/enswitch/provision/provision1.conf

http://enswitch.example.com/api/json/provisioning/provision1/get/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "options":{ "option_a":"Option A", "option_b":"Option B" } }

Example: With no data

http://enswitch.example.com/api/json/provisioning/provision1/get/?auth_username=user;auth_password=password

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

VersionChanges
3.13Function added.