v1.0.0
OAS 3.1.0

Buildbotics CNC Controller API

This document describes the programmatic interface to the Buildbotics CNC Controller. This interface is used by the controller's own web user interface but can also be used by third-party programs to interact with the Buildbotics controller and monitor its status.

The Buildbotics controller is a smart CNC machine controller with built-in Web interface and advanced GCode processor. It can drive up to 4 stepper motors and many different tools such as a CNC spindle, LASER cutter or plasma torch. See https://buildbotics.com/ for more info.

Server:http://bbctrl.local/api
Client Libraries

Authorization

These functions are used to control access to some of the admin functions. Since the controller is typically accessed over insecure HTTP and the password and cookie are transmitted over the network in plain text, this should not be relied upon for strict security. The purpose of these functions is to prevent accidental alteration of a few critical configuration items. Those API end points which can return a 401 code require authorization. The login in associated with a session ID which is stored in an HTTP cookie named bbctrl-client-id. The cookie is a random string created by the client. For example, in the web interface code it is a random 52 character string containing upper and lower case characters, numbers, underscore or plus.

/auth/login

Query the login status.

Responses
  • application/json
Request Example for get/auth/login
curl http://bbctrl.local/api/auth/login
true

Models