LogoLogo
  • Getting Started
    • Welcome to Teleskope.ai
    • Your Journey with Teleskope
  • The Platform
    • Data Catalog
    • Data Subject Rights
      • Integrations
      • Enroll Third Party Integrations
        • Amplitude
        • Google Analytics
        • Salesforce
        • Bazaar Voice
      • Enroll Structured Databases
      • Deletion Methods
    • Policy Maker
    • Issues
    • API Service
      • Scanning API
        • v1/classify
        • v1/classifyCollection
        • v1/scan
      • Redaction API
        • v1/scrub
      • Data Subject Rights
        • GET v1/dsr/requests
        • POST v1/dsr/requests
      • Metadata
        • v1/aws/rds
        • v1/aws/s3
        • v1/snowflake
        • v1/snowflake/users
        • v1/gcp/bigquery
        • v1/gcp/cloudstorage
        • v1/gcp/cloudsql
  • Setup
    • Deployment
    • Role Based Access Control
    • SSO
      • Okta
      • Microsoft Entra
      • Google Auth
  • Specifications
    • Data Store Coverage
    • Compliance Frameworks
    • Redaction Methodologies
    • Data Elements
  • Connectors
    • AWS
      • Athena
      • RDS
      • DynamoDB
      • Redshift
      • S3
      • SNS
      • SQS
    • GCP
      • Cloud Storage
      • Grant Teleskope Access to BigQuery
      • CloudSQL
      • Grant Teleskope Access to CloudLogging
    • SaaS
      • Github
      • Google Drive
      • Jira
      • Segment
      • Zendesk
      • DropBox
      • Box
      • Bitbucket
      • Slack
      • Sharepoint Online
    • Snowflake
    • Azure
      • Azure SQL
      • Azure Database
      • Blob Storage
      • CosmosDB
      • Synapse
    • Databricks
  • DSR
  • Alerting Integrations
    • Slack
    • Tines
Powered by GitBook
On this page

Was this helpful?

Last updated 4 months ago

Was this helpful?

Scrub

post

Redact personal or sensitive information from any given payload

Authorizations
Query parameters
typestringOptional

the type of redaction to perform, possible values are: class, class_numbered, empty, masked, encrypted, fake_data

Default: class
Body
contentstringOptional

Content you would like to scrub personal and sensitive information from

Default: Hi, my name is John Doe, you can reach me on john.doe@gmail.com
filtersstring[]Optional

List of data elements to redact from the payload. If set to None, will redact all data elements Teleskope supports

Responses
200
200
application/json
400
400
application/json
post
POST /v1/scrub HTTP/1.1
Host: api.scanner.demo-001.teleskope.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "content": "text",
  "filters": [
    "text"
  ]
}
{
	"content": "Hi, my name is <FIRST_NAME> <LAST_NAME>, you can reach me on <EMAIL>",
	"classifications": [
		{
			"data_element": "FIRST_NAME",
			"start_char": 15,
			"char_size": 4,
		},
		{
			"data_element": "LAST_NAME",
			"start_char": 20,
			"char_size": 3,
		},
		{
			"data_element": "EMAIL",
			"start_char": 45,
			"char_size": 18,
		}
	]
}