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 — 1 tool
- Printers and Queues — 2 tools
- Print Jobs — 7 tools
- Users — 5 tools
- Groups — 4 tools
- Cards — 3 tools
- Sites — 5 tools
- Networks — 5 tools
- SNMP Configuration — 5 tools
- Workstations — 2 tools
Discovery
printix_list_tenants details
printix_list_tenants details
[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
printix_get_printer_properties details
printix_get_printer_properties details
[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.
printix_list_print_queues details
printix_list_print_queues details
[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.
Print Jobs
printix_change_job_owner details
printix_change_job_owner details
[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.
printix_complete_job_upload details
printix_complete_job_upload details
[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.
printix_delete_job details
printix_delete_job details
[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.
printix_get_job details
printix_get_job details
[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.
printix_list_jobs details
printix_list_jobs details
[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.
printix_list_queue_jobs details
printix_list_queue_jobs details
[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.
printix_submit_job details
printix_submit_job details
[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.
Users
printix_create_user details
printix_create_user details
[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.
printix_delete_user details
printix_delete_user details
[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.
printix_generate_id_code details
printix_generate_id_code details
[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.
printix_get_user details
printix_get_user details
[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.
printix_list_users details
printix_list_users details
[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.
Groups
printix_create_group details
printix_create_group details
[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.
printix_delete_group details
printix_delete_group details
[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.
printix_get_group details
printix_get_group details
[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.
printix_list_groups details
printix_list_groups details
[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.
Cards
printix_delete_card details
printix_delete_card details
[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.
printix_get_card details
printix_get_card details
[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.
printix_register_card details
printix_register_card details
[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.
Sites
printix_create_site details
printix_create_site details
[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.
printix_delete_site details
printix_delete_site details
[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.
printix_get_site details
printix_get_site details
[Printix] Get one Printix site by id. Site ids come from printix_list_sites. Requires a Cloud Print API application and Printix Premium.
printix_list_sites details
printix_list_sites details
[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.
printix_update_site details
printix_update_site details
[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.
Networks
printix_create_network details
printix_create_network details
[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.
printix_delete_network details
printix_delete_network details
[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.
printix_get_network details
printix_get_network details
[Printix] Get one Printix network by id. Network ids come from printix_list_networks. Requires a Cloud Print API application and Printix Premium.
printix_list_networks details
printix_list_networks details
[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.
printix_update_network details
printix_update_network details
[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.
SNMP Configuration
printix_create_snmp_configuration details
printix_create_snmp_configuration details
[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.
printix_delete_snmp_configuration details
printix_delete_snmp_configuration details
[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.
printix_get_snmp_configuration details
printix_get_snmp_configuration details
[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.
printix_list_snmp_configurations details
printix_list_snmp_configurations details
[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.
printix_update_snmp_configuration details
printix_update_snmp_configuration details
[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.
Workstations
printix_get_workstation details
printix_get_workstation details
[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.
printix_list_workstations details
printix_list_workstations details
[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.
More in Tools Reference
Atera ToolsAuvik ToolsAvanan (Check Point Harmony Email) ToolsConnectWise Sell ToolsStill need help? Ask the team