> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-rest-api-guide/api-reference/site-settings/scanning.md).

# Scanning

## Get

> Retrieve information about RAS scanning settings.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/ScanningSettings":{"get":{"tags":["2-Site settings//Scanning"],"summary":"Get","description":"Retrieve information about RAS scanning settings.","operationId":"a4539b6b-4dee-477b-88a8-23c23443fa97","parameters":[{"name":"SiteId","in":"query","description":"Site ID for which to retrieve the RAS universal scanning settings (optional)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ScanningSettings"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"ScanningSettings":{"type":"object","properties":{"twainNamePattern":{"type":"string","description":"<para type=\"description\">TWAIN Name Pattern.</para>\r\n<para type=\"description\">Default pattern: %SCANNERNAME% for %USERNAME% by Parallels</para>\r\n<para type=\"description\">Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% </para>\r\n<para type=\"description\">Other valid pattern: 2X Universal Scanner</para>","nullable":true},"replicateTWAINPattern":{"type":"boolean","description":"<para type=\"description\">Whether to Replicate TWAIN Pattern or not.</para>"},"wiaNamePattern":{"type":"string","description":"<para type=\"description\">WIA Name Pattern.</para>\r\n<para type=\"description\">Default pattern: %SCANNERNAME% for %USERNAME% by Parallels</para>\r\n<para type=\"description\">Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% </para>","nullable":true},"replicateWIAPattern":{"type":"boolean","description":"<para type=\"description\">Whether to Replicate WIA Pattern or not.</para>"},"twainApps":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies items in the TWAIN Applications list.</para>","nullable":true},"replicateTWAINApps":{"type":"boolean","description":"<para type=\"description\">Whether to replicate TWAIN Applications or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Scanning Settings</para>\r\n<para type=\"description\"></para>"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Update

> Update scanning settings of a Site. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/ScanningSettings":{"put":{"tags":["2-Site settings//Scanning"],"summary":"Update","description":"Update scanning settings of a Site. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.","operationId":"faf6c1a4-b394-4df6-86fc-d06ea3aca02d","parameters":[{"name":"SiteId","in":"query","description":"Site ID (optional)","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"RAS Scanning settings","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/SetScanningSettings"}}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"SetScanningSettings":{"type":"object","properties":{"wiaNamePattern":{"maxLength":255,"minLength":0,"type":"string","description":"<para type=\"description\">WIA Name Pattern.</para>\r\n<para type=\"description\">Default pattern: %SCANNERNAME% for %USERNAME% by Parallels</para>\r\n<para type=\"description\">Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% </para>","nullable":true},"replicateWIAPattern":{"type":"boolean","description":"<para type=\"description\">Replicate WIA pattern.</para>","nullable":true},"twainNamePattern":{"maxLength":255,"minLength":0,"type":"string","description":"<para type=\"description\">TWAIN Name Pattern.</para>\r\n<para type=\"description\">Default pattern: %SCANNERNAME% for %USERNAME% by Parallels</para>\r\n<para type=\"description\">Valid pattern variables: %SCANNERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% </para>\r\n<para type=\"description\">Other valid pattern: 2X Universal Scanner</para>","nullable":true},"replicateTWAINPattern":{"type":"boolean","description":"<para type=\"description\">Replicate TWAIN Pattern.</para>","nullable":true},"twainApps":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies items in the TWAIN Applications list.</para>","nullable":true},"replicateTWAINApps":{"type":"boolean","description":"<para type=\"description\">Replicate TWAIN Applications.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Update RAS Universal Scanning settings</para>\r\n<para type=\"description\"></para>"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.parallels.com/landing/ras-rest-api-guide/api-reference/site-settings/scanning.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.