From 25eac09ce93da1ebf99ade2bca95c3b077a25ac6 Mon Sep 17 00:00:00 2001
From: dlavigne <dru@freebsd.org>
Date: Thu, 21 Apr 2016 13:37:59 -0400
Subject: [PATCH] Doc createsnap action.

---
 api/classes/lifepreserver.rst | 56 ++++++++++++++++++++++++++++++++++-
 1 file changed, 55 insertions(+), 1 deletion(-)

diff --git a/api/classes/lifepreserver.rst b/api/classes/lifepreserver.rst
index 133a4d0..9c09138 100644
--- a/api/classes/lifepreserver.rst
+++ b/api/classes/lifepreserver.rst
@@ -20,7 +20,7 @@ Every lifepreserver class request contains the following parameters:
 | namespace                       | sysadm        |                                                                                                                      |
 |                                 |               |                                                                                                                      |
 +---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
-| action                          |               | supported actions include "listcron", "cronsnap", "cronscrub", "listsnap", "revertsnap", "removesnap",               |
+| action                          |               | supported actions include "listcron", "cronsnap", "cronscrub", "createsnap", "listsnap", "revertsnap", "removesnap", |
 |                                 |               | "addreplication", "removereplication", "listreplication", "runreplication", "initreplication", "settings", and       |
 |                                 |               | "savesettings"                                                                                                       |
 |                                 |               |                                                                                                                      |
@@ -255,6 +255,60 @@ The "cronscrub" action is used to schedule a ZFS scrub. This action supports the
   "name": "response",
   "namespace": "sysadm"
  }
+ 
+.. index:: createsnap, Life Preserver
+ 
+.. _Create a Snapshot:
+
+Create a Snapshot
+=================
+
+The "createsnap" action creates a one-time snapshot of the specified dataset.
+
+**REST Request**
+
+.. code-block:: json 
+
+ PUT /sysadm/lifepreserver
+ {
+   "snap" : "mytestsnap",
+   "dataset" : "tank",
+   "comment" : "Testing",
+   "action" : "createsnap"
+ }
+
+**WebSocket Request**
+
+.. code-block:: json 
+
+ {
+   "args" : {
+      "comment" : "Testing",
+      "dataset" : "tank",
+      "action" : "createsnap",
+      "snap" : "mytestsnap"
+   },
+   "name" : "lifepreserver",
+   "namespace" : "sysadm",
+   "id" : "fooid"
+ }
+
+**Response**
+
+.. code-block:: json 
+
+ {
+  "args": {
+    "createsnap": {
+      "comment": "Testing",
+      "dataset": "tank",
+      "snap": "mytestsnap"
+    }
+  },
+  "id": "fooid",
+  "name": "response",
+  "namespace": "sysadm"
+ }
 
 .. index:: listsnap, Life Preserver