JSON API » machines » machines/update

Updates an existing 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 update.	Yes
asterisk	Integer	1 if the machine runs Asterisk, 0 if not.	No	Current value.
description	String	Description.	No	Current value.
domain	String	DNS domain.	No	Current value.
ipaddr	String	IP address. May be IPv4 or IPv6. If possible, should be public rather than RFC1918. If the machine has multiple addresses, use the one SIP calls should be delivered to.	No	Current value.
server	String	Hostname without domain.	No	Current value.
sip_port	Integer	Port to deliver SIP calls to. Only used if running Asterisk.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
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.
404	The machine does not exist.

Data returned

No data is returned.

Example: Changing the hostname

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

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.