diff --git a/api/classes/iocage.rst b/api/classes/iocage.rst index ea4af6f..2ae47bb 100644 --- a/api/classes/iocage.rst +++ b/api/classes/iocage.rst @@ -21,8 +21,8 @@ Every iocage class request contains the following parameters: | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ | action | | supported actions include "getdefaultsettings", "listjails", "getjailsettings", "startjail", "stopjail", | -| | | "capjail", "clonejail", "createjail", "cleanjails", "cleanreleases", "cleantemplates", "cleanall", "activatepool", | -| | | and "deactivatepool" | +| | | "capjail", "clonejail", "createjail", "destroyjail", "cleanjails", "cleanreleases", "cleantemplates", "cleanall", | +| | | "activatepool", and "deactivatepool" | | | | | +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+ @@ -1044,6 +1044,56 @@ of available switches. "namespace": "sysadm" } + .. index:: destroyjail, iocage + +.. _Destroy a Jail: + +Destroy a Jail +============== + +The "destroyjail" action destroys the specified jail. This action is irreversible and does not prompt for confirmation, but will fail if the jail is running. + +**REST Request** + +.. code-block:: json + + PUT /sysadm/iocage + { + "action" : "destroyjail", + "jail" : "test" + } + +**WebSocket Request** + +.. code-block:: json + + { + "args" : { + "action" : "destroyjail", + "jail" : "test" + }, + "name" : "iocage", + "id" : "fooid", + "namespace" : "sysadm" + } + +**Response** + +.. code-block:: json + + { + "args": { + "destroyjail": { + "success": { + "Destroying": " 3030c554-d05e-11e5-8209-d05099728dbf" + } + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" + } + .. index:: cleanjails, iocage .. _Clean Jails: