Column

post

Reset column

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
column_idstringRequired
Responses
chevron-right
200

Success: Column reset

application/json
idstring · uuidRequired
table_idstring · uuidRequired
generator_idany ofOptionalDefault: null
string · uuidOptional
or
nullOptional
namestringRequired
idxintegerRequired
dtypestringRequired
col_dtypestring · enumRequiredPossible values:
sql_typestringRequired
uniqueany ofOptionalDefault: null
booleanOptional
or
nullOptional
nullableany ofOptionalDefault: null
booleanOptional
or
nullOptional
autoincrementany ofOptionalDefault: null
booleanOptional
or
nullOptional
pii_scanbooleanRequired
has_piiany ofOptionalDefault: null
booleanOptional
or
nullOptional
has_unprotected_piiany ofOptionalDefault: null
booleanOptional
or
nullOptional
min_valueany ofOptionalDefault: null
stringOptional
or
nullOptional
max_valueany ofOptionalDefault: null
stringOptional
or
nullOptional
piiany ofOptionalDefault: null
or
nullOptional
cardinality_thresholdany ofOptionalDefault: null
integerOptional
or
nullOptional
rare_category_replacementany ofOptionalDefault: null
stringOptional
or
nullOptional
clip_thresholdany ofOptionalDefault: null
integerOptional
or
nullOptional
localeany ofOptionalDefault: null
stringOptional
or
nullOptional
pii_mock_replaceany ofOptionalDefault: null
booleanOptional
or
nullOptional
pii_deselected_entitiesany ofOptionalDefault: null
string[]Optional
or
nullOptional
generator_configany ofOptionalDefault: null
anyOptional
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
nullOptional
default_generator_configany ofOptionalDefault: null
anyOptional
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
nullOptional
is_rejectedany ofOptionalDefault: null
booleanOptional
or
nullOptional
is_keyany ofOptionalDefault: null
booleanOptional
or
nullOptional
is_pkany ofOptionalDefault: null
booleanOptional
or
nullOptional
is_fkany ofOptionalDefault: null
booleanOptional
or
nullOptional
is_ukany ofOptionalDefault: null
booleanOptional
or
nullOptional
is_referredany ofOptionalDefault: null
booleanOptional
or
nullOptional
database_exclude_from_writeany ofOptionalDefault: null
booleanOptional
or
nullOptional
sync_statusany ofOptionalDefault: null
string · enumOptionalPossible values:
or
nullOptional
sync_diffany ofOptionalDefault: null
or
nullOptional
post
/api/v1/column/{column_id}/reset/
post

Update column and generator

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
column_idstringRequired
Body
idany ofOptionalDefault: null
string · uuidOptional
or
nullOptional
cardinality_thresholdany ofOptionalDefault: null
integerOptional
or
nullOptional
rare_category_replacementany ofOptionalDefault: null
stringOptional
or
nullOptional
clip_thresholdany ofOptionalDefault: null
integerOptional
or
nullOptional
localeany ofOptionalDefault: null
stringOptional
or
nullOptional
pii_mock_replaceany ofOptionalDefault: null
booleanOptional
or
nullOptional
has_piiany ofOptionalDefault: null
booleanOptional
or
nullOptional
generator_configany ofOptionalDefault: null
anyOptional
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
nullOptional
pii_deselected_entitiesany ofOptionalDefault: null
string[]Optional
or
nullOptional
Responses
post
/api/v1/column/{column_id}/update_create/

No content

post

List columns

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
database_idstringRequired
Query parameters
elements_per_pageintegerOptional
keywordstringOptional
requested_pageintegerOptional
Body
column_idsany ofOptionalDefault: null
string · uuid[]Optional
or
nullOptional
table_idsany ofOptionalDefault: null
string · uuid[]Optional
or
nullOptional
not_table_idsany ofOptionalDefault: null
string · uuid[]Optional
or
nullOptional
schema_namesany ofOptionalDefault: null
string[]Optional
or
nullOptional
column_namesany ofOptionalDefault: null
string[]Optional
or
nullOptional
protected_statusany ofOptionalDefault: null
string · enumOptionalPossible values:
or
nullOptional
min_confidence_scoreany ofOptionalDefault: null
numberOptional
or
nullOptional
max_confidence_scoreany ofOptionalDefault: null
numberOptional
or
nullOptional
sort_descendingany ofOptionalDefault: false
booleanOptional
or
nullOptional
sort_byany ofOptionalDefault: NAME
string · enumOptionalPossible values:
or
nullOptional
schema_entities_includedany ofOptionalDefault: null
or
nullOptional
schema_entities_excludedany ofOptionalDefault: null
or
nullOptional
Responses
chevron-right
200

Success: List of columns

application/json
columnsany ofOptionalDefault: null
or
nullOptional
n_suggestedany ofOptionalDefault: null
integerOptional
or
nullOptional
paginationany ofOptionalDefault: null
or
nullOptional
post
/api/v1/column/{database_id}/filter/
post

Set generator on columns

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
database_idstringRequired
Body
column_idsstring · uuid[]Required
Responses
post
/api/v1/column/{database_id}/generator/

No content

post

Mark column as PII

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
database_idstringRequired
Query parameters
has_piibooleanRequired
Body
idsany ofRequired
string · uuid[]Optional
or
nullOptional
Responses
post
/api/v1/column/{database_id}/pii/

No content

post

Batch reset columns

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
database_idstringRequired
Body
column_idsstring · uuid[]Required
Responses
post
/api/v1/column/{database_id}/reset_columns/

No content

post

Get Column PII Stats

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
database_idstringRequired
Query parameters
keywordstringOptional
Body
column_idsany ofOptionalDefault: null
string · uuid[]Optional
or
nullOptional
table_idsany ofOptionalDefault: null
string · uuid[]Optional
or
nullOptional
not_table_idsany ofOptionalDefault: null
string · uuid[]Optional
or
nullOptional
schema_namesany ofOptionalDefault: null
string[]Optional
or
nullOptional
column_namesany ofOptionalDefault: null
string[]Optional
or
nullOptional
protected_statusany ofOptionalDefault: null
string · enumOptionalPossible values:
or
nullOptional
min_confidence_scoreany ofOptionalDefault: null
numberOptional
or
nullOptional
max_confidence_scoreany ofOptionalDefault: null
numberOptional
or
nullOptional
sort_descendingany ofOptionalDefault: false
booleanOptional
or
nullOptional
sort_byany ofOptionalDefault: NAME
string · enumOptionalPossible values:
or
nullOptional
schema_entities_includedany ofOptionalDefault: null
or
nullOptional
schema_entities_excludedany ofOptionalDefault: null
or
nullOptional
Responses
chevron-right
200

Success: Column PII Stats

application/json
n_protectedany ofOptionalDefault: null
integerOptional
or
nullOptional
n_unprotectedany ofOptionalDefault: null
integerOptional
or
nullOptional
n_non_piiany ofOptionalDefault: null
integerOptional
or
nullOptional
post
/api/v1/column/{database_id}/stats/
post

Apply or reject suggested generators

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
database_idstringRequired
Query parameters
applybooleanRequired
keywordstringOptional
Body
column_idsany ofOptionalDefault: null
string · uuid[]Optional
or
nullOptional
table_idsany ofOptionalDefault: null
string · uuid[]Optional
or
nullOptional
not_table_idsany ofOptionalDefault: null
string · uuid[]Optional
or
nullOptional
schema_namesany ofOptionalDefault: null
string[]Optional
or
nullOptional
column_namesany ofOptionalDefault: null
string[]Optional
or
nullOptional
protected_statusany ofOptionalDefault: null
string · enumOptionalPossible values:
or
nullOptional
min_confidence_scoreany ofOptionalDefault: null
numberOptional
or
nullOptional
max_confidence_scoreany ofOptionalDefault: null
numberOptional
or
nullOptional
sort_descendingany ofOptionalDefault: false
booleanOptional
or
nullOptional
sort_byany ofOptionalDefault: NAME
string · enumOptionalPossible values:
or
nullOptional
schema_entities_includedany ofOptionalDefault: null
or
nullOptional
schema_entities_excludedany ofOptionalDefault: null
or
nullOptional
Responses
post
/api/v1/column/{database_id}/suggested/

No content

post

Get supported generators for columns

Authorizations
sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters
database_idstringRequired
Body
idsany ofRequired
string · uuid[]Optional
or
nullOptional
Responses
chevron-right
200Success
application/json
Dynamicany ofOptionalDefault: null
or
nullOptional
Duplicateany ofOptionalDefault: null
or
nullOptional
Mockersany ofOptionalDefault: null
or
nullOptional
Calculated_columnany ofOptionalDefault: null
or
nullOptional
Hashany ofOptionalDefault: null
or
nullOptional
Maskany ofOptionalDefault: null
or
nullOptional
Excludeany ofOptionalDefault: null
or
nullOptional
Generateany ofOptionalDefault: null
or
nullOptional
Shuffleany ofOptionalDefault: null
or
nullOptional
post
/api/v1/column/{database_id}/supported_generators/

Last updated

Was this helpful?