Commit Graph

14 Commits

Author SHA1 Message Date
dlavigne
f570e39d04 Doc query. 2016-01-13 14:51:20 -05:00
dlavigne
9f2dfc91a9 Doc addreplication action. 2016-01-13 10:01:41 -05:00
dlavigne
5d834fabbd Doc savesettings action. 2016-01-12 14:57:45 -05:00
dlavigne
87196e7053 Doc removesnap action. 2016-01-12 14:17:24 -05:00
dlavigne
ddf29f2148 Document revertsnap action. 2016-01-12 14:10:11 -05:00
dlavigne
dfbfb3afb1 Update listcron example to include scrubs. 2016-01-12 13:28:15 -05:00
dlavigne
bb88295d44 Document cronscrub action. 2016-01-12 13:17:48 -05:00
dlavigne
97c0c1912d Format cronsnap parameters as a table. 2016-01-12 12:44:38 -05:00
Kris Moore
cbf3ce8b8b Add new API call to schedule a cron scrub
Frequency Options: none, daily@XX, weekly@YY@XX, monthly@ZZ@XX
XX = Hour to execute, YY = Day of week to execute, ZZ = Day of month

REST Request:
-------------------------------
PUT /sysadm/lifepreserver
{
   "action" : "cronscrub",
   "pool" : "tank",
   "frequency" : "daily@22"
}

REST Response:
-------------------------------
{
    "args": {
        "cronscrub": {
            "frequency": "daily@22",
            "pool": "tank"
        }
    }
}

WebSocket Request:
-------------------------------
{
   "args" : {
      "action" : "cronscrub",
      "pool" : "tank",
      "frequency" : "daily@22"
   },
   "namespace" : "sysadm",
   "name" : "lifepreserver",
   "id" : "fooid"
}

WebSocket Response:
-------------------------------
{
  "args": {
    "cronscrub": {
      "frequency": "daily@22",
      "pool": "tank"
    }
  },
  "id": "fooid",
  "name": "response",
  "namespace": "sysadm"
}
2016-01-12 12:12:19 -05:00
dlavigne
4595487578 Doc 3 more API actions. 2016-01-11 11:11:11 -05:00
dlavigne
25ecc6f813 Add first action for lifepresever class. 2016-01-07 11:43:17 -05:00
dlavigne
4ee7c0e70d Finish formatting packages class. 2015-12-09 09:57:17 -05:00
dlavigne
538ba5cc1d Start reformat of packages to fit layout. 2015-12-08 15:12:06 -05:00
Kris Moore
611b5f45cc Move over the API docs from pcbsd repo 2015-12-08 14:44:47 -05:00