some file
GET/api/instance

Get Instance Status

Returns the instance status including whether initial setup is required. This endpoint does not require authentication.

Request

GET
/api/instance
curl -X GET https://api.netbird.io/api/instance \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'

Response

{
  "setup_required": true
}
POST/api/setup

Setup Instance

Creates the initial admin user for the instance. This endpoint does not require authentication but only works when setup is required (no accounts exist and embedded IDP is enabled).

Request-Body Parameters

  • Name
    email
    Type
    string
    Required
    required
    Enum
    Description

    Email address for the admin user

  • Name
    password
    Type
    string
    Required
    required
    Enum
    Possible Values: >=8 characters
    Description

    Password for the admin user (minimum 8 characters)

  • Name
    name
    Type
    string
    Required
    required
    Enum
    Description

    Display name for the admin user (defaults to email if not provided)

Request

POST
/api/setup
curl -X POST https://api.netbird.io/api/setup \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
  "email": "admin@example.com",
  "password": "securepassword123",
  "name": "Admin User"
}'

Response

{
  "user_id": "abc123def456",
  "email": "admin@example.com"
}