JSON API » regions » regions/machines/list
Gets the fields of how machines are used with 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 | |
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. |
400 | The region does not exist. |
Data returned
An array of fields, corresponding to the rows of the regions_machines table in the database.
Example: With required parameters
http://enswitch.example.com/api/json/regions/machines/list/?auth_username=user;auth_password=password;region=123{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "region":123, "machine":1, ... }, { "region":123, "machine":2, ... } ] }
Change history
Version | Changes |
---|---|
3.13 | Function added. |