> For the complete documentation index, see [llms.txt](https://learn.netmaker.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://learn.netmaker.io/references/api.md).

# API

Most actions that can be performed via API can be performed via the UI. We recommend managing your networks using the official netmaker-ui project. However, Netmaker can also be run without the UI, and all functions can be achieved via API calls. If your use case requires using Netmaker without the UI or you need to do some troubleshooting/advanced configuration, using the API directly may help.

## Authentication

API calls must be authenticated via a header of the format:

`-H "Authorization: Bearer <YOUR_SECRET_KEY>"`

There are two methods to obtain YOUR\_SECRET\_KEY:

{% stepper %}
{% step %}

### Using the masterkey

By default, this value is “secret key,” but you should change this on your instance and keep it secure. This value can be set via env var at startup or in a config file (`config/environments/*.yaml`). See the [Server Configuration](/getting-started/server-and-client-management/server-installation/advanced-options.md) documentation for more details.
{% endstep %}

{% step %}

### Using a JWT received for a node

This can be retrieved by calling the `/api/nodes/<network>/authenticate` endpoint, as documented below.
{% endstep %}
{% endstepper %}

## Format of Calls for curl

Requests take the format of:

{% code title="curl example" %}

```bash
curl -H "Authorization: Bearer <YOUR_SECRET_KEY>" \
  -H 'Content-Type: application/json' \
  localhost:8081/api/path/to/endpoint
```

{% endcode %}

## API Documentation

Check the documentation for all available [endpoints](/references/api.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://learn.netmaker.io/references/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.