Skip to content
Netmaker Docs
Search
Ctrl
K
Cancel
GitHub
Discord
About
Architecture
Server Installations
Quick Install
API
Overview
DNS
Get all DNS entries
Gets node DNS entries associated with a network
Delete a DNS entry
Get all DNS entries associated with the network
Create a new DNS entry
Gets custom DNS entries associated with a network
Push DNS entries to nameserver
Hosts
Deletes all EMQX hosts
List all hosts
Updates a Netclient host on Netmaker server
Deletes a Netclient host from Netmaker server
Update keys for a host
To Add Host To Network
To Remove Host from Network
Requests a host to pull
Upgrade a host
Update keys for all hosts
Updates a Netclient host on Netmaker server
Used by clients for "pull" command
Send signal to peer
Remote Access Client
Fetches All Remote Access Clients across all networks
Get all remote access client associated with network
Get an individual remote access client
Update an individual remote access client
Delete an individual remote access client
Get an individual remote access client
Create an individual remote access client
IP Service
Get the current public IP address.
Auth
To Fetch Auth Token for a Host
Authenticate a user to retrieve an authorization token
Networks
Lists all networks
Create a network
Get a network
Update network settings
Delete a network
Get a network ACL (Access Control List)
Update a network ACL (Access Control List)
Update a network ACL (Access Control List)
Nodes
Get all nodes across all networks
Get an individual node
Update an individual node
Delete an individual node
Create an egress gateway
Create an remote access gateway
Delete an egress gateway
Delete an remote access gateway
Gets all nodes associated with network including pending nodes
Delete all legacy nodes from DB.
PRO
Create a relay
Remove a relay
Update an internet gateway
Create an internet gateway
Delete an internet gateway
List users attached to an ingress gateway
Get user's remote access gateways
Attach user to a remote access gateway
Remove user from a remote access gateway
Reset failover for a network
Get failover node
Create failover node
Delete failover node
Failover me
Server
Get the server configuration
Get the server information
Get the server status
Users
Get all users
Get an individual user
Update a user
Create a user
Delete a user
Create a super admin
Check if the server has a super admin
Transfer super admin role to another admin user
Get all pending users
Delete all pending users
Approve a pending user
Delete a pending user
EnrollmentKeys
Lists all EnrollmentKeys for admins
Creates an EnrollmentKey for hosts to register with server and join networks
Updates an EnrollmentKey. Updates are only limited to the relay to use
Deletes an EnrollmentKey from Netmaker server
Handles a Netclient registration with server and add nodes accordingly
Meshclient
Retrieve a file from the file server
GitHub
Discord
Update keys for all hosts
PUT
/api/hosts/keys
Authorizations
oauth
Responses
200
OK
string
400
Bad Request
object
code
integer
message
string
