API coverage
Mapped against the Printix Cloud Print API, including the 2026-06-15 documentation update.
Paths below are relative to https://api.printix.net/cloudprint. {TenantId} defaults to the connection's selected tenant.
The separate Partner API guide covers partner-managed tenant
operations using PrintixPartner commands and independently issued credentials.
| Command | Method | Resource | API reference |
|---|---|---|---|
Get-PrintixRoot | GET | (root) | Reference |
Get-PrintixPrintQueues | GET | tenants/{TenantId}/printers | Reference |
Get-PrintixPrinter | GET | tenants/{TenantId}/printers/{PrinterId}/queues/{QueueId} | Reference |
Get-PrintixJobs | GET | tenants/{TenantId}/jobs | Reference |
Get-PrintixPrintQueueJobs | GET | tenants/{TenantId}/printers/{PrinterId}/queues/{QueueId}/jobs | Reference |
Get-PrintixJob | GET | tenants/{TenantId}/jobs/{JobId} | Reference |
Remove-PrintixJob | POST | tenants/{TenantId}/jobs/{JobId}/delete | Reference |
Complete-PrintixJobUpload | POST | tenants/{TenantId}/jobs/{JobId}/completeUpload | Reference |
Set-PrintixJobOwner | POST | tenants/{TenantId}/jobs/{JobId}/changeOwner | Reference |
New-PrintixUser | POST | tenants/{TenantId}/users/create | Reference |
Get-PrintixUser | GET | tenants/{TenantId}/users/{UserId} | Reference |
Get-PrintixUsers | GET | tenants/{TenantId}/users | Reference |
Remove-PrintixUser | POST | tenants/{TenantId}/users/{UserId}/delete | Reference |
New-PrintixUserIdCode | POST | tenants/{TenantId}/users/{UserId}/idCode | Reference |
New-PrintixGroup | POST | tenants/{TenantId}/groups | Reference |
Get-PrintixGroups | GET | tenants/{TenantId}/groups | Reference |
Get-PrintixGroup | GET | tenants/{TenantId}/groups/{GroupId} | Reference |
Remove-PrintixGroup | DELETE | tenants/{TenantId}/groups/{GroupId} | Reference |
Register-PrintixCard | POST | tenants/{TenantId}/users/{UserId}/cards | Reference |
Get-PrintixCard | GET | tenants/{TenantId}/cards/{CardId} | Reference |
Remove-PrintixCard | DELETE | tenants/{TenantId}/cards/{CardId} | Reference |
New-PrintixSite | POST | tenants/{TenantId}/sites | Reference |
Get-PrintixSite | GET | tenants/{TenantId}/sites/{SiteId} | Reference |
Set-PrintixSite | PUT | tenants/{TenantId}/sites/{SiteId} | Reference |
Remove-PrintixSite | DELETE | tenants/{TenantId}/sites/{SiteId} | Reference |
Get-PrintixSites | GET | tenants/{TenantId}/sites | Reference |
New-PrintixNetwork | POST | tenants/{TenantId}/networks | Reference |
Get-PrintixNetwork | GET | tenants/{TenantId}/networks/{NetworkId} | Reference |
Set-PrintixNetwork | PUT | tenants/{TenantId}/networks/{NetworkId} | Reference |
Remove-PrintixNetwork | DELETE | tenants/{TenantId}/networks/{NetworkId} | Reference |
Get-PrintixNetworks | GET | tenants/{TenantId}/networks | Reference |
New-PrintixSnmpConfiguration | POST | tenants/{TenantId}/snmp | Reference |
Get-PrintixSnmpConfiguration | GET | tenants/{TenantId}/snmp/{SnmpId} | Reference |
Set-PrintixSnmpConfiguration | PUT | tenants/{TenantId}/snmp/{SnmpId} | Reference |
Remove-PrintixSnmpConfiguration | DELETE | tenants/{TenantId}/snmp/{SnmpId} | Reference |
Get-PrintixSnmpConfigurations | GET | tenants/{TenantId}/snmp | Reference |
Get-PrintixWorkstation | GET | tenants/{TenantId}/workstations/{WorkstationId} | Reference |
Get-PrintixWorkstations | GET | tenants/{TenantId}/workstations | Reference |
New-PrintixJob | POST | tenants/{TenantId}/printers/{PrinterId}/queues/{QueueId}/submit | Both submission versions |
Send-PrintixJobFile | PUT | Upload URL supplied by the submission response | File upload |
Output and paging
Read commands extract resource properties where the API uses a wrapper (users, job, printers, and so on).
Site, network, SNMP and workstation detail endpoints already return the resource directly.
Mutation commands retain the full response, including job upload links. Use -Raw on read commands to retain HAL links, paging information and other metadata.
Collection commands return one page by default. -All follows HAL next links sequentially. -Page is zero-based; -PageSize is passed to the service.
Get-PrintixRoot returns tenant links rather than inventing an undocumented tenant-list endpoint.
Get-PrintixUsers explicitly requests both USER and GUEST_USER by default, overriding the API's guest-only default. Pass -Role to filter to specific user types; -All still controls pagination independently.
Body fields
Create and update commands expose documented body fields as named parameters. Only explicitly bound fields are serialized, preserving false, empty arrays and zero where permitted.
Update operations use PUT, not PATCH; consult Printix for any server-side replacement/default semantics before omitting existing field values.
SecureString parameters are converted only for transmission. Service responses may contain user passwords, PINs and card data; handle those outputs as sensitive.
The upstream SNMP documentation spells the 256-bit privacy option ASE256; the module deliberately preserves that wire value.
Submission
New-PrintixJob defaults to version 1.1 with named print settings. Use -LegacyTicket for the original ticket schema without a version header.
Upload every returned uploadLinks entry using Send-PrintixJobFile, then call Complete-PrintixJobUpload or follow the response's uploadCompleted link.
Cloud storage calls never receive the Printix bearer token. No command automatically retries a failed submission or other mutation except on HTTP 429, which Printix documents as performing no work.
Application permissions
Each Printix application has one mutually exclusive type. These are not OAuth scopes that can be combined on a single application or token. You cannot mix Cloud Print API, Card manager, Go registration, Workstation monitoring and User manager types in one application. An integration spanning types needs separate applications and credential sets.
The module holds one active Cloud Print connection. Call Connect-Printix with the
appropriate credentials before changing to operations that require another type.
Reconnecting replaces the previous connection; token renewal does not change its type.
Successful authentication or user listing does not grant access to other endpoints.
The Partner API connection is separate and does not replace
this Cloud Print connection.
Required types by operation
The requirements below preserve the API reference's terminology. An or means alternative accepted types, not scopes to select together. "Not stated" means the endpoint documentation does not specify a Premium prerequisite; it is not a guarantee about licensing.
| Commands | Required application type | Printix Premium |
|---|---|---|
Get-PrintixRoot | Any application type | Not stated |
Get-PrintixPrintQueues, Get-PrintixPrinter | Cloud Print API or Card registration (API term) | Required |
New-PrintixJob (both versions), Get-PrintixJobs, Get-PrintixPrintQueueJobs, Get-PrintixJob, Remove-PrintixJob, Complete-PrintixJobUpload, Set-PrintixJobOwner | Cloud Print API or Card registration (API term) | Required |
New-PrintixUser -Role USER | User manager only | Required |
New-PrintixUser -Role GUEST_USER | User manager, Cloud Print API or Card registration (API term) | Required |
Get-PrintixUsers, Remove-PrintixUser | User manager, Cloud Print API or Card registration (API term) | Required |
Get-PrintixUser | Card registration (API term) | Required |
New-PrintixUserIdCode | Card registration (API term), not User manager | Not stated |
Register-PrintixCard, Remove-PrintixCard | Card manager | Not stated |
Get-PrintixCard | Card registration (API term) | Not stated |
New-PrintixGroup, Get-PrintixGroup, Get-PrintixGroups, Remove-PrintixGroup | Cloud Print API | Not stated |
New-PrintixSite, Get-PrintixSite, Get-PrintixSites, Set-PrintixSite, Remove-PrintixSite | Cloud Print API | Required |
New-PrintixNetwork, Get-PrintixNetwork, Get-PrintixNetworks, Set-PrintixNetwork, Remove-PrintixNetwork | Cloud Print API | Required |
New-PrintixSnmpConfiguration, Get-PrintixSnmpConfiguration, Get-PrintixSnmpConfigurations, Set-PrintixSnmpConfiguration, Remove-PrintixSnmpConfiguration | Cloud Print API | Required |
Get-PrintixWorkstation, Get-PrintixWorkstations | Workstation monitoring only | Not stated |
Send-PrintixJobFile | No Printix authentication; uses the signed storage URL from a successful submission | Not applicable |
Invoke-PrintixRequest inherits the requirement of the endpoint being called.
Connect-Printix obtains a token for the supplied application's type;
Disconnect-Printix and Test-PrintixWebhookSignature do not call protected API endpoints.
The documented user-delete operation deletes guest users.
Card registration versus Card manager
The Administrator dialog supplied with this project lists Cloud Print API, Card manager, Go registration, Workstation monitoring and User manager. The API reference instead says Card registration for ID-code generation, single-user lookup, card lookup and several other endpoints, but Card manager for card registration and deletion.
This terminology is inconsistent. This reference deliberately retains the API's
per-endpoint labels rather than inventing a scope or assuming Go registration is
Card registration. Confirm the matching card application's capabilities in your
tenant (or with Printix support). Generating an ID code with the appropriate card
application was verified in the reported tenant after User manager returned FORBIDDEN.
Switching applications and troubleshooting
For example, listing users and then monitoring workstations requires switching from Cloud Print API (or another accepted user-list type) to Workstation monitoring:
Connect-Printix -ClientId $cloudPrintClientId -ClientSecret $cloudPrintSecret -TenantId $tenantId
Get-PrintixUsers -All
Connect-Printix -ClientId $workstationClientId -ClientSecret $workstationSecret -TenantId $tenantId
Get-PrintixWorkstations -All
Both secrets above must be SecureString values. Reconnect again before returning to an operation that needs the first application's type.
On FORBIDDEN, check the current application's type against the matrix first,
then check the tenant and licensing. User manager is not sufficient for ID-code
generation, and Cloud Print API is not sufficient for workstation monitoring.
If the correct application still fails, retain printix-errorId and the response
timestamp for Printix support. Do not share client secrets or bearer tokens.
API credentials are incompatible with the tenant-wide 'All users must print securely' configuration; use group-based secure printing as documented by Printix.
Webhooks
Webhook registration is performed in Printix Administrator; no management endpoint is documented.
Test-PrintixWebhookSignature checks HMAC-SHA512 over the exact received UTF-8 body and enforces a 15-minute emitted-time window.
It accepts either configured shared secret to support key rotation. The caller supplies one incoming signature header value at a time and must send the webhook HTTP response itself.