NetBird Full API Reference + Read-Only MCP Prototype
GET/api/peers/{peerId}/jobs/{jobId}

Retrieve a job

Retrieves details for a specific job associated with a peer. Use peerId and jobId to identify the job; the response includes its status, workload, and available timestamps or failure reason.

2 parameters
peerIdstringrequired
The unique identifier of the peer associated with the job.
jobIdstringrequired
The unique identifier of the job to retrieve.

5 status codes
200Returns a job object including its identifier, creation time, status, triggering user, and workload; the object can also include a completion time or failure reason.
completed_atstringoptional
created_atstringrequired
failed_reasonstringoptional
idstringrequired
statusstringrequired
Allowed:pendingsucceededfailed
triggered_bystringrequired
workloadobjectrequired
400Returned when the request is malformed.
401Returned when the request does not include valid authentication.
403Returned when access to the requested job is forbidden.
500Returned when the server encounters an internal error.

Error handling

A 400 is returned for a malformed request, a 401 when authentication is missing or invalid, a 403 when access is denied, and a 500 when the server encounters an internal error. The peerId path parameter identifies the peer, and the jobId path parameter identifies the job to retrieve.