1 Commits

Author SHA1 Message Date
c71e605abd [mod] modified readme to include query string support
- considered experimental until more test coverage is done
2021-03-07 20:00:10 -05:00

View File

@@ -48,7 +48,7 @@ http post $API_SERVER/admin/client $API_KEY <<< $JSON_REQUEST_BODY
# Alternatively using query strings (be sure to encode special characters in the param values)
API_KEY='X-API-Key=MdSUxrQQ.d5d40cd9.e2s1BsQEqmSE5MqyHYbDBVxGr/KY4BYIV5QkdjiCOF0='
CLIENT_PARAMS='name=clientA&description=Client+across+the+river&permission=rw&public_ip=false'
http post $API_SERVER/admin/client?$API_KEY&$CLIENT_PARAMS
http post "$API_SERVER/admin/client?$API_KEY&$CLIENT_PARAMS"
```
Updating a write client's `ipv4`:
```bash
@@ -72,7 +72,7 @@ API_SERVER=http://localhost:3000/rynDNS
API_KEY=X-API-Key:zW3If4s5.28aef5cb.d502cb94ba0802c6363f95ecb3a70de7e2e4b889779e435b7c033f2c72ed4f20
CLIENT_NAME=write_client
http get $API_SERVER/clients/$CLIENT_NAME $ API_KEY
http get $API_SERVER/clients/$CLIENT_NAME $API_KEY
# returns clients name and ipv4 as json
#{