JSON API » machines » machines/get

Gets the fields of a machine.

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
id	Integer	ID of machine to get.	Yes, unless server is specified.	0
server	String	Host name of machine to get.	Yes, unless id is specified.	Empty string.

Either the id or the server must be specified, but not both.

Responses

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

Data returned

Fields of machine.

Example: With id

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "server":"example", ... } }

Change history

Version	Changes
3.13	Function added.