JSON API » regions » regions/machines/set
Sets 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 | |
priority | Integer | Priority from 0 to 10. 0 disables the machine for this region. | Yes |
Responses
Code | Description |
---|---|
204 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
Data returned
No data is returned.
Example: With required parameters
http://enswitch.example.com/api/json/regions/machines/set/?auth_username=user;auth_password=password;id=123;machine=1;region=2;priority=3{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
Version | Changes |
---|---|
3.14 | Allow priority 0. |
3.13 | Function added. |