NetBird REST API — MSP

naftiko: 1.0.0-alpha2
info:
  label: NetBird REST API — MSP
  description: 'NetBird REST API — MSP. 8 operations. Lead operation: Get MSP tenants. Self-contained Naftiko capability covering
    one Netbird business surface.'
  tags:
  - Netbird
  - MSP
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBIRD_API_KEY: NETBIRD_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbird-msp
    baseUri: https://api.netbird.io
    description: NetBird REST API — MSP business capability. Self-contained, no shared references.
    resources:
    - name: api-integrations-msp-tenants
      path: /api/integrations/msp/tenants
      operations:
      - name: get
        method: GET
        description: Get MSP tenants
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create MSP tenant
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-integrations-msp-tenants-id
      path: /api/integrations/msp/tenants/{id}
      operations:
      - name: put
        method: PUT
        description: Update MSP tenant
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of a tenant account
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-integrations-msp-tenants-id-dns
      path: /api/integrations/msp/tenants/{id}/dns
      operations:
      - name: post
        method: POST
        description: Verify a tenant domain DNS challenge
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of a tenant account
          required: true
    - name: api-integrations-msp-tenants-id-invite
      path: /api/integrations/msp/tenants/{id}/invite
      operations:
      - name: post
        method: POST
        description: Invite existing account as a Tenant to the MSP account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of an existing tenant account
          required: true
      - name: put
        method: PUT
        description: Response by the invited Tenant account owner
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of an existing tenant account
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-integrations-msp-tenants-id-subscription
      path: /api/integrations/msp/tenants/{id}/subscription
      operations:
      - name: post
        method: POST
        description: Create subscription for Tenant
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of a tenant account
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-integrations-msp-tenants-id-unlink
      path: /api/integrations/msp/tenants/{id}/unlink
      operations:
      - name: post
        method: POST
        description: Unlink a tenant
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique identifier of a tenant account
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.NETBIRD_API_KEY}}'
  exposes:
  - type: rest
    namespace: netbird-msp-rest
    port: 8080
    description: REST adapter for NetBird REST API — MSP. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/integrations/msp/tenants
      name: api-integrations-msp-tenants
      description: REST surface for api-integrations-msp-tenants.
      operations:
      - method: GET
        name: get
        description: Get MSP tenants
        call: netbird-msp.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create MSP tenant
        call: netbird-msp.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/integrations/msp/tenants/{id}
      name: api-integrations-msp-tenants-id
      description: REST surface for api-integrations-msp-tenants-id.
      operations:
      - method: PUT
        name: put
        description: Update MSP tenant
        call: netbird-msp.put
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/integrations/msp/tenants/{id}/dns
      name: api-integrations-msp-tenants-id-dns
      description: REST surface for api-integrations-msp-tenants-id-dns.
      operations:
      - method: POST
        name: post
        description: Verify a tenant domain DNS challenge
        call: netbird-msp.post
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/integrations/msp/tenants/{id}/invite
      name: api-integrations-msp-tenants-id-invite
      description: REST surface for api-integrations-msp-tenants-id-invite.
      operations:
      - method: POST
        name: post
        description: Invite existing account as a Tenant to the MSP account
        call: netbird-msp.post
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: Response by the invited Tenant account owner
        call: netbird-msp.put
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/integrations/msp/tenants/{id}/subscription
      name: api-integrations-msp-tenants-id-subscription
      description: REST surface for api-integrations-msp-tenants-id-subscription.
      operations:
      - method: POST
        name: post
        description: Create subscription for Tenant
        call: netbird-msp.post
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/integrations/msp/tenants/{id}/unlink
      name: api-integrations-msp-tenants-id-unlink
      description: REST surface for api-integrations-msp-tenants-id-unlink.
      operations:
      - method: POST
        name: post
        description: Unlink a tenant
        call: netbird-msp.post
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netbird-msp-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetBird REST API — MSP. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-msp-tenants
      description: Get MSP tenants
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-msp.get
      outputParameters:
      - type: object
        mapping: $.
    - name: create-msp-tenant
      description: Create MSP tenant
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-msp.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-msp-tenant
      description: Update MSP tenant
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: netbird-msp.put
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: verify-tenant-domain-dns-challenge
      description: Verify a tenant domain DNS challenge
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-msp.post
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: invite-existing-account-tenant-msp
      description: Invite existing account as a Tenant to the MSP account
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-msp.post
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: response-invited-tenant-account-owner
      description: Response by the invited Tenant account owner
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: netbird-msp.put
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-subscription-tenant
      description: Create subscription for Tenant
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-msp.post
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: unlink-tenant
      description: Unlink a tenant
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-msp.post
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.