Skip to content

POST /print/{target}/test

Send a test print to a printer. What gets printed depends on the printer family: a branded ZPL test label (Zebra), an ESC/POS test receipt (Epson TM-series), a label sized to the loaded media (Brother P-touch/QL), or a PDF test page (everything else).

Endpoint:

POST /api/v1/print/{target}/test
Parameter Type Description
target string Same as POST /print/{target} — the printer’s path value or a tag alias.

Body Parameter (Brother label printers only)

Section titled “Body Parameter (Brother label printers only)”

Brother P-touch/QL printers need to know the loaded tape/label size to generate a correctly-sized test label. Pass the media name in a JSON body (or as a ?media= query parameter):

POST /api/v1/print/usb_sn_000F5G234070/test
Content-Type: application/json
{ "media": "tz-24" }
Parameter Type Description
media string Media size name (e.g. tz-24, 62mm). Required for Brother label printers; a missing or unknown name returns 400 with the valid names. Ignored for all other printers.
{
"status": "success",
"statusCode": 200,
"result": {
"module": "/print/tcp_192-168-86-250_9100/test",
"message": "Printed successfully.",
"content": null
}
}

ProxyBox Docs v1.0.6