Column

post

Reset column

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

column_idstringRequired

Responses

200

Success: Column reset

application/json

503

Message: unable to fetch column from external service

post

/api/v1/column/{column_id}/reset/

HTTPcURLJavaScriptPython

POST /api/v1/column/{column_id}/reset/ HTTP/1.1
Host: /
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "table_id": "123e4567-e89b-12d3-a456-426614174000",
  "generator_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "idx": 1,
  "dtype": "text",
  "col_dtype": "categorical",
  "sql_type": "text",
  "unique": true,
  "nullable": true,
  "autoincrement": true,
  "pii_scan": true,
  "has_pii": true,
  "has_unprotected_pii": true,
  "min_value": "text",
  "max_value": "text",
  "pii": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "column_id": "123e4567-e89b-12d3-a456-426614174000",
      "pii_type": "text",
      "confidence_score": 1,
      "scan_type": "text",
      "explanation": {},
      "generation_method": "text"
    }
  ],
  "cardinality_threshold": 1,
  "rare_category_replacement": "text",
  "clip_threshold": 1,
  "locale": "text",
  "pii_mock_replace": true,
  "pii_deselected_entities": [
    "text"
  ],
  "generator_config": {
    "name": "text",
    "params": {},
    "links": [
      {
        "association": "text",
        "params": {},
        "generator": {}
      }
    ],
    "is_default": false
  },
  "default_generator_config": {
    "name": "text",
    "params": {},
    "links": [
      {
        "association": "text",
        "params": {},
        "generator": {}
      }
    ],
    "is_default": false
  },
  "is_rejected": true,
  "is_key": true,
  "is_pk": true,
  "is_fk": true,
  "is_uk": true,
  "is_referred": true,
  "database_exclude_from_write": true,
  "sync_status": "new",
  "sync_diff": [
    "DATA_TYPE_UPDATE"
  ]
}

post

Update column and generator

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

column_idstringRequired

Body

application/json

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

204

Success: Column and/or generator updated

400

Message: unable to generate preview data using the settings provided

application/json

503

Message: unable to fetch column from external service

post

/api/v1/column/{column_id}/update_create/

HTTPcURLJavaScriptPython

POST /api/v1/column/{column_id}/update_create/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 341

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "cardinality_threshold": 1,
  "rare_category_replacement": "text",
  "clip_threshold": 1,
  "locale": "text",
  "pii_mock_replace": true,
  "has_pii": true,
  "generator_config": {
    "name": "text",
    "params": {},
    "links": [
      {
        "association": "text",
        "params": {},
        "generator": {}
      }
    ],
    "is_default": false
  },
  "pii_deselected_entities": [
    "text"
  ]
}

No content

post

List columns

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

database_idstringRequired

Query parameters

elements_per_pageintegerOptional

keywordstringOptional

requested_pageintegerOptional

Body

application/json

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

Responses

200

Success: List of columns

application/json

503

Message: unable to fetch database from external service

post

/api/v1/column/{database_id}/filter/

HTTPcURLJavaScriptPython

POST /api/v1/column/{database_id}/filter/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "column_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "table_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "not_table_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "schema_names": [
    "text"
  ],
  "column_names": [
    "text"
  ],
  "protected_status": "PROTECTED",
  "min_confidence_score": 1,
  "max_confidence_score": 1,
  "sort_descending": false,
  "sort_by": "NAME"
}

{
  "columns": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "table_id": "123e4567-e89b-12d3-a456-426614174000",
      "generator_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "idx": 1,
      "dtype": "text",
      "col_dtype": "categorical",
      "sql_type": "text",
      "unique": true,
      "nullable": true,
      "autoincrement": true,
      "pii_scan": true,
      "has_pii": true,
      "has_unprotected_pii": true,
      "min_value": "text",
      "max_value": "text",
      "pii": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "column_id": "123e4567-e89b-12d3-a456-426614174000",
          "pii_type": "text",
          "confidence_score": 1,
          "scan_type": "text",
          "explanation": {},
          "generation_method": "text"
        }
      ],
      "cardinality_threshold": 1,
      "rare_category_replacement": "text",
      "clip_threshold": 1,
      "locale": "text",
      "pii_mock_replace": true,
      "pii_deselected_entities": [
        "text"
      ],
      "generator_config": {
        "name": "text",
        "params": {},
        "links": [
          {
            "association": "text",
            "params": {},
            "generator": {}
          }
        ],
        "is_default": false
      },
      "default_generator_config": {
        "name": "text",
        "params": {},
        "links": [
          {
            "association": "text",
            "params": {},
            "generator": {}
          }
        ],
        "is_default": false
      },
      "is_rejected": true,
      "is_key": true,
      "is_pk": true,
      "is_fk": true,
      "is_uk": true,
      "is_referred": true,
      "database_exclude_from_write": true,
      "sync_status": "new",
      "sync_diff": [
        "DATA_TYPE_UPDATE"
      ],
      "table_schema_name": "text",
      "table_name": "text",
      "is_excluded": true,
      "suggested_generators": [
        {
          "generator": {
            "name": "text",
            "params": {},
            "links": [
              {
                "association": "text",
                "params": {},
                "generator": {}
              }
            ],
            "is_default": false
          },
          "pii": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "column_id": "123e4567-e89b-12d3-a456-426614174000",
            "pii_type": "text",
            "confidence_score": 1,
            "scan_type": "text",
            "explanation": {},
            "generation_method": "text"
          }
        }
      ]
    }
  ],
  "n_suggested": 1,
  "pagination": {
    "total_elements": 1,
    "total_pages": 1,
    "current_page": 1,
    "returned_elements": 1,
    "is_last_page": true
  }
}

post

Set generator on columns

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

database_idstringRequired

Body

application/json

column_idsstring · uuid[]Required

Responses

204

No response body

400

Message: unable to set generator using the settings provided

application/json

503

Message: unable to fetch database from external service

post

/api/v1/column/{database_id}/generator/

HTTPcURLJavaScriptPython

POST /api/v1/column/{database_id}/generator/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 413

{
  "column_schema": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "cardinality_threshold": 1,
    "rare_category_replacement": "text",
    "clip_threshold": 1,
    "locale": "text",
    "pii_mock_replace": true,
    "has_pii": true,
    "generator_config": {
      "name": "text",
      "params": {},
      "links": [
        {
          "association": "text",
          "params": {},
          "generator": {}
        }
      ],
      "is_default": false
    },
    "pii_deselected_entities": [
      "text"
    ]
  },
  "column_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

post

Mark column as PII

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

database_idstringRequired

Query parameters

has_piibooleanRequired

Body

application/json

idsany ofRequired

string · uuid[]Optional

or

nullOptional

Responses

204

No response body

503

Message: unable to fetch database from external service

post

/api/v1/column/{database_id}/pii/

HTTPcURLJavaScriptPython

POST /api/v1/column/{database_id}/pii/?has_pii=true HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

post

Batch reset columns

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

database_idstringRequired

Body

application/json

column_idsstring · uuid[]Required

Responses

204

No response body

400

Message: unable to reset the generators using the settings provided

application/json

503

Message: unable to fetch column from external service

post

/api/v1/column/{database_id}/reset_columns/

HTTPcURLJavaScriptPython

POST /api/v1/column/{database_id}/reset_columns/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "column_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

post

Get Column PII Stats

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

database_idstringRequired

Query parameters

keywordstringOptional

Body

application/json

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

Responses

200

Success: Column PII Stats

application/json

503

Message: unable to fetch database from external service

post

/api/v1/column/{database_id}/stats/

HTTPcURLJavaScriptPython

POST /api/v1/column/{database_id}/stats/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "column_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "table_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "not_table_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "schema_names": [
    "text"
  ],
  "column_names": [
    "text"
  ],
  "protected_status": "PROTECTED",
  "min_confidence_score": 1,
  "max_confidence_score": 1,
  "sort_descending": false,
  "sort_by": "NAME"
}

{
  "n_protected": 1,
  "n_unprotected": 1,
  "n_non_pii": 1
}

post

Apply or reject suggested generators

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

database_idstringRequired

Query parameters

applybooleanRequired

keywordstringOptional

Body

application/json

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

Responses

204

No response body

503

Message: unable to fetch database from external service

post

/api/v1/column/{database_id}/suggested/

HTTPcURLJavaScriptPython

POST /api/v1/column/{database_id}/suggested/?apply=true HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "column_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "table_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "not_table_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "schema_names": [
    "text"
  ],
  "column_names": [
    "text"
  ],
  "protected_status": "PROTECTED",
  "min_confidence_score": 1,
  "max_confidence_score": 1,
  "sort_descending": false,
  "sort_by": "NAME"
}

No content

post

Get supported generators for columns

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

database_idstringRequired

Body

application/json

idsany ofRequired

string · uuid[]Optional

or

nullOptional

Responses

200Success

application/json

400

Message: unable to get supported generators using the settings provided

application/json

503

Message: unable to fetch database from external service

post

/api/v1/column/{database_id}/supported_generators/

HTTPcURLJavaScriptPython

POST /api/v1/column/{database_id}/supported_generators/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "Dynamic": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "text": "text",
        "output": [
          "categorical"
        ],
        "suggested": {}
      },
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "text",
          "default": "text",
          "max_length": 1
        }
      }
    }
  },
  "Duplicate": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "text": "text",
        "output": [
          "categorical"
        ],
        "suggested": {}
      },
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "text",
          "default": "text",
          "max_length": 1
        }
      }
    }
  },
  "Mockers": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "text": "text",
        "output": [
          "categorical"
        ],
        "suggested": {}
      },
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "text",
          "default": "text",
          "max_length": 1
        }
      }
    }
  },
  "Calculated_column": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "text": "text",
        "output": [
          "categorical"
        ],
        "suggested": {}
      },
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "text",
          "default": "text",
          "max_length": 1
        }
      }
    }
  },
  "Hash": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "text": "text",
        "output": [
          "categorical"
        ],
        "suggested": {}
      },
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "text",
          "default": "text",
          "max_length": 1
        }
      }
    }
  },
  "Mask": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "text": "text",
        "output": [
          "categorical"
        ],
        "suggested": {}
      },
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "text",
          "default": "text",
          "max_length": 1
        }
      }
    }
  },
  "Exclude": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "text": "text",
        "output": [
          "categorical"
        ],
        "suggested": {}
      },
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "text",
          "default": "text",
          "max_length": 1
        }
      }
    }
  },
  "Generate": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "text": "text",
        "output": [
          "categorical"
        ],
        "suggested": {}
      },
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "text",
          "default": "text",
          "max_length": 1
        }
      }
    }
  },
  "Shuffle": {
    "ANY_ADDITIONAL_PROPERTY": {
      "options": {
        "text": "text",
        "output": [
          "categorical"
        ],
        "suggested": {}
      },
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "type": "text",
          "default": "text",
          "max_length": 1
        }
      }
    }
  }
}