NetBird REST API — Instance

naftiko: 1.0.0-alpha2
info:
  label: NetBird REST API — Instance
  description: 'NetBird REST API — Instance. 3 operations. Lead operation: Get Instance Status. Self-contained Naftiko capability
    covering one Netbird business surface.'
  tags:
  - Netbird
  - Instance
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBIRD_API_KEY: NETBIRD_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbird-instance
    baseUri: https://api.netbird.io
    description: NetBird REST API — Instance business capability. Self-contained, no shared references.
    resources:
    - name: api-instance
      path: /api/instance
      operations:
      - name: get
        method: GET
        description: Get Instance Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-instance-version
      path: /api/instance/version
      operations:
      - name: get
        method: GET
        description: Get Version Info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-setup
      path: /api/setup
      operations:
      - name: post
        method: POST
        description: Setup Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - 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-instance-rest
    port: 8080
    description: REST adapter for NetBird REST API — Instance. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/instance
      name: api-instance
      description: REST surface for api-instance.
      operations:
      - method: GET
        name: get
        description: Get Instance Status
        call: netbird-instance.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/instance/version
      name: api-instance-version
      description: REST surface for api-instance-version.
      operations:
      - method: GET
        name: get
        description: Get Version Info
        call: netbird-instance.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/setup
      name: api-setup
      description: REST surface for api-setup.
      operations:
      - method: POST
        name: post
        description: Setup Instance
        call: netbird-instance.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netbird-instance-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetBird REST API — Instance. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-instance-status
      description: Get Instance Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-instance.get
      outputParameters:
      - type: object
        mapping: $.
    - name: get-version-info
      description: Get Version Info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-instance.get
      outputParameters:
      - type: object
        mapping: $.
    - name: setup-instance
      description: Setup Instance
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-instance.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.