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.

Triggered Scan

post

Authorizations

x-api-keystringRequired

Body

data_storestringOptionalDefault: S3

resource_typestringOptionalDefault: OBJECT

resource_idinteger · int32Optional

Responses

200

200

application/json

400

400

application/json

post/v1/scan

POST /v1/scan HTTP/1.1
Host: api.scanner.demo-001.teleskope.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "data_store": "S3",
  "resource_type": "OBJECT",
  "resource_id": 1
}

{
    "job_id": 1,
}

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.

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

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 or v1/classify-file to classify content without a connector.

Related

• v1/classify — classify a text string without a connector.

• v1/classify-file — classify an uploaded file without a connector.