NetBird REST API — Jobs

naftiko: 1.0.0-alpha2
info:
  label: NetBird REST API — Jobs
  description: 'NetBird REST API — Jobs. 3 operations. Lead operation: List Jobs. Self-contained Naftiko capability covering
    one Netbird business surface.'
  tags:
  - Netbird
  - Jobs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBIRD_API_KEY: NETBIRD_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbird-jobs
    baseUri: https://api.netbird.io
    description: NetBird REST API — Jobs business capability. Self-contained, no shared references.
    resources:
    - name: api-peers-peerId-jobs
      path: /api/peers/{peerId}/jobs
      operations:
      - name: get
        method: GET
        description: List Jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: peerId
          in: path
          type: string
          description: The unique identifier of a peer
          required: true
      - name: post
        method: POST
        description: Create Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: peerId
          in: path
          type: string
          description: The unique identifier of a peer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-peers-peerId-jobs-jobId
      path: /api/peers/{peerId}/jobs/{jobId}
      operations:
      - name: get
        method: GET
        description: Get Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: peerId
          in: path
          type: string
          description: The unique identifier of a peer
          required: true
        - name: jobId
          in: path
          type: string
          description: The unique identifier of a job
          required: true
    authentication:
      type: bearer
      token: '{{env.NETBIRD_API_KEY}}'
  exposes:
  - type: rest
    namespace: netbird-jobs-rest
    port: 8080
    description: REST adapter for NetBird REST API — Jobs. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/peers/{peerid}/jobs
      name: api-peers-peerid-jobs
      description: REST surface for api-peers-peerId-jobs.
      operations:
      - method: GET
        name: get
        description: List Jobs
        call: netbird-jobs.get
        with:
          peerId: rest.peerId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create Job
        call: netbird-jobs.post
        with:
          peerId: rest.peerId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/peers/{peerid}/jobs/{jobid}
      name: api-peers-peerid-jobs-jobid
      description: REST surface for api-peers-peerId-jobs-jobId.
      operations:
      - method: GET
        name: get
        description: Get Job
        call: netbird-jobs.get
        with:
          peerId: rest.peerId
          jobId: rest.jobId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netbird-jobs-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetBird REST API — Jobs. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-jobs
      description: List Jobs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-jobs.get
      with:
        peerId: tools.peerId
      outputParameters:
      - type: object
        mapping: $.
    - name: create-job
      description: Create Job
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-jobs.post
      with:
        peerId: tools.peerId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-job
      description: Get Job
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-jobs.get
      with:
        peerId: tools.peerId
        jobId: tools.jobId
      outputParameters:
      - type: object
        mapping: $.