088f2684df
* Get Group api test * Initial Group Tests * Most Delete Group Tests * Group Tests Complete * Refactor tests and move to test dir * Refactor tests and move to test dir * changed wirecat --> netmaker. Changed defaults to be more sensible * putting netmaker default port 1 above WG port to avoid conflicts with preexisting setups * fixed client side for multinet and added group filter to query params server side. * fixed client side for multinet and added group filter to query params server side. * cleaned up netclient uninstall for multiple networks * added access token for ease of configuration * added access token for ease of configuration * peer update functionality * auto delete timestamp works * Arm docker (#1) * learning github actions * pubish docker * pubish docker * fixt uses * docker git action * rm arm7 * more events and tags * fixed yml file * simplified workflow * simplified workflow * fix missing tags * another fix to yml * another fix to yml * fixing yml * another try * tags * remove ghaction-docker-meta * separate actions for dev & master Co-authored-by: Matthew R Kasun <mkasun@nusak.ca> Co-authored-by: Matthew R Kasun <mkasun@nusak.ca> Co-authored-by: afeiszli <alex.feiszli@gmail.com> Co-authored-by: Alex <31018251+afeiszli@users.noreply.github.com>
3.4 KiB
API Reference Doc
Nodes
Get Peer List: "/api/{group}/peerlist", "GET"
Get List Last Modified Date: "/api/{group}/lastmodified", "GET"
Get Node Details: "/api/{group}/nodes/{macaddress}", "GET"
Create Node: "/api/{group}/nodes", "POST"
Uncordon Node: "/api/{group}/nodes/{macaddress}/uncordon", "POST"
Check In Node: "/api/{group}/nodes/{macaddress}/checkin", "POST"
Update Node: "/api/{group}/nodes/{macaddress}", "PUT"
Delete Node: "/api/{group}/nodes/{macaddress}", "DELETE"
Get Group Nodes: "/api/{group}/nodes", "GET"
Get All Nodes: "/api/nodes", "GET"
Authenticate: "/api/{group}/authenticate", "POST"
Groups
Get Groups: "/api/groups", "GET"
Get Group Details: "/api/group/{groupname}", "GET"
Get Number of Nodes in Group: "/api/group/{groupname}/numnodes", "GET"
Create Group: "/api/groups", "POST"
Update Group: "/api/groups/{groupname}", "PUT"
Delete Group: "/api/groups/{groupname}", "DELETE"
Create Access Key: "/api/groups/{groupname}/keys", "POST"
Get Access Key: "/api/groups/{groupname}/keys", "GET"
Delete Access Key: "/api/groups/{groupname}/keys/{keyname}", "DELETE"
Users (only used for interface admin user at this time)
Create Admin User: "/users/createadmin", "POST"
Check for Admin User: "/users/hasadmin", "GET"
Update User: "/users/{username}", "PUT"
Delete User: "/users/{username}", "DELETE"
Get User: "/users/{username}", "GET"
Authenticate User: "/users/authenticate", "POST"
*note: users API does not use /api/ because of a weird bug. Will fix in future release. **note: Only able to create Admin at this time. The "user" is only used by the user interface to authenticate the single admin user.
Files
Get File: "/meshclient/files/{filename}", "GET"
Example API CALLS
Note About Token: This is a configurable value stored under config/environments/dev.yaml and can be changed before startup. It's a hack for testing, just provides an easy way to authorize, and should be removed and changed in the future.
Create a Group
curl -d '{"addressrange":"10.70.0.0/16","nameid":"skynet"}' -H "Authorization: Bearer secretkey" -H 'Content-Type: application/json' localhost:8081/api/groups
Create a Key
curl -d '{"uses":10}' -H "Authorization: Bearer secretkey" -H 'Content-Type: application/json' localhost:8081/api/groups localhost:8081/api/groups/skynet/keys
Create a Node
curl -d '{ "endpoint": 100.200.100.200, "publickey": aorijqalrik3ajflaqrdajhkr,"macaddress": "8c:90:b5:06:f1:d9","password": "reallysecret","localaddress": "172.16.16.1","accesskey": "aA3bVG0rnItIRXDx","listenport": 6400}' -H 'Content-Type: application/json' -H "authorization: Bearer secretkey" localhost:8081/api/skynet/nodes
Get Groups
curl -H "Authorization: Bearer secretkey" -H 'Content-Type: application/json' localhost:8081/api/groups | jq
Get Group Nodes
curl -H "Authorization: Bearer secretkey" -H 'Content-Type: application/json' localhost:8081/api/skynet/nodes | jq
Update Node Settings
curl -X "PUT" -d '{"name":"my-laptop"}' -H 'Content-Type: application/json' -H "authorization: Bearer secretkey" localhost:8081/api/skynet/nodes/8c:90:b5:06:f1:d9
Delete a Node
curl -X "DELETE" -H "authorization: Bearer secretkey" localhost:8081/api/skynet/nodes/8c:90:b5:06:f1:d9