Print Scout Updates API reference

Use the Print Scout API Swagger documentation for your tenant as the authoritative source for authentication, request schemas, required fields, data types, and response codes. For the steps, see Deploy a Print Scout update.

API Reference Summary

The five Print Scout endpoints are:

Method Route Purpose
GET /updates List available update packages
POST /updates/publish Publish an update for rollout
GET /updates/published List currently published updates
GET /updates/published/{update-id} Get details of a specific published update
DELETE /updates/published/{update-id} Remove a published update
GET /updates/{version}/download-link Download a Print Scout update package

“Updates” refers to available update packages—what could be installed. “Published updates” refers to an update actively rolled out through the publish endpoint.

Swagger route notationSwagger displays /updates as a relative route because /print-scouts is already included in the server base URL. The full endpoint path is /print-scouts/updates.

Response fields

Returned by GET /updates.

Field Description
type Platform for the update, such as WINDOWS. The Print Scout auto updater is available for Windows only.
version Version of the Print Scout update package.
minVersionApplicable Minimum Print Scout version that can receive the update. Compare this value with the Scout's current version when determining whether the update applies.
releaseNote Free-form text associated with the update package, such as release notes, deployment guidance, or other administrator-facing information.

Example response

{
  "items": [
    {
      "type": "WINDOWS",
      "version": "8.1.18.100",
      "minVersionApplicable": "7.10.0.2634",
      "releaseNote": "seb-testing"
    },
    {
      "type": "WINDOWS",
      "version": "8.3.10.100",
      "minVersionApplicable": "8.1",
      "releaseNote": "seb-demo-testing"
    }
  ]
}

Publish request fields

Sent to POST /updates/publish.

Example request body

{
  "type": "WINDOWS",
  "version": "8.4.8.100",
  "appliesToVersion": "8.1.*",
  "notes": "Maush's Print Scout 8.4 Update...",
  "scoutId": null,
  "downloadUrl": "https://test.pharos.co.nz/PrintScoutUpdater.zip"
}

Field breakdown and explanations

Field Description / guidance
X-Customer-Id Enter the unique customer or tenant ID for the environment that should receive the update.
type Operating system platform for the update package. For the Print Scout Auto Updater preview, use WINDOWS.
version Required target Print Scout version to publish for rollout. Copy the Print Scout version from the available updates response, for example 8.4.8.100.
appliesToVersion Required version pattern for currently installed Print Scouts that are eligible to receive the update, for example 8.4.*. Use this to limit the rollout to Scouts on matching source versions.
notes Optional administrative note for change tracking, approval references, pilot details, or rollout comments.
scoutId Optional Print Scout identifier.
  • Provide a specific Scout ID to target one workstation, such as for pilot testing.
  • Omit if the update should apply to all eligible Print Scouts that match the customer, platform, and version criteria.
downloadUrl Delivery location for the update package.
  • For HP-hosted delivery, set this to null so Print Scouts download from HP.
  • For customer-hosted delivery, enter the HTTPS URL where the unchanged .zip update package is hosted and accessible to all targeted Print Scouts without interactive authentication.

Related topics