JSON API » machines » machines/delete

Deletes a machine.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of machine to delete.Yes

Responses

CodeDescription
204Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The machine does not exist.

Data returned

No data is returned.

Example: With required parameters

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

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

Change history

VersionChanges
3.13Function added.