PII Scan

post

Scan for PII

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

database_idstringRequired

Query parameters

cardinality_checkbooleanOptional

data_scanbooleanRequired

localestringRequired

overwrite_previous_scansbooleanOptional

Body

application/json

allow_listany ofOptionalDefault: null

string[]Optional

or

nullOptional

deny_listany ofOptionalDefault: null

or

nullOptional

deselected_entitiesany ofOptionalDefault: null

string[]Optional

or

nullOptional

Responses

204

PII scan started

503

Message: unable to fetch engine from external service

post

/api/v1/pii_scan/{database_id}/start/

HTTPcURLJavaScriptPython

POST /api/v1/pii_scan/{database_id}/start/?data_scan=true&locale=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "allow_list": [
    "text"
  ],
  "deny_list": {
    "language": "text",
    "ad_hoc_recognizers": [
      {
        "name": "text",
        "deny_list": [
          "text"
        ]
      }
    ]
  },
  "deselected_entities": [
    "text"
  ]
}

No content

get

List of Allow/Deny options for PII Scan

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

engine_idstringRequired

Query parameters

deepScanbooleanOptional

localestringOptional

textPiibooleanOptional

Responses

200

Success: List of PII Scan options

application/json

503

Message: unable to fetch engine from external service

get

/api/v1/pii_scan/{engine_id}/recognizers/

HTTPcURLJavaScriptPython

GET /api/v1/pii_scan/{engine_id}/recognizers/ HTTP/1.1
Accept: */*

{
  "recognizers": [
    {
      "name": "text",
      "value": true
    }
  ]
}