---
title: "PATCH /scan-requests"
method: PATCH
path: "/scan-requests"
tags: ["ScanRequestController"]
---

# PATCH /scan-requests

`PATCH /scan-requests`

## Request body

- ScanRequestPartial — (tsType: Partial<ScanRequest>, schemaOptions: { partial: true })
  - `id` number
  - `dataSourceConfig` union
    - object
      - `connector` string, required
      - `token` string
      - `host` string, required
      - `path` string, required
      - `port` number
      - `protocol` string
      - `profileNotebook` string
    - object
      - `connector` string, required
  - `scanParameters` object
    - `profile` boolean, required
    - `modelDefinitions` object[]
      - `name` string
      - `properties` object
      - `settings` object
        - `databricks` object
          - `catalog` string
          - `database` string
          - `tableName` string
          - `isTemporary` boolean

## Response `200`

ScanRequest PATCH success count

- LoopbackCount
  - `count` number

## Changes

> 5 revisions in range; 1 could not be searched.

- **2022-11-29** `f9eb0e2fcd7e` — 1 breaking, 4 info
  - added the new required request property `scanParameters/profile`
  - added the new optional request property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/port`
  - added the new optional request property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/profileNotebook`
  - added the new optional request property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/protocol`
  - …1 more
- **2022-11-28** `e74eebc73540` — 1 info
  - the request property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/token` became optional
- **2022-11-28** `8517ac9eef50` — 3 breaking, 5 warning, 3 info
  - removed `subschema #2: MockConfig` from the `dataSourceConfig` request property `anyOf` list
  - request property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/connector` was restricted to a list of enum values
  - the request property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/token` became required
  - removed the request property `dataSourceConfig/anyOf[subschema #1: DatabricksConfig]/port`
  - …7 more

[Change history](https://skmtc.dev/ohdsi/apis/data-connection/changes/scan-requests/patch.md)

---

[API](https://skmtc.dev/ohdsi/apis/data-connection.md) · [All operations](https://skmtc.dev/ohdsi/apis/data-connection/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ohdsi/data-connection/revisions/b5ead99a1d44/schema)