Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NetBird Posture Checks API

Interact with and view information about posture checks.

NetBird Posture Checks API is one of 39 APIs that NetBird publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Posture Checks. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://api.netbird.io.

5 operations 2 paths 14 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.netbird.io
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

NetBird Posture Checks API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as Authorization (TokenAuth). By default, every request must be authenticated.

  • TokenAuth — Enter the token with the Token prefix, e.g. "Token nbpF3f0d.....".

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Posture Checks 5

Interact with and view information about posture checks.

GET
/api/posture-checks
List all Posture Checks
→ 200400401403500
POST
/api/posture-checks
Create a Posture Check
body → 200
GET
/api/posture-checks/{postureCheckId}
Retrieve a Posture Check
1 param → 200400401403500
PUT
/api/posture-checks/{postureCheckId}
Update a Posture Check
1 param body → 200400401403500
DELETE
/api/posture-checks/{postureCheckId}
Delete a Posture Check
1 param → 200400401403500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Checks (5 properties), OSVersionCheck (5 properties), PostureCheck (4 properties), Process (3 properties). Each schema is shown below with its type and property counts.

Process
object
Describes the operational activity within a peer's system.
3 properties
NBVersionCheck
object
Posture check for the version of NetBird
ProcessCheck
object
Posture Check for binaries exist and are running in the peer’s system
1 property 1 required
MinVersionCheck
object
Posture check for the version of operating system
1 property 1 required
PostureCheckUpdate
object
3 properties 2 required
Location
object
Describe geographical location information
2 properties 1 required
OSVersionCheck
object
Posture check for the version of operating system
5 properties
GeoLocationCheck
object
Posture check for geo location
2 properties 2 required
PostureCheck
object
4 properties 3 required
PeerNetworkRangeCheck
object
Posture check for allow or deny access based on the peer's IP addresses. A range matches when it contains any of the peer's local network interface IPs or its…
2 properties 2 required
CountryCode
string
2-letter ISO 3166-1 alpha-2 code that represents the country
MinKernelVersionCheck
object
Posture check with the kernel version
1 property 1 required
Checks
object
List of objects that perform the actual checks
5 properties
CityName
string
Commonly used English name of the city

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-posture-checks-api-openapi.yml Raw ↑

Other APIs NetBird publishes across the network.

NetBird Accounts API
NetBird AWS Marketplace API
NetBird Checkout API
NetBird DNS API
NetBird DNS Zones API
NetBird EDR Falcon Integrations API
NetBird EDR FleetDM Integrations API
NetBird EDR Huntress Integrations API
NetBird EDR Intune Integrations API
NetBird EDR Peers API
NetBird EDR SentinelOne Integrations API
NetBird Event Streaming Integrations API