REST API for downloading disconnected scanner packages

9.2.25 Available from 9.2.25.

You use the GET operation on the api/sam/v2/disconnected_scanner_download element to download a disconnected scanner package. Do not run this API separately on each computer on which the disconnected scanner is installed. Instead, run this API once to download the disconnected scanner package to a local drive or a staging location. Then, distribute the package to all computers on which the disconnected scanner is installed.

Permissions

User You must have the Manage Endpoints permission to use this API.

Resource URL

https://server_url:server_port/api/sam/v2/disconnected_scanner_download

Resource information

Table 1. Resource information
Operation details Description
HTTP method GET
Response format
  • application/json
  • application/gzip
  • application/zip
Response codes

200 – OK

207 – “ OK - no content” if the platform parameter is not specified

404 – “ Not found” if the platform parameter is incorrect

Parameters

Table 2. Parameters
Parameter Description Required Value
platform Platform for which you want to download the disconnected scanner package. The following values can be used for this parameter.
  • aix
  • ibm_i
  • linux
  • solaris
  • windows
  String

Example request - checking disconnected scanner version

To check the available version of the disconnected scanner package, use the GET request without the platform parameter.
Request
GET https://server_url:server_port/api/sam/v2/disconnected_scanner_download
Request header
Accept: application/json 
Accept-Language: en-US
Token: <token>
Response body
{
	"version": "9.2.25.0",
	"platforms": [
		"aix",
		"ibm_i",
		"linux",
		"solaris",
		"windows"
	]
}

Example request - downloading disconnected scanner package for Linux

To download the disconnected scanner package, use the GET request and specify the platform parameter. You can download the package for one operating system per request.
Request
GET https://server_url:server_port/api/sam/v2/disconnected_scanner_download
&platform=linux
Request header
Accept: application/json 
Accept-Language: en-US
Token: <token>