View as Markdown

Console API

The Nakama Console API provides server-side access to manage your Nakama instance programmatically, including player accounts, storage, leaderboards, and RPCs.

Authentication #

To communicate with the Nakama Console API, authenticate with a console username and password to receive a JWT. Pass that token as a Bearer token on all subsequent requests.

1
2
3

curl -X POST "https://<your-instance>.nakamacloud.io/v2/console/authenticate" \
  -H "Content-Type: application/json" \
  -d '{"username":"<console-username>","password":"<console-password>"}'

Response:

1
2
3

{
  "token": "<JWT>"
}

Then pass the token in an Authorization header:

1
2

curl "https://<your-instance>.nakamacloud.io/v2/console/account" \
  -H "Authorization: Bearer <token>"
For server-to-server communication, we recommend creating a dedicated console user in Settings > Users and assigning the minimum permissions required.

API Reference #