Quickstart
This guide gets you set up to use the Netzilo API. You create an access token, check that it works, and make your first request with cURL.
Install cURL
This guide uses cURL. If you do not have it yet, download it from the cURL website.
Get an access token
For scripts and automation, create a token for an Agent, a non-login user that belongs to no specific person:
- In the Netzilo dashboard, go to Team > Agents and click Create Agent. Choose the role Admin to change objects, or User to only read.
- Open the Agent, and under Access Tokens click Create Access Token.
- Copy the token. It starts with
nzl_and is shown only once.
To try the API as yourself instead, open the user menu, choose Profile Settings, and
create a token under Access Tokens. On a self-hosted server, use your own dashboard
address instead of go.netzilo.com. See Authentication for
details.
Check your server and token
The API lives at https://srv.netzilo.com/api on Netzilo Cloud, and at
https://<your domain>/api on a self-hosted server. A request without a token answers
401, which proves the server is reachable:
curl -sS -o /dev/null -w '%{http_code}\n' https://srv.netzilo.com/api/users
With your token, find yourself in the user list and check your role:
curl -sS https://srv.netzilo.com/api/users \
-H 'Accept: application/json' \
-H 'Authorization: Token nzl_...' | jq '.[] | select(.is_current) | {name, role, is_service_user}'
Make your first request
List all peers in your network:
curl -X GET https://srv.netzilo.com/api/peers \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
Replace <TOKEN> with your token, and the address with your own on a self-hosted server.

