> For the complete documentation index, see [llms.txt](https://docs.teleskope.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.teleskope.ai/the-platform/api-service/scanning-api/v1-scan.md).

# v1/scan

Trigger a scan of a resource that is already enrolled in Teleskope. The call is asynchronous: the scanner starts the scan in the background and responds immediately with `202 Accepted` and an empty body. Results appear in Teleskope as the scan completes, not in the API response. This endpoint requires the connector for the requested data store to be enrolled in your deployment.

{% openapi src="/files/cGyOSqpybs6wM3Oy8JMJ" path="/v1/scan" method="post" %}
[{"openapi":"3.12.json](https://2383928706-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgO8NOoWqwRd6MduHoEy7%2Fuploads%2Fgit-blob-18e852072a6b5bf9502f7f1b2e692056518efd67%2F%7B%22openapi%22%3A%223.12.json?alt=media)
{% endopenapi %}

## Body options

| Field             | Type    | Description                                                                                                                                                                                                 |
| ----------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data_store`      | string  | The data store type. Required. Must be one of the supported values listed below.                                                                                                                            |
| `resource_type`   | string  | The resource type within the data store. Required. Must be valid for the given `data_store`.                                                                                                                |
| `resource_id`     | integer | The Teleskope internal ID of the resource to scan. Required.                                                                                                                                                |
| `limit`           | integer | Optional. Maximum number of rows to scan. Used by some data stores (e.g. `SHAREPOINT` `SITE`).                                                                                                              |
| `page`            | integer | Optional. Page offset for paginated scans.                                                                                                                                                                  |
| `override_budget` | boolean | Optional. `BOX` `FILE` only; ignored for every other data store. Defaults to `false`. When `true`, the scan runs past the deployment's monthly Box API call limit, and its Box API calls are still counted. |

## Supported data stores

| `data_store`  | Valid `resource_type` values      |
| ------------- | --------------------------------- |
| `BIGQUERY`    | `TABLE`, `DATASET`                |
| `BLOBSTORAGE` | `BLOB`                            |
| `BOX`         | `FILE`                            |
| `DATABRICKS`  | `TABLE`                           |
| `DRIVE`       | `FILE`, `DRIVE`                   |
| `DYNAMODB`    | `TABLE`                           |
| `GITHUB`      | `FILE`                            |
| `REDSHIFT`    | `TABLE`                           |
| `S3`          | `OBJECT`, `BUCKET`                |
| `SHAREPOINT`  | `SITE`, `DOCUMENT`                |
| `SLACK`       | `FILE`, `RESOURCE`                |
| `SLACKPUBLIC` | `FILE`                            |
| `SNOWFLAKE`   | `TABLE`                           |
| `ZENDESK`     | `TICKET`, `COMMENT`, `ATTACHMENT` |
| `JIRA`        | `ISSUE`                           |

{% hint style="info" %}
The connector for the requested `data_store` must be enrolled in your Teleskope deployment. If it is not, the request will fail. Use [v1/classify](https://docs.teleskope.ai/the-platform/api-service/scanning-api/v1-classify.md) or [v1/classify-file](https://docs.teleskope.ai/the-platform/api-service/scanning-api/v1-classify-file.md) to classify content without a connector.
{% endhint %}

{% hint style="warning" %}
A `BOX` `FILE` scan sent without `override_budget: true` once the deployment's monthly Box API call limit is spent still returns `202 Accepted`, but the scan does not run and no results appear. Send the request again with `override_budget: true` to scan past the limit. A scan whose Box API call cannot be recorded against the limit also returns `202 Accepted` and does not run, with or without `override_budget`.
{% endhint %}

## Related

* [v1/classify](https://docs.teleskope.ai/the-platform/api-service/scanning-api/v1-classify.md) — classify a text string without a connector.
* [v1/classify-file](https://docs.teleskope.ai/the-platform/api-service/scanning-api/v1-classify-file.md) — classify an uploaded file without a connector.
