Skip to main content

API Endpoints

This page lists the major API endpoint groups in O.D.I.N. For full parameter details, response schemas, and "Try it out" functionality, use the interactive Swagger UI at /api/v1/docs on your running instance.

Printers​

MethodEndpointDescriptionRole
GET/api/v1/printersList all printersviewer+
POST/api/v1/printersAdd a printeroperator+
GET/api/v1/printers/{id}Get printer detailsviewer+
PUT/api/v1/printers/{id}Update printeroperator+
DELETE/api/v1/printers/{id}Delete printeradmin
POST/api/v1/printers/{id}/pausePause active printoperator+
POST/api/v1/printers/{id}/resumeResume paused printoperator+
POST/api/v1/printers/{id}/stopStop/cancel printoperator+
POST/api/v1/printers/{id}/fanSet fan speedsoperator+
POST/api/v1/printers/{id}/speedSet print speedoperator+
POST/api/v1/printers/{id}/lightToggle chamber lightoperator+
POST/api/v1/printers/{id}/plate-clearedConfirm plate clearedoperator+
POST/api/v1/printers/{id}/clear-errorsClear HMS errorsoperator+

Jobs​

MethodEndpointDescriptionRole
GET/api/v1/jobsList jobsviewer+
POST/api/v1/jobsCreate a joboperator+
GET/api/v1/jobs/{id}Get job detailsviewer+
PUT/api/v1/jobs/{id}Update joboperator+
DELETE/api/v1/jobs/{id}Delete jobadmin
POST/api/v1/jobs/batchBatch send to multiple printersoperator+
POST/api/v1/jobs/{id}/cloneClone/reprint joboperator+
GET/api/v1/jobs/filament-checkCheck filament compatibilityviewer+

Models​

MethodEndpointDescriptionRole
GET/api/v1/modelsList modelsviewer+
POST/api/v1/modelsUpload model (.3mf/.gcode)operator+
GET/api/v1/models/{id}Get model detailsviewer+
PUT/api/v1/models/{id}Update model metadataoperator+
DELETE/api/v1/models/{id}Delete modeladmin
GET/api/v1/models/{id}/variantsList model variants (plate_count, filament)viewer+

Archives​

MethodEndpointDescriptionRole
GET/api/v1/archivesList archives (paginated, filterable)viewer+
GET/api/v1/archives/{id}Get archive detailsviewer+
PATCH/api/v1/archives/{id}Update archive notes/tagsoperator+
DELETE/api/v1/archives/{id}Delete archiveadmin
POST/api/v1/archives/{id}/reprintReprint from archiveoperator+
GET/api/v1/archives/logPrint log (dense table, CSV export)viewer+
GET/api/v1/archives/compareCompare two archivesviewer+
GET/api/v1/archives/tagsList all tagsviewer+

Spools​

MethodEndpointDescriptionRole
GET/api/v1/spoolsList spoolsviewer+
POST/api/v1/spoolsCreate spooloperator+
PUT/api/v1/spools/{id}Update spooloperator+
DELETE/api/v1/spools/{id}Delete spooladmin
GET/api/v1/spools/low-stockLow-stock spoolsviewer+
GET/api/v1/spools/exportCSV exportviewer+
GET/api/v1/spools/{id}/labelGenerate QR labelviewer+

Projects​

MethodEndpointDescriptionRole
GET/api/v1/projectsList projectsviewer+
POST/api/v1/projectsCreate projectoperator+
GET/api/v1/projects/{id}Get project detailsviewer+
PUT/api/v1/projects/{id}Update projectoperator+
DELETE/api/v1/projects/{id}Delete projectadmin
POST/api/v1/projects/{id}/archivesAssign archivesoperator+

Authentication​

MethodEndpointDescriptionRole
POST/api/v1/auth/loginLogin (returns session cookie)public
POST/api/v1/auth/logoutLogout (revokes session)any
GET/api/v1/auth/meCurrent user infoany
PUT/api/v1/auth/me/themeUpdate theme preferencesany
POST/api/v1/auth/change-passwordChange own passwordany

Users (Admin)​

MethodEndpointDescriptionRole
GET/api/v1/usersList usersadmin
POST/api/v1/usersCreate useradmin
PUT/api/v1/users/{id}Update useradmin
DELETE/api/v1/users/{id}Delete useradmin

Vigil AI (Vision)​

MethodEndpointDescriptionRole
GET/api/v1/vision/detectionsList detectionsviewer+
GET/api/v1/vision/settingsGet detection settingsviewer+
PUT/api/v1/vision/settingsUpdate thresholdsadmin
GET/api/v1/vision/modelsList ONNX modelsviewer+
POST/api/v1/vision/modelsUpload ONNX modeladmin

Notifications & Alerts​

MethodEndpointDescriptionRole
GET/api/v1/alertsList alertsviewer+
PUT/api/v1/alerts/{id}/readMark alert readany
DELETE/api/v1/alerts/{id}Delete alertoperator+
GET/api/v1/alerts/preferencesGet notification preferencesany
PUT/api/v1/alerts/preferencesUpdate notification preferencesany

Orders​

MethodEndpointDescriptionRole
GET/api/v1/ordersList ordersviewer+
POST/api/v1/ordersCreate orderoperator+
GET/api/v1/orders/{id}Get order detailsviewer+
PUT/api/v1/orders/{id}Update orderoperator+
DELETE/api/v1/orders/{id}Delete orderadmin
POST/api/v1/orders/{id}/scheduleSchedule all jobs for orderoperator+
PUT/api/v1/orders/{id}/shipMark order as shippedoperator+
GET/api/v1/orders/{id}/invoice.pdfDownload PDF invoiceviewer+

Products​

MethodEndpointDescriptionRole
GET/api/v1/productsList productsviewer+
POST/api/v1/productsCreate productoperator+
GET/api/v1/products/{id}Get product detailsviewer+
PUT/api/v1/products/{id}Update productoperator+
DELETE/api/v1/products/{id}Delete productadmin

Consumables​

MethodEndpointDescriptionRole
GET/api/v1/consumablesList consumablesviewer+
POST/api/v1/consumablesCreate consumableoperator+
PUT/api/v1/consumables/{id}Update consumableoperator+
DELETE/api/v1/consumables/{id}Delete consumableadmin

Organizations & Groups​

MethodEndpointDescriptionRole
GET/api/v1/orgsList organizationsadmin
POST/api/v1/orgsCreate organizationadmin
PUT/api/v1/orgs/{id}Update organizationadmin
DELETE/api/v1/orgs/{id}Delete organizationadmin
GET/api/v1/groupsList groupsadmin
POST/api/v1/groupsCreate groupadmin

AMS & Filament Slots​

MethodEndpointDescriptionRole
GET/api/v1/printers/{id}/amsGet AMS units and slotsviewer+
POST/api/v1/printers/{id}/ams/refreshTrigger AMS RFID re-readoperator+
PUT/api/v1/printers/{id}/ams/{ams_id}/slots/{slot_id}Update AMS slot configoperator+
GET/api/v1/printers/{id}/ams/environmentGet AMS humidity/temperature dataviewer+

Nozzles​

MethodEndpointDescriptionRole
GET/api/v1/printers/{id}/nozzleGet the currently installed nozzleviewer+
GET/api/v1/printers/{id}/nozzle/historyList nozzle historyviewer+
POST/api/v1/printers/{id}/nozzleInstall a new nozzle (retires the previous one)operator+
PATCH/api/v1/printers/{id}/nozzle/{nozzle_id}/retireRetire a nozzleoperator+

Nozzle records cannot be edited or deleted through the API.

Smart Plugs​

MethodEndpointDescriptionRole
POST/api/v1/printers/{id}/plug/onTurn smart plug onoperator+
POST/api/v1/printers/{id}/plug/offTurn smart plug offoperator+
GET/api/v1/printers/{id}/plug/statusGet plug statusviewer+
POST/api/v1/printers/{id}/plug/testTest plug connectionoperator+

Maintenance​

MethodEndpointDescriptionRole
GET/api/v1/maintenance/tasksList maintenance tasksviewer+
POST/api/v1/maintenance/tasksCreate maintenance taskadmin
PUT/api/v1/maintenance/tasks/{id}Update maintenance taskadmin
DELETE/api/v1/maintenance/tasks/{id}Delete maintenance taskadmin
POST/api/v1/maintenance/tasks/{id}/completeComplete task for a printeroperator+
POST/api/v1/maintenance/seedSeed default tasksadmin

Sessions​

MethodEndpointDescriptionRole
GET/api/v1/sessionsList active sessionsany
DELETE/api/v1/sessions/{jti}Revoke a sessionany
DELETE/api/v1/sessionsRevoke all sessionsany

Permissions​

MethodEndpointDescriptionRole
GET/api/v1/permissionsList all permissionsadmin
GET/api/v1/permissions/rolesList role-permission mappingsadmin
PUT/api/v1/permissions/roles/{role}Update role permissionsadmin

System​

MethodEndpointDescriptionRole
GET/api/v1/healthHealth checkpublic
GET/api/v1/settingsGet system settingsadmin
PUT/api/v1/settingsUpdate system settingsadmin
POST/api/v1/backupCreate database backupadmin
GET/api/v1/backup/listList available backupsadmin
POST/api/v1/backup/restoreRestore from backupadmin
POST/api/v1/setupInitial setup wizardpublic (first run only)

Timelapses​

MethodEndpointDescriptionRole
GET/api/v1/timelapsesList timelapsesviewer+
GET/api/v1/timelapses/{id}Get timelapse detailsviewer+
DELETE/api/v1/timelapses/{id}Delete timelapseadmin
GET/api/v1/timelapses/{id}/downloadDownload timelapse MP4viewer+

Overlay​

MethodEndpointDescriptionRole
GET/api/v1/overlay/{printerId}OBS overlay data for a printerpublic
tip

This is a summary of the most commonly used endpoints. Your instance's Swagger UI at /api/v1/docs is the complete, always-current reference with request/response schemas and a "Try it out" feature.

See Also​

  • API Tokens — create scoped tokens for automation