Created API Domains (markdown)

2017-10-01 19:57:45 +02:00 · 2017-10-01 19:57:45 +02:00 · 9f92ab57a0
parent 1f4bed81cf
commit 9f92ab57a0
1 changed files with 57 additions and 0 deletions
--- a/API-Domains.md
+++ b/API-Domains.md
@ -0,0 +1,57 @@
+# Domains
+## Get list of domains
+`GET /api/domains?query=foo&sort=id-asc,name-desc,type-asc,records-asc`
+
+### Response
+```json
+{
+  "pages": {
+    "current": 21,
+    "total": 42
+  },
+  "results": [
+    {
+      "id": 1,
+      "name": "example.com",
+      "type": "MASTER",
+      "records": 21
+    }
+  ]
+}
+```
+
+## Create new domain
+`POST /api/domains`
+
+### Body
+```json
+{
+  "name": "example.com",
+  "type": "MASTER"
+}
+```
+
+### Response
+```json
+{
+  "id": 21
+  "name": "example.com",
+  "type": "MASTER"
+}
+```
+
+## Delete domain
+`DELETE /api/domains/{id}`
+
+## Get single domain
+`GET /api/domains/{id}`
+
+### Response
+```json
+{
+  "id": 1,
+  "name": "example.com",
+  "type": "MASTER",
+  "records": 21
+}
+```