The Bigeye Sensitivity API covers sensitive data discovery and classification: classifiers, data classes and data class categories, scan jobs and scan job configuration, scan runs, and the aggregate and snapshot findings that report where PII and other sensitive data was detected across connected sources.
{"openapi":"3.0.0","info":{"title":"Sensitivity","version":"version not set"},"paths":{"/api/v1/sds/classifier":{"post":{"operationId":"ClassifierService_CreateClassifier","requestBody":{"$ref":"#/components/requestBodies/generatedCreateOrUpdateClassifierRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedClassifier"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Create a classifier","tags":["ClassifierService"]}},"/api/v1/sds/classifier/fetch":{"post":{"operationId":"ClassifierService_FetchClassifiers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetClassifierListRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetClassifierListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Fetch classifiers with filters and pagination","tags":["ClassifierService"]}},"/api/v1/sds/classifier/{id}":{"delete":{"operationId":"ClassifierService_DeleteClassifier","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Delete a classifier","tags":["ClassifierService"]},"get":{"operationId":"ClassifierService_GetClassifier","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedClassifier"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get a classifier by ID","tags":["ClassifierService"]},"put":{"operationId":"ClassifierService_UpdateClassifier","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"requestBody":{"$ref":"#/components/requestBodies/generatedCreateOrUpdateClassifierRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedClassifier"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Update a classifier","tags":["ClassifierService"]}},"/api/v1/sds/classifier/machine-learning-detectors":{"post":{"operationId":"ClassifierService_GetMachineLearningDetectors","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetMachineLearningDetectorListRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetMachineLearningDetectorListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get available machine learning detectors","tags":["ClassifierService"]}},"/api/v1/sds/classifier/{id}/reset":{"put":{"operationId":"ClassifierService_ResetClassifier","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedClassifier"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Reset a Bigeye-provided classifier to its default state","tags":["ClassifierService"]}},"/api/v1/sds/classifier/test-detector":{"post":{"operationId":"ClassifierService_TestDetector","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedTestDetectorRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedTestDetectorResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Test a detector against a sample value","tags":["ClassifierService"]}},"/api/v1/sds/data-class-category/fetch":{"post":{"operationId":"DataClassCategoryService_FetchDataClassCategories","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetDataClassCategoryListRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetDataClassCategoryListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Fetch data class categories for a workspace","tags":["DataClassCategoryService"]}},"/api/v1/sds/data-class":{"post":{"operationId":"DataClassService_CreateDataClass","requestBody":{"$ref":"#/components/requestBodies/generatedCreateOrUpdateDataClassRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDataClass"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Create a data class","tags":["DataClassService"]}},"/api/v1/sds/data-class/fetch":{"post":{"operationId":"DataClassService_FetchDataClasses","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetDataClassListRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetDataClassListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Fetch data classes with filters and pagination","tags":["DataClassService"]}},"/api/v1/sds/data-class/{id}":{"delete":{"operationId":"DataClassService_DeleteDataClass","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Delete a data class","tags":["DataClassService"]},"get":{"operationId":"DataClassService_GetDataClass","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDataClass"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get a data class by ID","tags":["DataClassService"]},"put":{"operationId":"DataClassService_UpdateDataClass","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"requestBody":{"$ref":"#/components/requestBodies/generatedCreateOrUpdateDataClassRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDataClass"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Update a data class","tags":["DataClassService"]}},"/api/v1/sds/data-class/{id}/reset":{"put":{"operationId":"DataClassService_ResetDataClass","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedDataClass"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Reset a Bigeye-provided data class to its default state","tags":["DataClassService"]}},"/api/v1/sds/scan-job/{id}/cancel":{"post":{"operationId":"ScanJobService_CancelScanJob","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Cancel a running scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-job":{"post":{"operationId":"ScanJobService_CreateScanJob","requestBody":{"$ref":"#/components/requestBodies/generatedCreateOrUpdateScanJobRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedScanJob"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Create a scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-job/fetch":{"post":{"operationId":"ScanJobService_FetchScanJobs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetScanJobListRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetScanJobListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Fetch scan jobs with filters and pagination","tags":["ScanJobService"]}},"/api/v1/sds/scan-job/findings/aggregate":{"post":{"operationId":"ScanJobService_GetAggregateFindings","requestBody":{"$ref":"#/components/requestBodies/generatedGetScanFindingsRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetScanFindingsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get aggregate findings for a scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-job/{id}":{"delete":{"operationId":"ScanJobService_DeleteScanJob","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Delete a scan job","tags":["ScanJobService"]},"get":{"operationId":"ScanJobService_GetScanJob","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedScanJob"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get a scan job by ID","tags":["ScanJobService"]},"put":{"operationId":"ScanJobService_UpdateScanJob","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"requestBody":{"$ref":"#/components/requestBodies/generatedCreateOrUpdateScanJobRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedScanJob"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Update a scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-job/{id}/status":{"get":{"operationId":"ScanJobService_GetScanJobStatus","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedWorkflowV2StatusResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get the status of a scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-job/findings/snapshot":{"post":{"operationId":"ScanJobService_GetSnapshotFindings","requestBody":{"$ref":"#/components/requestBodies/generatedGetScanFindingsRequest"},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetScanFindingsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get snapshot findings for a scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-job/reset-scan":{"put":{"operationId":"ScanJobService_ResetScan","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedBulkResetScanRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedBulkResetScanResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Reset scan data for specific tables in a scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-job/{id}/retry":{"put":{"operationId":"ScanJobService_RetryScanJob","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedWorkflowV2StatusResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Retry a failed scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-job/{id}/run":{"post":{"operationId":"ScanJobService_RunScanJob","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedWorkflowV2StatusResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Run a scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-job/{id}/partition-columns":{"put":{"operationId":"ScanJobService_SetPartitionColumns","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedBulkSetPartitionColumnsRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedBulkSetPartitionColumnsResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Set partition columns for a scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-job/{id}/terminate":{"post":{"operationId":"ScanJobService_TerminateScanJob","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedTerminateScanJobRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedEmpty"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Terminate a running scan job","tags":["ScanJobService"]}},"/api/v1/sds/scan-run/fetch":{"post":{"operationId":"ScanRunService_FetchScanRuns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetScanRunListRequest"}}},"required":true},"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetScanRunListResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Fetch scan runs with filters and pagination","tags":["ScanRunService"]}},"/api/v1/sds/scan-run/{id}":{"get":{"operationId":"ScanRunService_GetScanRun","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedScanRun"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/runtimeError"}}}}},"summary":"Get a scan run by ID","tags":["ScanRunService"]}}},"security":[{"basicAuth":[]},{"Personal_API_Key":[]}],"servers":[{"url":"https://app.bigeye.com"}],"components":{"requestBodies":{"generatedGetScanFindingsRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedGetScanFindingsRequest"}}},"required":true},"generatedCreateOrUpdateDataClassRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedCreateOrUpdateDataClassRequest"}}},"required":true},"generatedCreateOrUpdateClassifierRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedCreateOrUpdateClassifierRequest"}}},"required":true},"generatedCreateOrUpdateScanJobRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/generatedCreateOrUpdateScanJobRequest"}}},"required":true}},"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"Agent_API_Key":{"description":"Add 'apikey ' to the beginning of your api key","in":"header","name":"Authorization","type":"apiKey"},"Personal_API_Key":{"description":"Add 'apikey ' to the beginning of your api key","in":"header","name":"Authorization","type":"apiKey"}},"schemas":{"generatedBulkResetScanRequest":{"properties":{"action":{"$ref":"#/components/schemas/generatedResetScanAction"},"requests":{"items":{"$ref":"#/components/schemas/generatedResetScanRequest"},"type":"array"},"scanJobId":{"format":"int64","type":"string"}},"type":"object"},"generatedBulkResetScanResponse":{"properties":{"failures":{"items":{"$ref":"#/components/schemas/generatedResetScanFailure"},"type":"array"},"successes":{"items":{"$ref":"#/components/schemas/generatedResetScanRequest"},"type":"array"}},"type":"object"},"generatedBulkSetPartitionColumnsRequest":{"properties":{"requests":{"items":{"$ref":"#/components/schemas/generatedSetPartitionColumnRequest"},"type":"array"}},"type":"object"},"generatedBulkSetPartitionColumnsResponse":{"properties":{"failures":{"items":{"$ref":"#/components/schemas/generatedSetPartitionColumnFailure"},"type":"array"},"successes":{"items":{"$ref":"#/components/schemas/generatedSetPartitionColumnRequest"},"type":"array"}},"type":"object"},"generatedClassifier":{"properties":{"canResetToDefault":{"type":"boolean"},"createdBy":{"$ref":"#/components/schemas/generatedUser"},"dataClass":{"$ref":"#/components/schemas/generatedDataClass"},"description":{"type":"string"},"detector":{"$ref":"#/components/schemas/modelsgeneratedDetector"},"entityInfo":{"$ref":"#/components/schemas/generatedEntityInfo"},"id":{"format":"int64","type":"string"},"name":{"type":"string"},"numberOfScanJobs":{"format":"int32","type":"integer"},"providedByBigeye":{"type":"boolean"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedClassifierSortField":{"default":"CLASSIFIER_SORT_FIELD_UNSPECIFIED","enum":["CLASSIFIER_SORT_FIELD_UNSPECIFIED","CLASSIFIER_SORT_FIELD_NAME","CLASSIFIER_SORT_FIELD_DATA_CLASS_NAME","CLASSIFIER_SORT_FIELD_SENSITIVITY","CLASSIFIER_SORT_FIELD_CREATOR","CLASSIFIER_SORT_FIELD_DETECTOR_TYPE","CLASSIFIER_SORT_FIELD_NUMBER_OF_SCAN_JOBS","CLASSIFIER_SORT_FIELD_DESCRIPTION"],"type":"string"},"generatedClassifierSortOption":{"properties":{"sortDirection":{"$ref":"#/components/schemas/generatedSortDirection"},"sortField":{"$ref":"#/components/schemas/generatedClassifierSortField"}},"type":"object"},"generatedCompoundDetector":{"properties":{"combinator":{"$ref":"#/components/schemas/generatedDetectorCombinator"},"detectors":{"items":{"$ref":"#/components/schemas/modelsgeneratedDetector"},"type":"array"}},"type":"object"},"generatedCreateOrUpdateClassifierRequest":{"properties":{"dataClassId":{"format":"int64","type":"string"},"description":{"type":"string"},"detector":{"$ref":"#/components/schemas/modelsgeneratedDetector"},"name":{"type":"string"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedCreateOrUpdateDataClassRequest":{"properties":{"colorHex":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"sensitivity":{"$ref":"#/components/schemas/generatedDataSensitivity"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedCreateOrUpdateScanJobRequest":{"properties":{"classifierIds":{"items":{"format":"int64","type":"string"},"type":"array"},"description":{"type":"string"},"incrementalScanStartAt":{"format":"int64","type":"string"},"name":{"type":"string"},"notificationChannels":{"items":{"$ref":"#/components/schemas/generatedNotificationChannel"},"type":"array"},"sampledScanFractionOfRows":{"format":"double","type":"number"},"sampledScanMinNumberOfRows":{"format":"int32","type":"integer"},"scanType":{"$ref":"#/components/schemas/generatedScanType"},"schedule":{"$ref":"#/components/schemas/generatedScanSchedule"},"tables":{"items":{"$ref":"#/components/schemas/generatedTableToScan"},"type":"array"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedDataClass":{"properties":{"canResetToDefault":{"type":"boolean"},"categories":{"items":{"$ref":"#/components/schemas/generatedDataClassCategory"},"type":"array"},"colorHex":{"type":"string"},"createdBy":{"$ref":"#/components/schemas/generatedUser"},"description":{"type":"string"},"entityInfo":{"$ref":"#/components/schemas/generatedEntityInfo"},"id":{"format":"int64","type":"string"},"name":{"type":"string"},"numberOfClassifiers":{"format":"int32","type":"integer"},"providedByBigeye":{"type":"boolean"},"sensitivity":{"$ref":"#/components/schemas/generatedDataSensitivity"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedDataClassCategory":{"properties":{"description":{"type":"string"},"id":{"format":"int64","type":"string"},"name":{"type":"string"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedDataClassSortField":{"default":"DATA_CLASS_SORT_FIELD_UNSPECIFIED","enum":["DATA_CLASS_SORT_FIELD_UNSPECIFIED","DATA_CLASS_SORT_FIELD_NAME","DATA_CLASS_SORT_FIELD_SENSITIVITY","DATA_CLASS_SORT_FIELD_CREATOR","DATA_CLASS_SORT_FIELD_NUMBER_OF_CLASSIFIERS"],"type":"string"},"generatedDataClassSortOption":{"properties":{"sortDirection":{"$ref":"#/components/schemas/generatedSortDirection"},"sortField":{"$ref":"#/components/schemas/generatedDataClassSortField"}},"type":"object"},"generatedDataSensitivity":{"default":"DATA_SENSITIVITY_UNSPECIFIED","enum":["DATA_SENSITIVITY_UNSPECIFIED","DATA_SENSITIVITY_PUBLIC","DATA_SENSITIVITY_INTERNAL","DATA_SENSITIVITY_CONFIDENTIAL","DATA_SENSITIVITY_RESTRICTED"],"type":"string"},"generatedDetectorCombinator":{"default":"DETECTOR_COMBINATOR_UNSPECIFIED","enum":["DETECTOR_COMBINATOR_UNSPECIFIED","DETECTOR_COMBINATOR_AND","DETECTOR_COMBINATOR_OR"],"type":"string"},"generatedDetectorTarget":{"default":"DETECTOR_TARGET_UNSPECIFIED","enum":["DETECTOR_TARGET_UNSPECIFIED","DETECTOR_TARGET_DATA","DETECTOR_TARGET_COLUMN_NAME"],"type":"string"},"generatedEmpty":{"type":"object"},"generatedEntityInfo":{"properties":{"createdBy":{"format":"int32","type":"integer"},"createdEpochSeconds":{"format":"int64","type":"string"},"updatedBy":{"format":"int32","type":"integer"},"updatedEpochSeconds":{"format":"int64","type":"string"}},"type":"object"},"generatedExternalTicketProvider":{"default":"EXTERNAL_TICKET_PROVIDER_UNSPECIFIED","enum":["EXTERNAL_TICKET_PROVIDER_UNSPECIFIED","EXTERNAL_TICKET_PROVIDER_JIRA","EXTERNAL_TICKET_PROVIDER_SERVICENOW"],"type":"string"},"generatedGetClassifierListRequest":{"properties":{"creatorIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"dataClassCategoryIds":{"items":{"format":"int64","type":"string"},"type":"array"},"dataClassIds":{"items":{"format":"int64","type":"string"},"type":"array"},"detectorTypes":{"items":{"$ref":"#/components/schemas/generatedSimpleDetector"},"type":"array"},"includeDetector":{"type":"boolean"},"pageCursor":{"type":"string"},"pageSize":{"format":"int32","type":"integer"},"scanJobIds":{"items":{"format":"int64","type":"string"},"title":"Filter to classifiers used by these scan jobs","type":"array"},"search":{"type":"string"},"sensitivities":{"items":{"$ref":"#/components/schemas/generatedDataSensitivity"},"type":"array"},"sortOptions":{"items":{"$ref":"#/components/schemas/generatedClassifierSortOption"},"type":"array"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedGetClassifierListResponse":{"properties":{"classifiers":{"items":{"$ref":"#/components/schemas/generatedClassifier"},"type":"array"},"paginationInfo":{"$ref":"#/components/schemas/generatedPaginationInfo"}},"type":"object"},"generatedGetDataClassCategoryListRequest":{"properties":{"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedGetDataClassCategoryListResponse":{"properties":{"categories":{"items":{"$ref":"#/components/schemas/generatedDataClassCategory"},"type":"array"}},"type":"object"},"generatedGetDataClassListRequest":{"properties":{"classifierIds":{"items":{"format":"int64","type":"string"},"title":"Filter to data classes used by these classifiers","type":"array"},"creatorIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"dataClassCategoryIds":{"items":{"format":"int64","type":"string"},"type":"array"},"pageCursor":{"type":"string"},"pageSize":{"format":"int32","type":"integer"},"scanJobIds":{"items":{"format":"int64","type":"string"},"title":"Filter to data classes used by classifiers in these scan jobs","type":"array"},"search":{"type":"string"},"sensitivities":{"items":{"$ref":"#/components/schemas/generatedDataSensitivity"},"type":"array"},"sortOptions":{"items":{"$ref":"#/components/schemas/generatedDataClassSortOption"},"type":"array"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedGetDataClassListResponse":{"properties":{"dataClasses":{"items":{"$ref":"#/components/schemas/generatedDataClass"},"type":"array"},"paginationInfo":{"$ref":"#/components/schemas/generatedPaginationInfo"}},"type":"object"},"generatedGetMachineLearningDetectorListRequest":{"properties":{"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedGetMachineLearningDetectorListResponse":{"properties":{"detectors":{"items":{"$ref":"#/components/schemas/generatedMachineLearningDetector"},"type":"array"}},"type":"object"},"generatedGetScanFindingsRequest":{"properties":{"classifierIds":{"items":{"format":"int64","type":"string"},"type":"array"},"columnIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"dataClassCategoryIds":{"items":{"format":"int64","type":"string"},"type":"array"},"dataClassIds":{"items":{"format":"int64","type":"string"},"type":"array"},"includeChunkInfo":{"type":"boolean"},"pageCursor":{"type":"string"},"pageSize":{"format":"int32","type":"integer"},"positiveOrNegativeFindings":{"$ref":"#/components/schemas/generatedThreeLeggedBoolean"},"scanJobIds":{"items":{"format":"int64","type":"string"},"type":"array"},"scanRunIds":{"items":{"format":"int64","type":"string"},"type":"array"},"schemaIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"search":{"type":"string"},"sensitivities":{"items":{"$ref":"#/components/schemas/generatedDataSensitivity"},"type":"array"},"sortOptions":{"items":{"$ref":"#/components/schemas/generatedScanFindingSortOption"},"type":"array"},"sourceIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"tableIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedGetScanFindingsResponse":{"properties":{"findings":{"items":{"$ref":"#/components/schemas/generatedScanFinding"},"type":"array"},"paginationInfo":{"$ref":"#/components/schemas/generatedPaginationInfo"}},"type":"object"},"generatedGetScanJobListRequest":{"properties":{"classifierIds":{"items":{"format":"int64","type":"string"},"type":"array"},"creatorIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"includeClassifiers":{"type":"boolean"},"includeNotificationChannels":{"type":"boolean"},"includeTables":{"type":"boolean"},"includeWarehouses":{"type":"boolean"},"pageCursor":{"type":"string"},"pageSize":{"format":"int32","type":"integer"},"returnJobsWithNoSchedule":{"type":"boolean"},"scanTypes":{"items":{"$ref":"#/components/schemas/generatedScanType"},"type":"array"},"scheduleFrequencies":{"items":{"$ref":"#/components/schemas/generatedTimeInterval"},"type":"array"},"scheduleFrequencyCronStrings":{"items":{"type":"string"},"type":"array"},"scheduleIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"search":{"type":"string"},"sortOptions":{"items":{"$ref":"#/components/schemas/generatedScanJobSortOption"},"type":"array"},"statuses":{"items":{"$ref":"#/components/schemas/generatedScanJobStatus"},"type":"array"},"warehouseIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedGetScanJobListResponse":{"properties":{"paginationInfo":{"$ref":"#/components/schemas/generatedPaginationInfo"},"scanJobs":{"items":{"$ref":"#/components/schemas/generatedScanJob"},"type":"array"}},"type":"object"},"generatedGetScanRunListRequest":{"properties":{"pageCursor":{"type":"string"},"pageSize":{"format":"int32","type":"integer"},"returnJobsWithNoSchedule":{"type":"boolean"},"scanJobIds":{"items":{"format":"int64","type":"string"},"type":"array"},"scanTypes":{"items":{"$ref":"#/components/schemas/generatedScanType"},"type":"array"},"scheduleFrequencies":{"items":{"$ref":"#/components/schemas/generatedTimeInterval"},"type":"array"},"scheduleFrequencyCronStrings":{"items":{"type":"string"},"type":"array"},"scheduleIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"search":{"type":"string"},"sortOptions":{"items":{"$ref":"#/components/schemas/generatedScanRunSortOption"},"type":"array"},"statuses":{"items":{"$ref":"#/components/schemas/generatedScanJobStatus"},"type":"array"},"warehouseIds":{"items":{"format":"int32","type":"integer"},"type":"array"},"workspaceId":{"format":"int32","type":"integer"}},"type":"object"},"generatedGetScanRunListResponse":{"properties":{"paginationInfo":{"$ref":"#/components/schemas/generatedPaginationInfo"},"scanRuns":{"items":{"$ref":"#/components/schemas/generatedScanRun"},"type":"array"}},"type":"object"},"generatedIdAndDisplayName":{"properties":{"displayName":{"type":"string"},"id":{"format":"int32","type":"integer"}},"type":"object"},"
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bigeye/refs/heads/main/openapi/bigeye-sensitivity-openapi.json
This is an independent, third-party profile of Bigeye Sensitivity API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.