NetBird REST API — EDR Peers

naftiko: 1.0.0-alpha2
info:
  label: NetBird REST API — EDR Peers
  description: 'NetBird REST API — EDR Peers. 3 operations. Lead operation: List all bypassed peers. Self-contained Naftiko
    capability covering one Netbird business surface.'
  tags:
  - Netbird
  - EDR Peers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBIRD_API_KEY: NETBIRD_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbird-edr-peers
    baseUri: https://api.netbird.io
    description: NetBird REST API — EDR Peers business capability. Self-contained, no shared references.
    resources:
    - name: api-peers-edr-bypassed
      path: /api/peers/edr/bypassed
      operations:
      - name: listbypassedpeers
        method: GET
        description: List all bypassed peers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-peers-peer-id-edr-bypass
      path: /api/peers/{peer-id}/edr/bypass
      operations:
      - name: bypasscompliance
        method: POST
        description: Bypass compliance for a non-compliant peer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: revokebypass
        method: DELETE
        description: Revoke compliance bypass for a peer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.NETBIRD_API_KEY}}'
  exposes:
  - type: rest
    namespace: netbird-edr-peers-rest
    port: 8080
    description: REST adapter for NetBird REST API — EDR Peers. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/peers/edr/bypassed
      name: api-peers-edr-bypassed
      description: REST surface for api-peers-edr-bypassed.
      operations:
      - method: GET
        name: listbypassedpeers
        description: List all bypassed peers
        call: netbird-edr-peers.listbypassedpeers
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/peers/{peer-id}/edr/bypass
      name: api-peers-peer-id-edr-bypass
      description: REST surface for api-peers-peer-id-edr-bypass.
      operations:
      - method: POST
        name: bypasscompliance
        description: Bypass compliance for a non-compliant peer
        call: netbird-edr-peers.bypasscompliance
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: revokebypass
        description: Revoke compliance bypass for a peer
        call: netbird-edr-peers.revokebypass
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netbird-edr-peers-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetBird REST API — EDR Peers. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-all-bypassed-peers
      description: List all bypassed peers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-edr-peers.listbypassedpeers
      outputParameters:
      - type: object
        mapping: $.
    - name: bypass-compliance-non-compliant-peer
      description: Bypass compliance for a non-compliant peer
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-edr-peers.bypasscompliance
      outputParameters:
      - type: object
        mapping: $.
    - name: revoke-compliance-bypass-peer
      description: Revoke compliance bypass for a peer
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: netbird-edr-peers.revokebypass
      outputParameters:
      - type: object
        mapping: $.