Skip to main content
Tools Reference

Printix Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Printix Tools

printix_ · 39 tools · Free 19 · Pro 20 Cloud print management: print queues with the connection status of the printer behind each one, print jobs, users, groups and secure-release cards, sites, networks, SNMP discovery and the workstations running the client. Auth is OAuth2 client_credentials only, minted at auth.printix.net - a DIFFERENT host from api.printix.net - with no refresh token since 2024, so recovery is always a fresh mint. One global API host: the tenant is a GUID in the PATH, discovered from the root request. Paging is ZERO-BASED; the 100-row ceiling is a StackJack cap. Responses are HAL, and every body carries a success boolean, so a 200 saying success:false is a failure. Two vendor facts shape it: creating a Cloud Print API credential INVALIDATES the previous one, and each endpoint is gated by which of the five application classes it was issued as. All 39 tool-eligible operations ship - 19 reads Free, 20 writes Pro - and the print lane's document upload is a presigned non-vendor PUT the caller makes itself.

All connector tools · Printix setup guide

Printix tool groups

Discovery

ToolPlanAccessSummary
printix_list_tenantsFreeRead-onlyList the Printix tenants this connection can reach.

[Printix] List the Printix tenants this connection can reach. CALL THIS FIRST: every other Printix tool takes a tenantId, and this is the only place to get one — a Printix tenant is one customer's Printix environment, identified by a GUID that appears in every API path. Takes no arguments. This is also the one Printix endpoint that ANY of the five Printix application classes may call (Cloud Print API, Card registration, Card manager, User manager, Workstation monitoring), so if this works but another tool returns a permission error, the connection is a different application class from the one that tool needs — a different Printix application is required, not different arguments. Printix credentials are usually issued per customer environment, so one connection commonly returns exactly one tenant.

Printers and Queues

ToolPlanAccessSummary
printix_get_printer_propertiesFreeRead-onlyGet the capabilities of ONE print queue — what the printer behind it can actually do (color, duplex, paper sizes, finishing).
printix_list_print_queuesFreeRead-onlyList a tenant's print queues with the capabilities and status of the printer behind each one.

[Printix] Get the capabilities of ONE print queue — what the printer behind it can actually do (color, duplex, paper sizes, finishing). Use it after printix_list_print_queues, which is where both printerId and queueId come from; Printix addresses a queue by that pair, never by one id alone. This route takes no options you can set: the result arrives inside the usual paged container wrapped around the single printer, so read printers[0] and ignore the page block. Requires a Card registration or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
printerIdstringyesREQUIRED. The printer id, from printix_list_print_queues.
queueIdstringyesREQUIRED. The queue id on that printer, from printix_list_print_queues.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] List a tenant's print queues with the capabilities and status of the printer behind each one. THIS IS THE PRINTER-HEALTH CALL: each entry carries connectionStatus (ONLINE, OFFLINE or UNKNOWN) plus the serial number, model, vendor and location, so one call answers "which printers are down at this client". Printix calls the endpoint "printers" but it returns QUEUES — the vendor corrected its own documentation to say so — which is why a queue is always addressed by the pair printerId + queueId in the other tools here. PAGE NUMBERS START AT 0: page 0 is the first page, and a loop that starts at 1 silently skips it. The response carries a page object of {size, totalElements, totalPages, number}; read totalPages to know when to stop. Get tenantId from printix_list_tenants. Requires a Card registration or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
pageintegerno0ZERO-BASED page number — page 0 is the FIRST page. Defaults to 0.
pageSizeintegerno0Rows per page, 1-100. Defaults to 50. The 100 ceiling is a StackJack safety cap; Printix publishes no maximum.
querystringnonullFree-text filter on the queue name. Omit to return every queue.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
ToolPlanAccessSummary
printix_change_job_ownerProWriteHand a print job to a real Printix user so they can release it at the device themselves.
printix_complete_job_uploadProDestructiveTell Printix the document is uploaded — STEP 3 OF 3, AND THE CALL THAT PUTS INK ON PAPER.
printix_delete_jobProDestructiveDelete one print job — the way to clear a job that was submitted but never printed, or one that failed.
printix_get_jobFreeRead-onlyGet one print job by id — its state, owner, document title and the queue it belongs to.
printix_list_jobsFreeRead-onlyList the print jobs the connected Printix user can see across a whole tenant — the "where did my print go" call.
printix_list_queue_jobsFreeRead-onlyList the print jobs waiting on ONE print queue — what is actually stuck at a given printer.
printix_submit_jobProDestructiveSubmit a print job to one queue — STEP 1 OF 3, and this step alone prints nothing.

[Printix] Hand a print job to a real Printix user so they can release it at the device themselves. Jobs created through this API belong to a hidden Cloud Print API user that cannot sign in at a printer, so this is how a submitted job reaches a person — pair it with releaseImmediately=false on the submit. EXPECT THE JOB TO VANISH FROM THE JOB LIST: Printix documents that once the owner changes the job no longer appears in printix_list_jobs, because that list only shows the hidden API user's jobs. It has not been deleted — look it up with printix_get_job instead. Only jobs created through the Cloud Print API can be reassigned. The new owner must be registered and validated on the SAME tenant. Requires a Card registration or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
jobIdstringyesREQUIRED. The print job id to reassign, from printix_submit_job or printix_list_jobs.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
userEmailstringyesREQUIRED. The email address of the job's new owner. The user must already be registered and validated on this same Printix tenant.

[Printix] Tell Printix the document is uploaded — STEP 3 OF 3, AND THE CALL THAT PUTS INK ON PAPER. Run it only after printix_submit_job returned an upload link AND you PUT the document to that link yourself; calling it before the upload finishes leaves the job stuck rather than printing it. If the submit used releaseImmediately=true (Printix's default) the job prints at the device straight away; otherwise it waits for a secure release by its owner. Requires a Card registration or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
jobIdstringyesREQUIRED. The job id printix_submit_job returned.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Delete one print job — the way to clear a job that was submitted but never printed, or one that failed. The document is discarded and cannot be recovered; the user has to print again. Job ids come from printix_list_jobs or printix_list_queue_jobs. Requires a Card registration or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
jobIdstringyesREQUIRED. The print job id to delete, from printix_list_jobs or printix_list_queue_jobs.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Get one print job by id — its state, owner, document title and the queue it belongs to. Job ids come from printix_list_jobs or printix_list_queue_jobs. Requires a Card registration or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
jobIdstringyesREQUIRED. The print job id, from printix_list_jobs or printix_list_queue_jobs.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] List the print jobs the connected Printix user can see across a whole tenant — the "where did my print go" call. Scope matters: Printix returns the jobs for the user the API credential authenticates as, not every job in the tenant, so a credential created by a limited account sees a limited list. PAGE NUMBERS START AT 0. Use printix_list_queue_jobs instead when the question is about one printer, and printix_get_job for the full detail of a single job. Requires a Card registration or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
pageintegerno0ZERO-BASED page number — page 0 is the FIRST page. Defaults to 0.
pageSizeintegerno0Rows per page, 1-100. Defaults to 50. The 100 ceiling is a StackJack safety cap; Printix publishes no maximum.
sortOrderstringnonullSort order for the returned jobs, passed to Printix unchanged. Accepted on this tenant-wide list only — the per-queue list does not take it.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] List the print jobs waiting on ONE print queue — what is actually stuck at a given printer. Both printerId and queueId come from printix_list_print_queues. PAGE NUMBERS START AT 0. This form deliberately offers no sort order: the vendor documents sortOrder as not accepted here, so it is not sent. Requires a Card registration or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
pageintegerno0ZERO-BASED page number — page 0 is the FIRST page. Defaults to 0.
pageSizeintegerno0Rows per page, 1-100. Defaults to 50. The 100 ceiling is a StackJack safety cap; Printix publishes no maximum.
printerIdstringyesREQUIRED. The printer id, from printix_list_print_queues.
queueIdstringyesREQUIRED. The queue id on that printer, from printix_list_print_queues.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Submit a print job to one queue — STEP 1 OF 3, and this step alone prints nothing. Printix creates the job and returns uploadLinks[0].url plus the headers to send with it; you then PUT the document to that link YOURSELF (it is an Azure or Google Cloud storage address, it takes no Printix token, and StackJack has no tool for it), and finally call printix_complete_job_upload, which is the call that prints. A job submitted and never uploaded SITS IN THE CUSTOMER'S QUEUE until someone clears it, so do not run this unless you can complete all three steps. Setting any of color, duplex, pageOrientation, copies, mediaSize, scaling or the userMapping pair selects Printix's newer submit contract automatically; releaseImmediately does not — Printix accepts it on either contract. Requires a Card registration or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
colorbooleannonullTrue to print in colour, false for mono. Custom paper sizes are not supported.
copiesintegernonullNumber of copies, a positive integer.
duplexstringnonullDuplex mode: NONE, SHORT_EDGE or LONG_EDGE.
mediaSizestringnonullPaper size. Printix's values include A0-A5, ISOA0-ISOA5, B4, B5, ISOB4, ISOB5, JISB4, JISB5, LETTER, LEGAL, EXECUTIVE, EXEC, COM10, MONARCH, DL, ANSIC, ANSID, ANSIE, ARCHC, ARCHD, ARCHE, TABLOID and STATEMENT. Non-standard sizes such as labels are not supported — submit the document in a native print format instead.
pageOrientationstringnonullPage orientation: PORTRAIT, LANDSCAPE or AUTO.
pdlstringnonullThe page description language of the document when it is NOT a PDF: PCL5, PCLXL, POSTSCRIPT, UFRII, TEXT or XPS. Leave it out for PDFs.
printerIdstringyesREQUIRED. The printer id, from printix_list_print_queues.
queueIdstringyesREQUIRED. The queue id on that printer, from printix_list_print_queues.
releaseImmediatelybooleannonullTrue (Printix's default) prints as soon as the upload is completed. False holds the job for a secure release at the device — which is what you want when you are also going to hand it to a real user with printix_change_job_owner.
scalingstringnonullHow to scale the document to the paper size: NOSCALE, SHRINK or FIT.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
titlestringyesREQUIRED. The title the job appears under in Printix. It does not have to match the document's own name.
userstringnonullThe name of the user printing, for integration with third-party print solutions or USB printing through the Printix Redirector. Must match the third-party username EXACTLY. Cannot be combined with userMappingKey — Printix answers 400 if both are sent.
userMappingKeystringnonullAssigns the job to a matching user instead of the hidden Cloud Print API user. One of AzureObjectId, AzureUPN, SAMAccountName, OnPremImmutableId, OnPremUpn or Email. Must be sent with userMappingValue, and cannot be combined with the user argument. Printix answers 422 if the lookup matches zero users or more than one.
userMappingValuestringnonullThe value to match for userMappingKey — for example the email address when the key is Email. Must be sent with userMappingKey.

Users

ToolPlanAccessSummary
printix_create_userProDestructiveCreate a Printix user or guest user.
printix_delete_userProDestructiveDelete a Printix guest user.
printix_generate_id_codeProDestructiveMint a new sign-in ID code for a Printix user.
printix_get_userFreeRead-onlyGet one Printix user by id.
printix_list_usersFreeRead-onlyList a tenant's Printix users.

[Printix] Create a Printix user or guest user. THIS REACHES A REAL PERSON AND MINTS REAL CREDENTIALS: sendWelcomeEmail sends mail to the address you supply, and the response returns the user's ID code, PIN and password IN THE CLEAR — treat it as a secret and do not paste it into a ticket or a chat. If you leave pin or password out, Printix generates them and returns what it generated. APPLICATION CLASS DECIDES WHAT YOU CAN CREATE: a Card registration, User manager or Cloud Print API application may create a GUEST_USER, but ONLY a User manager application may create role=USER, which is a real directory user rather than a visitor. Printix Premium is required. For a bulk import, space the calls out — Printix's 100-requests-a-minute budget is shared across the whole API.

ParamTypeRequiredDefaultDescription
emailstringyesREQUIRED. The user's email address. Printix identifies the user by it, and it is where the welcome email goes.
expirationTimestampstringnonullEnd of the guest's validity period, formatted yyyy.MM.dd HH:mm. GUEST_USER ONLY — Printix refuses it for role=USER. When it passes, the user is deleted automatically within 24 hours.
fullNamestringnonullThe user's full name, as it will appear in Printix.
passwordstringnonullSECRET. The user's password. At least 6 characters with upper case, lower case and digits. Leave it out and Printix generates one. Printix does NOT return a password for an email address that already existed on another tenant.
pinstringnonullSECRET. A 4-digit PIN the user signs in with at the printer. Leave it out and Printix generates one — and returns it in the response either way.
rolestringyesREQUIRED. GUEST_USER for a visitor account, or USER for a full directory user. USER requires a USER MANAGER application; the other classes are refused. Stated explicitly rather than defaulted, because the two create very different things.
sendExpirationEmailbooleannonullTrue to send the guest an expiry email. Also reaches a person.
sendWelcomeEmailbooleannonullTrue to send Printix's welcome email to the address above. THIS REACHES A PERSON. Printix sends only its own default welcome email whatever you set here.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Delete a Printix guest user. This cannot be undone from the API — the person loses their sign-in, their PIN, their ID code and any cards registered to them. Confirm the user with printix_get_user first; ids come from printix_list_users. Requires a Card registration, User manager or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
userIdstringyesREQUIRED. The Printix user id to delete, from printix_list_users.

[Printix] Mint a new sign-in ID code for a Printix user. THIS REPLACES ANY CODE THE USER ALREADY HAS: the old one stops working at every printer immediately, so run it only when the person is expecting it. The new code comes back IN THE CLEAR in the response — treat the result as a secret, hand it to the user directly, and do not paste it into a ticket. Requires a CARD REGISTRATION application; no other class can mint an ID code. For a bulk ID-code reset, space the calls out: Printix's 100-requests-a-minute budget is shared across the whole API.

ParamTypeRequiredDefaultDescription
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
userIdstringyesREQUIRED. The Printix user id to mint a new ID code for, from printix_list_users.

[Printix] Get one Printix user by id. User ids come from printix_list_users. NARROWER PERMISSION THAN THE LIST: Printix allows this lookup from a CARD REGISTRATION application only — a Cloud Print API or User manager connection can list users but cannot fetch one by id, and will be refused. If that happens the fix is a Printix application of the right class, not a different argument.

ParamTypeRequiredDefaultDescription
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
userIdstringyesREQUIRED. The Printix user id, from printix_list_users.

[Printix] List a tenant's Printix users. WATCH THE ROLE DEFAULT: Printix defaults an omitted role to GUEST_USER, so leaving it blank lists guests rather than everybody — pass role=USER for regular staff, and call it twice if you need both. PAGE NUMBERS START AT 0. The free-text query matches a name or an email address. Get tenantId from printix_list_tenants. Requires a Card registration, User manager or Cloud Print API application, and Printix Premium.

ParamTypeRequiredDefaultDescription
pageintegerno0ZERO-BASED page number — page 0 is the FIRST page. Defaults to 0.
pageSizeintegerno0Rows per page, 1-100. Defaults to 50. The 100 ceiling is a StackJack safety cap; Printix publishes no maximum.
querystringnonullFree-text filter on the user's name or email address. Omit to return every user of the selected role.
rolestringnonullFilters by user role. Printix documents this as a LIST of roles whose valid values are USER and GUEST_USER, and DEFAULTS an omitted value to GUEST_USER — so leaving it blank lists guests rather than everybody. Pass USER for regular staff accounts. Printix documents no separator for asking for more than one role in a single call, so two calls is the reliable way to get both.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

Groups

ToolPlanAccessSummary
printix_create_groupProWriteCreate a Printix group.
printix_delete_groupProDestructiveDelete a Printix group.
printix_get_groupFreeRead-onlyGet the detail of one Printix group by id, including the external id it was created with.
printix_list_groupsFreeRead-onlyList or search a tenant's Printix groups.

[Printix] Create a Printix group. Groups are how a tenant scopes printer access and secure-print settings. Additive: nothing existing is changed, and it can be removed again with printix_delete_group. externalId is the group's id in the customer's directory and Printix requires it; a group whose external id already exists on the tenant is refused with a 409 Conflict. identityProvider is needed only when the tenant has more than one identity-provider directory. Requires a CLOUD PRINT API application.

ParamTypeRequiredDefaultDescription
descriptionstringnonullAn optional description for the group.
externalIdstringyesREQUIRED by Printix. The group's id in the external directory (for example its Entra group object id). Printix answers 409 Conflict if this external id is already used by a group on the tenant.
identityProviderstringnonullThe id or link of the identity provider the group belongs to. Required ONLY when the tenant has more than one identity-provider directory; omit it otherwise.
namestringyesREQUIRED. The name of the group, as it will appear in Printix Administrator.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Delete a Printix group. Whatever the group scoped — printer access, secure-print settings, site administration — stops applying to its members. This cannot be undone from the API. Printix answers 409 Conflict for a group that cannot be modified, and 404 for one it cannot find. Group ids come from printix_list_groups. Requires a CLOUD PRINT API application.

ParamTypeRequiredDefaultDescription
groupIdstringyesREQUIRED. The Printix group id to delete, from printix_list_groups.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Get the detail of one Printix group by id, including the external id it was created with. Group ids come from printix_list_groups. Requires a CLOUD PRINT API application — no other Printix application class can read groups.

ParamTypeRequiredDefaultDescription
groupIdstringyesREQUIRED. The Printix group id, from printix_list_groups.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] List or search a tenant's Printix groups. Groups are how a tenant scopes printer access and secure-print settings, so this is the call behind "who can print to what". The free-text query matches a group's name or description. PAGE NUMBERS START AT 0; note Printix defaults this resource's page size to 20 upstream, which is why StackJack always sends one explicitly. Requires a CLOUD PRINT API application — a Card registration, Card manager, User manager or Workstation monitoring connection cannot read groups at all.

ParamTypeRequiredDefaultDescription
pageintegerno0ZERO-BASED page number — page 0 is the FIRST page. Defaults to 0.
pageSizeintegerno0Rows per page, 1-100. Defaults to 50. The 100 ceiling is a StackJack safety cap; Printix publishes no maximum.
querystringnonullFree-text filter on the group's name or description. Omit to return every group.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

Cards

ToolPlanAccessSummary
printix_delete_cardProDestructiveDelete a secure-release card.
printix_get_cardFreeRead-onlyLook up one secure-release card by id and find the user it belongs to — the "whose badge is this" call for a tenant that releases print at the device with a card tap.
printix_register_cardProDestructiveRegister a secure-release card against a Printix user, so they can release print at the device with a card tap.

[Printix] Delete a secure-release card. The badge stops releasing print at every device immediately, which is the call to make when a card is lost. This cannot be undone from the API — a replacement has to be registered again with printix_register_card. The card argument accepts EITHER the card id or the base64 card number; prefer the id, and note that StackJack redacts this value from its own logs and error messages either way. Requires a CARD MANAGER application.

ParamTypeRequiredDefaultDescription
cardIdstringyesREQUIRED. The card to delete — either the card id (preferred) or the base64-encoded card number. StackJack never writes this value into a log line or an error message.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Look up one secure-release card by id and find the user it belongs to — the "whose badge is this" call for a tenant that releases print at the device with a card tap. Printix documents this as "Search for Card"; it takes an exact card id, not a free-text search. Requires a CARD REGISTRATION application. A card's secret is stored hashed and salted at Printix and is never returned by this call.

ParamTypeRequiredDefaultDescription
cardIdstringyesREQUIRED. The card id to look up.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Register a secure-release card against a Printix user, so they can release print at the device with a card tap. THE SECRET ARGUMENT IS THE CARD NUMBER: supply it base64-encoded, already converted to whatever form the customer's readers emit — Printix applies no conversion, and if the estate needs more than one conversion each variant must be registered separately. Printix stores it hashed and salted and never returns it. A card secret already registered on the tenant is refused with a 409 Conflict. Requires a CARD MANAGER application — NOT the Card registration class the card lookup uses. For a bulk card import, space the calls out: Printix's 100-requests-a-minute budget is shared across the whole API.

ParamTypeRequiredDefaultDescription
secretstringyesREQUIRED AND SECRET. The card number as a base64-encoded byte array, converted by you to the form the customer's readers emit. Printix stores it hashed and salted and does not echo it back.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
userIdstringyesREQUIRED. The Printix user id the card belongs to, from printix_list_users.

Sites

ToolPlanAccessSummary
printix_create_siteProWriteCreate a Printix site — a physical location that printers and networks are grouped under.
printix_delete_siteProDestructiveDelete a Printix site.
printix_get_siteFreeRead-onlyGet one Printix site by id.
printix_list_sitesFreeRead-onlyList a tenant's Printix sites — the physical locations printers and networks are grouped under.
printix_update_siteProDestructiveReplace a Printix site's settings.

[Printix] Create a Printix site — a physical location that printers and networks are grouped under. Additive: nothing existing is changed, and the site can be removed again with printix_delete_site. The path is the folder-style location string Printix shows in its own tree, for example /Denmark/Herlev. Requires a CLOUD PRINT API application and Printix Premium.

ParamTypeRequiredDefaultDescription
adminGroupIdsstringnonullComma-separated Printix GROUP ids whose members administer this site, from printix_list_groups. Omit to create the site with no admin groups.
namestringyesREQUIRED. The name of the site, as it will appear in Printix Administrator.
networkIdsstringnonullComma-separated Printix NETWORK ids to attach to this site, from printix_list_networks. Omit to create the site with no networks.
pathstringnonullThe folder-style path the site sits under in Printix, for example /Denmark/Herlev. Omit to leave it unset.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Delete a Printix site. This cannot be undone from the API. NOTE A VENDOR QUIRK: Printix does NOT answer 404 for a site id it cannot find, so a success message is not evidence the site existed — confirm the id with printix_get_site first. Requires a CLOUD PRINT API application and Printix Premium.

ParamTypeRequiredDefaultDescription
siteIdstringyesREQUIRED. The site id to delete, from printix_list_sites.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Get one Printix site by id. Site ids come from printix_list_sites. Requires a Cloud Print API application and Printix Premium.

ParamTypeRequiredDefaultDescription
siteIdstringyesREQUIRED. The Printix site id, from printix_list_sites.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] List a tenant's Printix sites — the physical locations printers and networks are grouped under. Start here when mapping a customer's print estate, then use printix_list_networks for the networks each site owns. PAGE NUMBERS START AT 0; Printix defaults this resource's page size to 10 upstream, which is why StackJack always sends one explicitly. Requires a Cloud Print API application and Printix Premium.

ParamTypeRequiredDefaultDescription
pageintegerno0ZERO-BASED page number — page 0 is the FIRST page. Defaults to 0.
pageSizeintegerno0Rows per page, 1-100. Defaults to 50. The 100 ceiling is a StackJack safety cap; Printix publishes no maximum.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Replace a Printix site's settings. THIS IS A FULL REPLACE, NOT A PATCH: every field you leave out is CLEARED on the site, so a call that only renames a site will also detach every network and admin group it had. Read the site with printix_get_site first and send every value back, changing only what you mean to change. Site ids come from printix_list_sites. Requires a CLOUD PRINT API application and Printix Premium.

ParamTypeRequiredDefaultDescription
adminGroupIdsstringnonullComma-separated Printix GROUP ids that administer this site. OMITTING THIS CLEARS THE LIST — resend the ids printix_get_site returned unless you mean to detach them.
namestringyesREQUIRED. The name the site will have after this call.
networkIdsstringnonullComma-separated Printix NETWORK ids attached to this site. OMITTING THIS CLEARS THE LIST — resend the ids printix_get_site returned unless you mean to detach them.
pathstringnonullThe folder-style path the site sits under. OMITTING THIS CLEARS IT — send the value printix_get_site returned unless you are deliberately changing it.
siteIdstringyesREQUIRED. The site id to replace, from printix_list_sites.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

Networks

ToolPlanAccessSummary
printix_create_networkProWriteCreate a Printix network — the network definition Printix recognises a site by, identified by its gateway MAC and IP addresses.
printix_delete_networkProDestructiveDelete a Printix network.
printix_get_networkFreeRead-onlyGet one Printix network by id.
printix_list_networksFreeRead-onlyList a tenant's Printix networks — the network definitions that decide which printers a workstation can reach from where it is.
printix_update_networkProDestructiveReplace a Printix network's settings.

[Printix] Create a Printix network — the network definition Printix recognises a site by, identified by its gateway MAC and IP addresses. Additive: nothing existing is changed, and it can be removed again with printix_delete_network. Requires a CLOUD PRINT API application and Printix Premium.

ParamTypeRequiredDefaultDescription
airPrintbooleannonullTrue to enable AirPrint on this network. Omit to leave it unset.
clientMigratePrintQueuesstringnonullWhether the queues on this network may be used for client migration. Printix's valid values are GLOBAL_SETTING, YES and NO.
gatewaysJsonstringnonullThe network's gateways, as a JSON ARRAY of objects with mac and ip, exactly as Printix models them: [{"mac":"aa11bb22cc33","ip":"192.168.2.1"}]. This is how Printix recognises the network, so a network created without gateways matches nothing.
homeOfficebooleannonullTrue if this network is a home office. Omit to leave it unset.
namestringyesREQUIRED. The name of the network, as it will appear in Printix Administrator.
siteIdstringnonullThe Printix SITE id this network belongs to, from printix_list_sites. Omit for a network not yet attached to a site.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Delete a Printix network. Printers recognised through this network stop being placed at their site. This cannot be undone from the API, and Printix does NOT answer 404 for a network id it cannot find, so a success message is not evidence the network existed. Requires a CLOUD PRINT API application and Printix Premium.

ParamTypeRequiredDefaultDescription
networkIdstringyesREQUIRED. The network id to delete, from printix_list_networks.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Get one Printix network by id. Network ids come from printix_list_networks. Requires a Cloud Print API application and Printix Premium.

ParamTypeRequiredDefaultDescription
networkIdstringyesREQUIRED. The Printix network id, from printix_list_networks.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] List a tenant's Printix networks — the network definitions that decide which printers a workstation can reach from where it is. Pair this with printix_list_sites for the location each network belongs to. PAGE NUMBERS START AT 0; the upstream default page size on this resource is 10, so StackJack always sends one explicitly. Requires a Cloud Print API application and Printix Premium.

ParamTypeRequiredDefaultDescription
pageintegerno0ZERO-BASED page number — page 0 is the FIRST page. Defaults to 0.
pageSizeintegerno0Rows per page, 1-100. Defaults to 50. The 100 ceiling is a StackJack safety cap; Printix publishes no maximum.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Replace a Printix network's settings. THIS IS A FULL REPLACE, NOT A PATCH: every field you leave out is CLEARED, INCLUDING THE GATEWAYS — and a network with no gateways matches nothing, so printers on it stop being recognised. Read the network with printix_get_network first and send every value back. Network ids come from printix_list_networks. Requires a CLOUD PRINT API application and Printix Premium.

ParamTypeRequiredDefaultDescription
airPrintbooleannonullTrue to enable AirPrint on this network. OMITTING THIS CLEARS IT.
clientMigratePrintQueuesstringnonullWhether the queues on this network may be used for client migration: GLOBAL_SETTING, YES or NO. OMITTING THIS CLEARS IT.
gatewaysJsonstringnonullThe network's gateways as a JSON ARRAY of {mac, ip} objects. OMITTING THIS CLEARS THEM and the network will match no printers — resend what printix_get_network returned unless you mean to replace them.
homeOfficebooleannonullTrue if this network is a home office. OMITTING THIS CLEARS IT.
namestringyesREQUIRED. The name the network will have after this call.
networkIdstringyesREQUIRED. The network id to replace, from printix_list_networks.
siteIdstringnonullThe Printix SITE id this network belongs to. OMITTING THIS DETACHES THE NETWORK FROM ITS SITE.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

SNMP Configuration

ToolPlanAccessSummary
printix_create_snmp_configurationProWriteCreate an SNMP discovery configuration — how Printix reaches printers on a network to discover them and read their status.
printix_delete_snmp_configurationProDestructiveDelete an SNMP discovery configuration.
printix_get_snmp_configurationFreeRead-onlyGet one SNMP configuration by id.
printix_list_snmp_configurationsFreeRead-onlyList a tenant's SNMP configurations — how Printix discovers printers on the network and reads their status.
printix_update_snmp_configurationProDestructiveReplace an SNMP discovery configuration.

[Printix] Create an SNMP discovery configuration — how Printix reaches printers on a network to discover them and read their status. HANDLE THE ARGUMENTS AND THE RESULT AS SECRETS: the community names are the SNMP v1/v2c credential for those devices, the v3 authentication and privacy keys are passwords, and Printix echoes both community names back in the response in the clear. Prefer SNMP v3 with a security level of AUTH_PRIVACY over a community string. Additive: it can be removed again with printix_delete_snmp_configuration. Requires a CLOUD PRINT API application and Printix Premium.

ParamTypeRequiredDefaultDescription
authenticationstringnonullSNMP v3 authentication algorithm. Printix's valid values are NONE, MD5, SHA, SHA256, SHA384 and SHA512.
authenticationKeystringnonullSECRET. The SNMP v3 authentication key. Write-only at Printix — it is not returned by any read, so it cannot be recovered later.
contextNamestringnonullThe SNMP v3 context name.
getCommunityNamestringnonullSECRET. The SNMP v1/v2c read (get) community string. Printix returns this in the response in the clear.
namestringyesREQUIRED. The name of the configuration, as it will appear in Printix Administrator.
networkIdsstringnonullComma-separated Printix NETWORK ids this configuration applies to, from printix_list_networks.
privacystringnonullSNMP v3 privacy algorithm. Printix's valid values are NONE, DES, AES, AES192 and ASE256 (the last spelling is the vendor's own).
privacyKeystringnonullSECRET. The SNMP v3 privacy key. Write-only at Printix — it is not returned by any read, so it cannot be recovered later.
securityLevelstringnonullSNMP v3 security level. Printix's valid values are NO_AUTH_NO_PRIVACY, AUTH_NO_PRIVACY and AUTH_PRIVACY.
setCommunityNamestringnonullSECRET. The SNMP v1/v2c write (set) community string. Printix returns this in the response in the clear.
tenantDefaultbooleannonullTrue to make this the tenant's default SNMP configuration, used by any network with none of its own. THE VENDOR DOES NOT DOCUMENT WHAT HAPPENS TO THE CONFIGURATION CURRENTLY MARKED TENANT DEFAULT — read the existing configurations with printix_list_snmp_configurations first and confirm with the customer, because every network relying on the tenant default discovers printers with whatever credentials this one carries.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
usernamestringnonullThe SNMP v3 username.
versionstringnonullThe SNMP version of the configuration, for example V1 or V3.

[Printix] Delete an SNMP discovery configuration. Printer discovery and status polling on every network this configuration covered stop working, and the SNMP v3 keys it held are not recoverable from Printix afterwards. This cannot be undone from the API. NOTE THE SAME VENDOR QUIRK AS THE SITE AND NETWORK DELETES: Printix does NOT answer 404 for an SNMP configuration id it cannot find, so a success message is not evidence the configuration existed or was removed — confirm the id with printix_get_snmp_configuration first, and read it back afterwards if it mattered. Requires a CLOUD PRINT API application and Printix Premium.

ParamTypeRequiredDefaultDescription
snmpIdstringyesREQUIRED. The SNMP configuration id to delete, from printix_list_snmp_configurations.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Get one SNMP configuration by id. TREAT THE RESULT AS SENSITIVE: an SNMP configuration can carry the community string or the SNMP v3 credentials Printix uses to reach printers, so do not paste the response into a ticket, a chat message or a report without reviewing it first. Configuration ids come from printix_list_snmp_configurations. Requires a Cloud Print API application and Printix Premium.

ParamTypeRequiredDefaultDescription
snmpIdstringyesREQUIRED. The SNMP configuration id, from printix_list_snmp_configurations.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] List a tenant's SNMP configurations — how Printix discovers printers on the network and reads their status. Use this when printer discovery is not finding devices, or when checking that a customer is on SNMP v3 rather than a default community string. PAGE NUMBERS START AT 0; the upstream default page size on this resource is 10, so StackJack always sends one explicitly. Requires a Cloud Print API application and Printix Premium.

ParamTypeRequiredDefaultDescription
pageintegerno0ZERO-BASED page number — page 0 is the FIRST page. Defaults to 0.
pageSizeintegerno0Rows per page, 1-100. Defaults to 50. The 100 ceiling is a StackJack safety cap; Printix publishes no maximum.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.

[Printix] Replace an SNMP discovery configuration. THIS IS A FULL REPLACE, NOT A PATCH, AND IT IS THE MOST DANGEROUS ONE IN THIS CONNECTOR: every field you leave out is CLEARED, including the community strings and the SNMP v3 authentication and privacy keys — and once cleared the v3 keys cannot be read back from Printix, so printer discovery stops and the credentials have to be re-entered from the customer's own records. Read the configuration with printix_get_snmp_configuration first, resend every value, and note that the v3 keys are NOT in that response and must be supplied again from your own records. HANDLE THE ARGUMENTS AND THE RESULT AS SECRETS. Requires a CLOUD PRINT API application and Printix Premium.

ParamTypeRequiredDefaultDescription
authenticationstringnonullSNMP v3 authentication algorithm: NONE, MD5, SHA, SHA256, SHA384 or SHA512. OMITTING THIS CLEARS IT.
authenticationKeystringnonullSECRET. The SNMP v3 authentication key. OMITTING THIS CLEARS IT, and Printix never returns it on a read, so it cannot be recovered — supply it again from your own records.
contextNamestringnonullThe SNMP v3 context name. OMITTING THIS CLEARS IT.
getCommunityNamestringnonullSECRET. The SNMP v1/v2c read (get) community string. OMITTING THIS CLEARS IT.
namestringyesREQUIRED. The name the configuration will have after this call.
networkIdsstringnonullComma-separated Printix NETWORK ids this configuration applies to. OMITTING THIS CLEARS THE LIST and the configuration stops applying anywhere.
privacystringnonullSNMP v3 privacy algorithm: NONE, DES, AES, AES192 or ASE256. OMITTING THIS CLEARS IT.
privacyKeystringnonullSECRET. The SNMP v3 privacy key. OMITTING THIS CLEARS IT, and Printix never returns it on a read, so it cannot be recovered — supply it again from your own records.
securityLevelstringnonullSNMP v3 security level: NO_AUTH_NO_PRIVACY, AUTH_NO_PRIVACY or AUTH_PRIVACY. OMITTING THIS CLEARS IT.
setCommunityNamestringnonullSECRET. The SNMP v1/v2c write (set) community string. OMITTING THIS CLEARS IT.
snmpIdstringyesREQUIRED. The SNMP configuration id to replace, from printix_list_snmp_configurations.
tenantDefaultbooleannonullTrue to make this the tenant's default SNMP configuration. OMITTING THIS CLEARS IT. THE VENDOR DOES NOT DOCUMENT WHAT HAPPENS TO THE CONFIGURATION CURRENTLY MARKED TENANT DEFAULT — read the existing configurations with printix_list_snmp_configurations first, because every network relying on the tenant default discovers printers with whatever credentials this one carries.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
usernamestringnonullThe SNMP v3 username. OMITTING THIS CLEARS IT.
versionstringnonullThe SNMP version of the configuration, for example V1 or V3. OMITTING THIS CLEARS IT.

Workstations

ToolPlanAccessSummary
printix_get_workstationFreeRead-onlyGet one workstation by id — its name, state and last connection time.
printix_list_workstationsFreeRead-onlyList the computers running the Printix client in a tenant, with when each last connected — the "which machines have stopped checking in" call.

[Printix] Get one workstation by id — its name, state and last connection time. Workstation ids come from printix_list_workstations. REQUIRES A WORKSTATION MONITORING APPLICATION; no other Printix application class can read workstations.

ParamTypeRequiredDefaultDescription
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
workstationIdstringyesREQUIRED. The workstation id, from printix_list_workstations.

[Printix] List the computers running the Printix client in a tenant, with when each last connected — the "which machines have stopped checking in" call. REQUIRES A WORKSTATION MONITORING APPLICATION: this is the one Printix family a Cloud Print API credential cannot reach at all, so a permission refusal here means the connection is the wrong application class, not that the arguments are wrong. PAGE NUMBERS START AT 0; the upstream default page size on this resource is 10, so StackJack always sends one explicitly. Pass workstations to fetch a specific set of ids in one call instead of paging.

ParamTypeRequiredDefaultDescription
pageintegerno0ZERO-BASED page number — page 0 is the FIRST page. Defaults to 0.
pageSizeintegerno0Rows per page, 1-100. Defaults to 50. The 100 ceiling is a StackJack safety cap; Printix publishes no maximum.
querystringnonullFree-text filter on the workstation name. Omit to return every workstation.
tenantIdstringyesREQUIRED. The Printix tenant GUID, from printix_list_tenants.
workstationsstringnonullA comma-separated list of workstation ids to return, for example "id1,id2,id3". Omit to page through all of them.