JSON API » machines » machines/list

Gets the fields of all machines.

Input parameters

Requires authentication and the system role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
statistics	Integer	1 to return only machines with recorded statistics, 0 to return all.	No	0

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

An array of fields, corresponding to the rows of the machines table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/machines/list/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "server":"example1", ... }, { "id":2, "server":"example2", ... } ] }

Change history

Version	Changes
3.13	Function added.