Skip to content
LabelyardLabelyardLabelyard

Overview

Labelyard API 0.0.0-dev

Section titled “Labelyard API 0.0.0-dev”

REST + SSE API of Labelyard, the self-hosted Label Printer Hub, which also serves the web UI. The OpenAPI spec is at /openapi.json; humans browse the interactive reference (Scalar) at /docs.

Information

  • License: AGPL-3.0-or-later
  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/api/v1/admin/api-keys
POST
/api/v1/admin/api-keys
GET
/api/v1/admin/api-keys/{key_id}
DELETE
/api/v1/admin/api-keys/{key_id}
PATCH
/api/v1/admin/api-keys/{key_id}
GET
/api/v1/admin/printers
POST
/api/v1/admin/printers
POST
/api/v1/admin/printers/ipp/probe
POST
/api/v1/admin/printers/{printer_id}/identity/resolve
GET
/api/v1/admin/printers/{slug}
PUT
/api/v1/admin/printers/{slug}
POST
/api/v1/admin/printers/{slug}/disable
POST
/api/v1/admin/printers/{slug}/enable
GET
/api/v1/auth/session
POST
/api/v1/auth/session
DELETE
/api/v1/auth/session
GET
/api/v1/batches/runs/held
GET
/api/v1/batches/{batch_id}
POST
/api/v1/batches/{batch_id}/continue
POST
/api/v1/batches/{batch_id}/discard
POST
/api/v1/batches/{batch_id}/reprint
GET
/api/v1/events
GET
/api/v1/info
GET
/api/v1/system/logs
GET
/api/v1/jobs
GET
/api/v1/jobs/{job_id}
POST
/api/v1/jobs/{job_id}/cancel
POST
/api/v1/jobs/{job_id}/pause
POST
/api/v1/jobs/{job_id}/resume
POST
/api/v1/jobs/{job_id}/retry
GET
/api/v1/lookup/{app}/{entity_id}
POST
/api/v1/print
POST
/api/v1/print/{printer_key}/batch
POST
/api/v1/printer/resume
POST
/api/v1/render/preview
POST
/api/v1/print/{printer_key}/sheet
POST
/api/v1/print/{printer_key}/sheet/preview
GET
/api/v1/sheet-cells
GET
/api/v1/sheets
POST
/api/v1/sheets
GET
/api/v1/sheets/margin-check
GET
/api/v1/sheets/next-code
GET
/api/v1/sheets/{code}
POST
/api/v1/sheets/{code}/cells/mark
POST
/api/v1/sheets/{code}/cells/resolve
POST
/api/v1/sheets/{code}/cells/unmark
POST
/api/v1/sheets/{code}/discard
GET
/api/v1/printers
GET
/api/v1/printers/{printer_id}
GET
/api/v1/printers/{printer_id}/capabilities
POST
/api/v1/printers/{printer_id}/pause
GET
/api/v1/printers/{printer_id}/queue
POST
/api/v1/printers/{printer_id}/queue/clear
POST
/api/v1/printers/{printer_id}/resume
GET
/api/v1/printers/{printer_id}/roll
PUT
/api/v1/printers/{printer_id}/roll
GET
/api/v1/printers/{printer_id}/status
GET
/api/v1/printers/{printer_id}/tape
POST
/api/v1/printers/{printer_id}/test-print
GET
/api/v1/printers/calibration/scale
GET
/api/v1/printers/{printer_id}/calibration
PUT
/api/v1/printers/{printer_id}/calibration/{tray}
DELETE
/api/v1/printers/{printer_id}/calibration/{tray}
POST
/api/v1/printers/{printer_id}/calibration/{tray}/fit
POST
/api/v1/printers/{printer_id}/calibration/{tray}/page
GET
/api/v1/printers/{printer_id}/calibration/{tray}/page/pdf
GET
/api/v1/settings
PUT
/api/v1/settings
GET
/api/v1/settings/export
POST
/api/v1/settings/integrations/{name}/test
GET
/api/v1/sheet-types
POST
/api/v1/sheet-types
POST
/api/v1/sheet-types/import
GET
/api/v1/sheet-types/{key}
DELETE
/api/v1/sheet-types/{key}
PATCH
/api/v1/sheet-types/{key}
POST
/api/v1/sheet-types/{key}/archive
GET
/api/v1/sheet-types/{key}/export
POST
/api/v1/sheet-types/{key}/unarchive
POST
/api/v1/sheet-types/{key}/versions
GET
/api/v1/sheet-types/{key}/versions/{n}
POST
/api/v1/webhook/grocy
POST
/api/v1/webhook/spoolman
GET
/healthz
GET
/readiness

Authentication

Section titled “Authentication”

APIKeyHeader

Section titled “APIKeyHeader”

Security scheme type: apiKey

Header parameter name: X-Label-Hub-Key