IPP and REST API comparison
This table lists the REST API endpoints and implemented IPP operations, which have similar semantics.
REST API endpoint | IPP operation | Notes |
---|---|---|
GET /api/printers/ | not applicable | In Gutenberg IPP itself is not used for printer discovery. An ipp: (or ipps: ) URI is specific to one printer. More recent updates to IPP add support for the output-device attribute, but it's not used in Gutenberg. |
GET /api/printers/:printer_id/ | Get-Printer-Attributes (RFC 8011) | |
POST /api/jobs/submit/ | Print-Job (RFC 8011) | |
none | Validate-Job (RFC 8011) | |
GET /api/jobs/ | Get-Jobs (RFC 8011) | |
GET /api/job/:id/ | Get-Job-Attributes (RFC 8011) | |
POST /api/jobs/:id/cancel/ | Cancel-Job (RFC 8011) | |
POST /api/jobs/create_job/ | Create-Job (RFC 8011) | |
POST /api/jobs/:id/upload_artefact/ | Send-Document (RFC 8011) | |
POST /api/jobs/:id/run_job/ | Close-Job (PWG 5100.7-2023) | This endpoint also maps to the Send-Document operation, but with last-document set to true and no file provided. This used to be the standard way of finishing a job in IPP v1.1 when the document count is not known in advance. |
none | Identify-Printer (PWG 5100.13) | Implemented as a no-op. |