summaryrefslogtreecommitdiffstats
path: root/src/share/api/reservation-get-page.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/reservation-get-page.json')
-rw-r--r--src/share/api/reservation-get-page.json27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/share/api/reservation-get-page.json b/src/share/api/reservation-get-page.json
new file mode 100644
index 0000000..6be2b52
--- /dev/null
+++ b/src/share/api/reservation-get-page.json
@@ -0,0 +1,27 @@
+{
+ "access": "read",
+ "avail": "1.6.0",
+ "brief": [
+ "This command retrieves all host reservations or host reservations for a specified subnet by page."
+ ],
+ "cmd-comment": [
+ "The page size limit is mandatory. The subnet-id is optional since version 1.9.0. The source-index and from host-id are optional and default to 0. Values to use to load the next page are returned in responses in a next map."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"reservation-get-page\",",
+ " \"arguments\": {",
+ " \"subnet-id\": <integer>,",
+ " \"limit\": <integer>,",
+ " \"source-index\": <integer>,",
+ " \"from\": <integer>",
+ " }",
+ "}"
+ ],
+ "hook": "host_cmds",
+ "name": "reservation-get-page",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}