Skip to content
LabelyardLabelyardLabelyard

Read an IPP printer

POST
/api/v1/admin/printers/ipp/probe
curl --request POST \
  --url https://example.com/api/v1/admin/printers/ipp/probe \
  --header 'Content-Type: application/json' \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>' \
  --data '{ "tls_verify": true, "uri": "example" }'

Runs Get-Printer-Attributes against the given URI now and returns a bounded summary (make and model, IPP and PDF versions, resolutions, media, trays, colour modes, margins, state); never the raw attributes. Errors: 502 ipp_unreachable, ipp_rejected (IPP status name in error_detail) or ipp_bad_response. Admin only.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
IppConnection

Connection of an IPP page printer (spec 11.1): URI and TLS verification (OC-17).

Only ipp, ipps, http and https; no user info, no fragment (validate_ipp_uri). IPP authentication is out of scope (OC-2).

object
tls_verify
Tls Verify
boolean
default: true
uri
required
Uri
string
>= 1 characters <= 1023 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ProbeSummary

What “Read printer” shows (spec 11.1) and what Print-Job attributes are chosen from.

object
accepting_jobs
required
Accepting Jobs
Any of:
boolean
color_modes
required
Color Modes
Array<string>
ipp_versions
required
Ipp Versions
Array<string>
make_and_model
required
Make And Model
Any of:
string
margins_hmm
required
Any of:
Margins

Smallest unprintable margin per side, hundredths of mm.

object
bottom
required
Bottom
integer
left
required
Left
integer
right
required
Right
integer
top
required
Top
integer
media_col_members
required
Media Col Members
Array<string>
media_col_supported
required
Media Col Supported
boolean
media_default
Media Default
Any of:
string
media_sizes
required
Media Sizes
Array<string>
media_sources
required
Media Sources
Array<string>
media_types
required
Media Types
Array<string>
monochrome_supported
required
Monochrome Supported
boolean
one_sided_supported
required
One Sided Supported
boolean
pdf_supported
required
Pdf Supported
boolean
pdf_versions
required
Pdf Versions
Array<string>
resolutions_dpi
required
Resolutions Dpi
Array<integer>
scaling_none_supported
required
Scaling None Supported
boolean
state
required
State
string

Example generated

{
  "accepting_jobs": true,
  "color_modes": [
    "example"
  ],
  "ipp_versions": [
    "example"
  ],
  "make_and_model": "example",
  "margins_hmm": {
    "bottom": 1,
    "left": 1,
    "right": 1,
    "top": 1
  },
  "media_col_members": [
    "example"
  ],
  "media_col_supported": true,
  "media_default": "example",
  "media_sizes": [
    "example"
  ],
  "media_sources": [
    "example"
  ],
  "media_types": [
    "example"
  ],
  "monochrome_supported": true,
  "one_sided_supported": true,
  "pdf_supported": true,
  "pdf_versions": [
    "example"
  ],
  "resolutions_dpi": [
    1
  ],
  "scaling_none_supported": true,
  "state": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}