JSON API » regions » regions/machines/get

Gets the fields of how a machine is used within a region.

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
machine	Integer	ID of machine.	Yes
region	Integer	ID of region.	Yes

Responses

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

Data returned

Fields of machine within region.

Example: With required parameters

http://enswitch.example.com/api/json/regions/machines/get/?auth_username=user;auth_password=password;machine=1;region=2

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "machine":1, "region":2, "priority":1 } }

Change history

Version	Changes
3.13	Function added.