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.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
regionIntegerID of region.Yes

Responses

CodeDescription
200Success.
401The authentication details provided are invalid.
402Your role does not allow this.
400The 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

VersionChanges
3.13Function added.