NetBird REST API — Services

naftiko: 1.0.0-alpha2
info:
  label: NetBird REST API — Services
  description: 'NetBird REST API — Services. 10 operations. Lead operation: List available proxy clusters. Self-contained
    Naftiko capability covering one Netbird business surface.'
  tags:
  - Netbird
  - Services
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBIRD_API_KEY: NETBIRD_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbird-services
    baseUri: https://api.netbird.io
    description: NetBird REST API — Services business capability. Self-contained, no shared references.
    resources:
    - name: api-reverse-proxies-clusters
      path: /api/reverse-proxies/clusters
      operations:
      - name: get
        method: GET
        description: List available proxy clusters
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-reverse-proxies-domains
      path: /api/reverse-proxies/domains
      operations:
      - name: get
        method: GET
        description: Retrieve Service Domains
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a Custom domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-reverse-proxies-domains-domainId
      path: /api/reverse-proxies/domains/{domainId}
      operations:
      - name: delete
        method: DELETE
        description: Delete a Custom domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: domainId
          in: path
          type: string
          description: The custom domain ID
          required: true
    - name: api-reverse-proxies-domains-domainId-validate
      path: /api/reverse-proxies/domains/{domainId}/validate
      operations:
      - name: get
        method: GET
        description: Validate a custom domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: domainId
          in: path
          type: string
          description: The custom domain ID
          required: true
    - name: api-reverse-proxies-services
      path: /api/reverse-proxies/services
      operations:
      - name: get
        method: GET
        description: List all Services
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-reverse-proxies-services-serviceId
      path: /api/reverse-proxies/services/{serviceId}
      operations:
      - name: get
        method: GET
        description: Retrieve a Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: serviceId
          in: path
          type: string
          description: The unique identifier of a service
          required: true
      - name: put
        method: PUT
        description: Update a Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: serviceId
          in: path
          type: string
          description: The unique identifier of a service
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete a Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: serviceId
          in: path
          type: string
          description: The unique identifier of a service
          required: true
    authentication:
      type: bearer
      token: '{{env.NETBIRD_API_KEY}}'
  exposes:
  - type: rest
    namespace: netbird-services-rest
    port: 8080
    description: REST adapter for NetBird REST API — Services. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/reverse-proxies/clusters
      name: api-reverse-proxies-clusters
      description: REST surface for api-reverse-proxies-clusters.
      operations:
      - method: GET
        name: get
        description: List available proxy clusters
        call: netbird-services.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/reverse-proxies/domains
      name: api-reverse-proxies-domains
      description: REST surface for api-reverse-proxies-domains.
      operations:
      - method: GET
        name: get
        description: Retrieve Service Domains
        call: netbird-services.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create a Custom domain
        call: netbird-services.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/reverse-proxies/domains/{domainid}
      name: api-reverse-proxies-domains-domainid
      description: REST surface for api-reverse-proxies-domains-domainId.
      operations:
      - method: DELETE
        name: delete
        description: Delete a Custom domain
        call: netbird-services.delete
        with:
          domainId: rest.domainId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/reverse-proxies/domains/{domainid}/validate
      name: api-reverse-proxies-domains-domainid-validate
      description: REST surface for api-reverse-proxies-domains-domainId-validate.
      operations:
      - method: GET
        name: get
        description: Validate a custom domain
        call: netbird-services.get
        with:
          domainId: rest.domainId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/reverse-proxies/services
      name: api-reverse-proxies-services
      description: REST surface for api-reverse-proxies-services.
      operations:
      - method: GET
        name: get
        description: List all Services
        call: netbird-services.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create a Service
        call: netbird-services.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/reverse-proxies/services/{serviceid}
      name: api-reverse-proxies-services-serviceid
      description: REST surface for api-reverse-proxies-services-serviceId.
      operations:
      - method: GET
        name: get
        description: Retrieve a Service
        call: netbird-services.get
        with:
          serviceId: rest.serviceId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: Update a Service
        call: netbird-services.put
        with:
          serviceId: rest.serviceId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete a Service
        call: netbird-services.delete
        with:
          serviceId: rest.serviceId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netbird-services-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetBird REST API — Services. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-available-proxy-clusters
      description: List available proxy clusters
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-services.get
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-service-domains
      description: Retrieve Service Domains
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-services.get
      outputParameters:
      - type: object
        mapping: $.
    - name: create-custom-domain
      description: Create a Custom domain
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-services.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-custom-domain
      description: Delete a Custom domain
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: netbird-services.delete
      with:
        domainId: tools.domainId
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-custom-domain
      description: Validate a custom domain
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-services.get
      with:
        domainId: tools.domainId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-services
      description: List all Services
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-services.get
      outputParameters:
      - type: object
        mapping: $.
    - name: create-service
      description: Create a Service
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-services.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-service
      description: Retrieve a Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-services.get
      with:
        serviceId: tools.serviceId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-service
      description: Update a Service
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: netbird-services.put
      with:
        serviceId: tools.serviceId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-service
      description: Delete a Service
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: netbird-services.delete
      with:
        serviceId: tools.serviceId
      outputParameters:
      - type: object
        mapping: $.