CLI Reference Guide

Table 3-17 Remove button (continued)
500 Internal Server Error – if too many requests are active. Retry
recommended.
Schema Request —
Response
?api=common&rschema=default
Figure 3-16 Remove button, success response example
3.4 Accessibility services
3.4.1 Set API password
Table 3-18 Set API Password
?api=accessibility&method=setApiPassword
POST Description Sets a password for API authentication. By default, password is not set, and therefore API is not
protected. For security reasons, it is recommended that API protection be used to avoid
unauthorized access to scanned documents or workflows information.
Once API password is set, all operations will require basic authentication with credentials:
Username: “apiuser”
Password: the password defined.
(Alternatively, device "admin" user/password can be used for API authentication.) To unset API
password, an empty string must be unspecified in payload xml.
Authentication Requires basic authentication with device admin credentials.
Payload IN XML: Containing the password of the administrator of the API
OUT If 200, XML response with code 0
If 400, XML response with error code
Response Code 200 OK – success
400 Bad request
Error code -3: Error parsing xml payload
401 Unauthorized access – if basic authentication fails
411 Length required – if content length is not or is badly specified
500 Internal Server Error – if too many requests are active. Retry recommended.
22 Chapter 3 Compatible API