JSON API » machines » machines/create

Creates a new machine.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
serverStringHostname without domain.Yes
ipaddrStringIP 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.Yes
asteriskInteger1 if the machine runs Asterisk, 0 if not.No0
descriptionStringDescription.NoEmpty string.
domainStringDNS domain.NoEmpty string.
sip_portIntegerPort to deliver SIP calls to. Only used if running Asterisk.No5060
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
200Success.
201Input passed validation. Only returned if validation=1.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.

Data returned

The ID of the created machine.

Example: With required parameters

http://enswitch.example.com/api/json/machines/create/?auth_username=user;auth_password=password;server=example;ipaddr=1.2.3.4

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

VersionChanges
3.13Function added.