Skip to content

Latest commit

 

History

History
273 lines (208 loc) · 4.21 KB

API.md

File metadata and controls

273 lines (208 loc) · 4.21 KB
Raw

hostkeeper REST interface

At the moment the API provides the following routes:

Routes

Get all hosts

Route

GET /api/show

curl example

$ curl -i -X GET -H "Content-Type:application/json" http://[hostkeeper]/api/show

HTTP/1.1 200 OK
X-Powered-By: Express
Content-type: application/json
Access-Control-Allow-Origin: *
Date: Mon, 06 Jul 2015 22:57:54 GMT
Connection: keep-alive
Transfer-Encoding: chunked

Response

{
    "success": true,
    "method": "show",
    "payload": [
        {
            "id": 1,
            "host": "this.is.a.tld.test",
            "ip": "1.2.3.4"
        },
        {
            "id": 2,
            "host": "another.tld.test",
            "ip": "2.3.4.5"
        }
    ]
}

Show specific host

Route

GET /api/show/:host

:host is the host id

curl example

$ curl -i -X GET -H "Content-Type:application/json" http://[hostkeeper]/api/show/2

HTTP/1.1 200 OK
X-Powered-By: Express
Content-type: application/json
Access-Control-Allow-Origin: *
Date: Mon, 12 Jul 2015 15:44:54 GMT
Connection: keep-alive
Transfer-Encoding: chunked

Response

{
    "success": true,
    "method": "show/2",
    "payload": {
        "id": 2,
        "host": "another.tld.test",
        "ip": "2.3.4.5"
    }
}

Create new host

Route

POST /api/add

Request

{
    "host": "test.de",
    "ip": "8.9.10.11"
}

curl example

$ curl -i -X POST -H "Content-Type:application/json" http://[hostkeeper]/api/add \
-d '{"host":"test.de","ip":"8.9.10.11"}'

HTTP/1.1 201 Created
X-Powered-By: Express
Content-type: application/json
Access-Control-Allow-Origin: *
Date: Mon, 06 Jul 2015 22:58:33 GMT
Connection: keep-alive
Transfer-Encoding: chunked

Response

{
    "success": true,
    "method": "add",
    "payload": {
        "id": 3,
        "host": "test.de",
        "ip": "8.9.10.11"
    }
}

Delete specific host

Route

DELETE /api/delete/:host

:host is the host id

curl example

$ curl -i -X DELETE -H "Content-Type:application/json" http://[hostkeeper]/api/delete/3

HTTP/1.1 200 OK
X-Powered-By: Express
Content-type: application/json
Access-Control-Allow-Origin: *
Date: Mon, 06 Jul 2015 22:59:57 GMT
Connection: keep-alive
Transfer-Encoding: chunked

Response

{
    "success": true,
    "method": "delete/3",
    "payload": {
        "id": 3,
        "host": "test.de",
        "ip": "8.9.10.11"
    }
}

Edit existing host

Route

PUT /api/edit/:host

:host is the host id

Request

{
    "host": "this.is.a.adjusted.tld",
    "ip": "3.4.5.6"
}

curl example

$ curl -i -X PUT -H "Content-Type:application/json" http://[hostkeeper]/api/edit/2 \
-d '{"host":"this.is.a.adjusted.tld","ip":"3.4.5.6"}'

HTTP/1.1 200 OK
X-Powered-By: Express
Content-type: application/json
Access-Control-Allow-Origin: *
Date: Mon, 06 Jul 2015 23:01:42 GMT
Connection: keep-alive
Transfer-Encoding: chunked

Response

{
    "success": true,
    "method": "edit/2",
    "payload": {
        "id": 2,
        "host": "this.is.a.adjusted.tld",
        "ip": "34.45.56.67"
    }
}

Reload dnsmasq's hosts file manually

Route

GET /api/update

curl example

$ curl -i -X GET http://[hostkeeper]/api/update

HTTP/1.1 200 OK
X-Powered-By: Express
Content-type: application/json
Access-Control-Allow-Origin: *
Date: Mon, 06 Jul 2015 23:02:23 GMT
Connection: keep-alive
Transfer-Encoding: chunked

Response

{
    "success": true,
    "method": "update"
}

General information

Route

GET /api/info

curl example

$ curl -i -X GET -H "Content-Type:application/json" http://[hostkeeper]/api/info

HTTP/1.1 200 OK
X-Powered-By: Express
Access-Control-Allow-Origin: *
Content-type: application/json
Date: Mon, 20 Jul 2015 18:55:42 GMT
Connection: keep-alive
Transfer-Encoding: chunked

Response

{
    "success": true,
    "method": "info",
    "payload": {
        "hosts": 2,
        "server-ip": "192.168.1.202",
        "node-version": "v0.10.25",
        "dnsmasq-version": "v2.68",
        "uptime": "0:00:35:06"
    }
}