Skip to main content
POST
Pause / resume / stop / clear bed

Authorizations

Authorization
string
header
required

API keys are minted in the AutoPrintFarm web app under Settings → API Keys. Send as Authorization: Bearer apf_live_.... Keys are shown exactly once at creation and can be revoked at any time.

Path Parameters

id
string
required

Body

application/json
action
enum<string>
required
Available options:
pause,
resume,
stop,
clear_bed
confirm_over_limit
boolean

Response

Dispatched

success
enum<boolean>
required
Available options:
true
confirmed
boolean
required

True when the printer reported the target state (paused/printing/idle) within the confirmation window. Always false for clear_bed and for printers without a serial number, which can't be confirmed.

timedOut
boolean
required

True when the command was delivered to the hub but its effect wasn't confirmed — the printer didn't report the target state within the confirmation window, or the hub's acknowledgement was lost. The command may still take effect — check the printer.

data
object
required
message
string