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 Jobs API

Interact with and view information about remote jobs.

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

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

This API exposes 3 operations across 2 paths, and defines 9 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.

3 operations 2 paths 9 schemas 2 GET1 POST

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 Jobs 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 3

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

Jobs 3

Interact with and view information about remote jobs.

GET
/api/peers/{peerId}/jobs
List Jobs
1 param → 200400401403500
POST
/api/peers/{peerId}/jobs
Create Job
1 param body → 201400401403500
GET
/api/peers/{peerId}/jobs/{jobId}
Get Job
2 params → 200400401403500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are JobResponse (7 properties), BundleParameters (4 properties), BundleWorkloadResponse (3 properties), BundleWorkloadRequest (2 properties). Each schema is shown below with its type and property counts.

BundleWorkloadRequest
object
2 properties 2 required
JobResponse
object
7 properties 5 required
WorkloadRequest
BundleWorkloadResponse
object
3 properties 3 required
WorkloadType
string
Identifies the type of workload the job will execute. Currently only "bundle" is supported.
BundleResult
object
1 property
WorkloadResponse
BundleParameters
object
These parameters control what gets included in the bundle and how it is processed.
4 properties 4 required
JobRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-jobs-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