NetBird · Capability

NetBird REST API — Posture Checks

NetBird REST API — Posture Checks. 5 operations. Lead operation: List all Posture Checks. Self-contained Naftiko capability covering one Netbird business surface.

Run with Naftiko NetbirdPosture Checks

What You Can Do

GET
Get — List all Posture Checks
/v1/api/posture-checks
POST
Post — Create a Posture Check
/v1/api/posture-checks
GET
Get — Retrieve a Posture Check
/v1/api/posture-checks/{posturecheckid}
PUT
Put — Update a Posture Check
/v1/api/posture-checks/{posturecheckid}
DELETE
Delete — Delete a Posture Check
/v1/api/posture-checks/{posturecheckid}

MCP Tools

list-all-posture-checks

List all Posture Checks

read-only idempotent
create-posture-check

Create a Posture Check

retrieve-posture-check

Retrieve a Posture Check

read-only idempotent
update-posture-check

Update a Posture Check

idempotent
delete-posture-check

Delete a Posture Check

idempotent

Capability Spec

netbird-posture-checks.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: NetBird REST API — Posture Checks
  description: 'NetBird REST API — Posture Checks. 5 operations. Lead operation: List all Posture Checks. Self-contained Naftiko
    capability covering one Netbird business surface.'
  tags:
  - Netbird
  - Posture Checks
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETBIRD_API_KEY: NETBIRD_API_KEY
capability:
  consumes:
  - type: http
    namespace: netbird-posture-checks
    baseUri: https://api.netbird.io
    description: NetBird REST API — Posture Checks business capability. Self-contained, no shared references.
    resources:
    - name: api-posture-checks
      path: /api/posture-checks
      operations:
      - name: get
        method: GET
        description: List all Posture Checks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create a Posture Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-posture-checks-postureCheckId
      path: /api/posture-checks/{postureCheckId}
      operations:
      - name: get
        method: GET
        description: Retrieve a Posture Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: postureCheckId
          in: path
          type: string
          description: The unique identifier of a posture check
          required: true
      - name: put
        method: PUT
        description: Update a Posture Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: postureCheckId
          in: path
          type: string
          description: The unique identifier of a posture check
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete a Posture Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: postureCheckId
          in: path
          type: string
          description: The unique identifier of a posture check
          required: true
    authentication:
      type: bearer
      token: '{{env.NETBIRD_API_KEY}}'
  exposes:
  - type: rest
    namespace: netbird-posture-checks-rest
    port: 8080
    description: REST adapter for NetBird REST API — Posture Checks. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/posture-checks
      name: api-posture-checks
      description: REST surface for api-posture-checks.
      operations:
      - method: GET
        name: get
        description: List all Posture Checks
        call: netbird-posture-checks.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create a Posture Check
        call: netbird-posture-checks.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/posture-checks/{posturecheckid}
      name: api-posture-checks-posturecheckid
      description: REST surface for api-posture-checks-postureCheckId.
      operations:
      - method: GET
        name: get
        description: Retrieve a Posture Check
        call: netbird-posture-checks.get
        with:
          postureCheckId: rest.postureCheckId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: Update a Posture Check
        call: netbird-posture-checks.put
        with:
          postureCheckId: rest.postureCheckId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete a Posture Check
        call: netbird-posture-checks.delete
        with:
          postureCheckId: rest.postureCheckId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: netbird-posture-checks-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetBird REST API — Posture Checks. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-posture-checks
      description: List all Posture Checks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-posture-checks.get
      outputParameters:
      - type: object
        mapping: $.
    - name: create-posture-check
      description: Create a Posture Check
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: netbird-posture-checks.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-posture-check
      description: Retrieve a Posture Check
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: netbird-posture-checks.get
      with:
        postureCheckId: tools.postureCheckId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-posture-check
      description: Update a Posture Check
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: netbird-posture-checks.put
      with:
        postureCheckId: tools.postureCheckId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-posture-check
      description: Delete a Posture Check
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: netbird-posture-checks.delete
      with:
        postureCheckId: tools.postureCheckId
      outputParameters:
      - type: object
        mapping: $.