NetBird MSP API

MSP portal for Tenant management.

Operations 8

GET /api/integrations/msp/tenants Get MSP tenants
POST /api/integrations/msp/tenants Create MSP tenant
PUT /api/integrations/msp/tenants/{id} Update MSP tenant
POST /api/integrations/msp/tenants/{id}/unlink Unlink a tenant
POST /api/integrations/msp/tenants/{id}/dns Verify a tenant domain DNS challenge
POST /api/integrations/msp/tenants/{id}/subscription Create subscription for Tenant
POST /api/integrations/msp/tenants/{id}/invite Invite existing account as a Tenant to the MSP account
PUT /api/integrations/msp/tenants/{id}/invite Response by the invited Tenant account owner

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/netbird-msp-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

netbird-msp-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NetBird REST Accounts MSP API
  description: API to manipulate groups, rules, policies and retrieve information about peers and users
  version: 0.0.1
servers:
- url: https://api.netbird.io
  description: Default server
security:
- BearerAuth: []
- TokenAuth: []
tags:
- name: MSP
  description: MSP portal for Tenant management.
  x-cloud-only: true
paths:
  /api/integrations/msp/tenants:
    get:
      summary: Get MSP tenants
      tags:
      - MSP
      responses:
        '200':
          description: Get MSP tenants response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTenantsResponse'
        '400':
          $ref: '#/components/responses/bad_request'
        '403':
          $ref: '#/components/responses/requires_authentication'
        '500':
          $ref: '#/components/responses/internal_error'
    post:
      summary: Create MSP tenant
      tags:
      - MSP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTenantRequest'
      responses:
        '200':
          description: Create MSP tenant Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantResponse'
        '400':
          $ref: '#/components/responses/bad_request'
        '403':
          $ref: '#/components/responses/requires_authentication'
        '500':
          $ref: '#/components/responses/internal_error'
  /api/integrations/msp/tenants/{id}:
    put:
      summary: Update MSP tenant
      tags:
      - MSP
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique identifier of a tenant account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTenantRequest'
      responses:
        '200':
          description: Update MSP tenant Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantResponse'
        '400':
          $ref: '#/components/responses/bad_request'
        '403':
          $ref: '#/components/responses/requires_authentication'
        '500':
          $ref: '#/components/responses/internal_error'
  /api/integrations/msp/tenants/{id}/unlink:
    post:
      summary: Unlink a tenant
      tags:
      - MSP
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique identifier of a tenant account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                owner:
                  type: string
                  description: The new owners user ID.
                  example: google-oauth2|123456789012345678901
              required:
              - owner
      responses:
        '200':
          description: Successfully unlinked the tenant
        '400':
          $ref: '#/components/responses/bad_request'
        '403':
          $ref: '#/components/responses/requires_authentication'
        '404':
          description: The tenant was not found
        '500':
          $ref: '#/components/responses/internal_error'
  /api/integrations/msp/tenants/{id}/dns:
    post:
      summary: Verify a tenant domain DNS challenge
      tags:
      - MSP
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique identifier of a tenant account
      responses:
        '200':
          description: Successfully verified the DNS challenge
        '400':
          $ref: '#/components/responses/bad_request'
        '403':
          $ref: '#/components/responses/requires_authentication'
        '404':
          description: The tenant was not found
        '500':
          $ref: '#/components/responses/internal_error'
        '501':
          description: DNS Challenge Failed Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DNSChallengeResponse'
  /api/integrations/msp/tenants/{id}/subscription:
    post:
      summary: Create subscription for Tenant
      tags:
      - MSP
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique identifier of a tenant account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                priceID:
                  type: string
                  description: The Price ID to change the subscription to.
                  example: price_1HhxOpBzq4JbCqRmJxkpzL2V
              required:
              - priceID
      responses:
        '200':
          description: Successfully created subscription for Tenant
        '400':
          $ref: '#/components/responses/bad_request'
        '403':
          $ref: '#/components/responses/requires_authentication'
        '404':
          description: The tenant was not found
        '500':
          $ref: '#/components/responses/internal_error'
  /api/integrations/msp/tenants/{id}/invite:
    post:
      summary: Invite existing account as a Tenant to the MSP account
      tags:
      - MSP
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique identifier of an existing tenant account
      responses:
        '200':
          description: Successfully invited existing Tenant to the MSP account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantResponse'
        '400':
          $ref: '#/components/responses/bad_request'
        '403':
          $ref: '#/components/responses/requires_authentication'
        '404':
          description: The tenant was not found
        '500':
          $ref: '#/components/responses/internal_error'
    put:
      summary: Response by the invited Tenant account owner
      tags:
      - MSP
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: The unique identifier of an existing tenant account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                value:
                  type: string
                  description: Accept or decline the invitation.
                  enum:
                  - accept
                  - decline
              required:
              - value
      responses:
        '200':
          description: Successful response
        '400':
          $ref: '#/components/responses/bad_request'
        '403':
          $ref: '#/components/responses/requires_authentication'
        '404':
          description: The tenant was not found
        '500':
          $ref: '#/components/responses/internal_error'
components:
  schemas:
    CreateTenantRequest:
      type: object
      properties:
        name:
          type: string
          description: The name for the MSP tenant
          example: My new tenant
        domain:
          type: string
          description: The name for the MSP tenant
          example: tenant.com
        groups:
          description: MSP users Groups that can access the Tenant and Roles to assume
          type: array
          items:
            $ref: '#/components/schemas/TenantGroupResponse'
      required:
      - name
      - domain
      - groups
    UpdateTenantRequest:
      type: object
      properties:
        name:
          type: string
          description: The name for the MSP tenant
          example: My new tenant
        groups:
          description: MSP users Groups that can access the Tenant and Roles to assume
          type: array
          items:
            $ref: '#/components/schemas/TenantGroupResponse'
      required:
      - name
      - groups
    GetTenantsResponse:
      type: array
      items:
        $ref: '#/components/schemas/TenantResponse'
    TenantGroupResponse:
      type: object
      properties:
        id:
          type: string
          description: The Group ID
          example: ch8i4ug6lnn4g9hqv7m0
        role:
          type: string
          description: The Role name
          example: admin
      required:
      - id
      - role
    TenantResponse:
      type: object
      properties:
        id:
          type: string
          description: The updated MSP tenant account ID
          example: ch8i4ug6lnn4g9hqv7m0
        name:
          type: string
          description: The name for the MSP tenant
          example: My new tenant
        domain:
          type: string
          description: The tenant account domain
          example: tenant.com
        groups:
          description: MSP users Groups that can access the Tenant and Roles to assume
          type: array
          items:
            $ref: '#/components/schemas/TenantGroupResponse'
        activated_at:
          type: string
          format: date-time
          description: The date and time when the tenant was activated.
          example: '2021-08-01T12:00:00Z'
        dns_challenge:
          type: string
          description: The DNS challenge to set in a TXT record
          example: YXNkYSBkYXNhc2Rhc2RhIGFzZGFzZDJhc2QyNDUxNQ
        created_at:
          type: string
          format: date-time
          description: The date and time when the tenant was created.
          example: '2021-08-01T12:00:00Z'
        updated_at:
          type: string
          format: date-time
          description: The date and time when the tenant was last updated.
          example: '2021-08-01T12:00:00Z'
        invited_at:
          type: string
          format: date-time
          description: The date and time when the existing tenant was invited.
          example: '2021-08-01T12:00:00Z'
        status:
          type: string
          description: The status of the tenant
          enum:
          - existing
          - invited
          - pending
          - active
          example: active
      required:
      - id
      - name
      - domain
      - groups
      - created_at
      - updated_at
      - status
      - dns_challenge
    DNSChallengeResponse:
      type: object
      properties:
        dns_challenge:
          type: string
          description: The DNS challenge to set in a TXT record
          example: YXNkYSBkYXNhc2Rhc2RhIGFzZGFzZDJhc2QyNDUxNQ
      required:
      - dns_challenge
  responses:
    requires_authentication:
      description: Requires authentication
      content: {}
    internal_error:
      description: Internal Server Error
      content: {}
    bad_request:
      description: Bad Request
      content: {}
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Enter the token with the `Token` prefix, e.g. "Token nbp_F3f0d.....".