Create a Data Classification Plan
Select
Create a Data Classification Plan
- application/json
Request Body
- name string
Name of Data Classification Plan
- threatAnalysis int32
Enables\Disables Threat Analysis support for DC Plan
- application string
Possible values: [
NOT_AVAILABLE
,FILE_STORAGE_OPTIMIZATION
,SENSITIVE_DATA_GOVERNANCE
,CASE_MANAGER
,CONTENT_INDEXING
,THREAT_ANALYSIS
,RISK_ANALYSIS
,THREAT_INDICATOR
]Content indexing target app
indexServer object
id int32name stringcontentAnalyzer object[]
Content Analyzer Id`s for Entity Detection
id int32name stringcontentIndexing object
Create Content Indexing Policy Model for DC Plan
extractTextFromImage booleanEnable OCR in Data Classification Plan
exactSearch booleanEnable Exact Seach in Data Classification Plan
copyPrecedence int32Set Content Indexing Copy Precedence
searchType ContentIndexingOperationTypePossible values: [
METADATA
,METADATA_CONTENT
,METADATA_CONTENT_PREVIEW
]Describes the Content Indexing Operation Type for Data Classification Plan
contentLanguage DCPlanOCRLanguagePossible values: [
NONE
,ENGLISH
,HEBREW
,SPANISH
,FRENCH
,ITALIAN
,DANISH
]OCR Languages Supported By DC Plan
fileFilters object
includeDocTypes stringexcludePaths string[]minDocSize int32maxDocSize int32Possible values:
<= 500
backupCopy object[]
copyId int32storagePoolId int32entityDetection object
Entity Extraction Model for Data Classification Plan
entities object[]
Entity TagId for Extraction
id int32name stringclassifiers object[]
Classifier TagId For Extraction
id int32name stringcopyPrecendence int32threatIndicator object
Threat Indicator Model for Data Classification Plan
threatDetection object
Threat Detection Model for Threat Indicator Policy
fileActivity booleanflag to enable File Activity detection
fileType booleanflag to enable File Type detection
fileExtension booleanflag to enable File Extention detection
backupSize booleanflag to enable Backup Size detection
canaryFile booleanflag to enable Canary Files detection
threatScan object
Threat Scan Model for Threat Indicator Policy
threatAnalysis booleanflag to enable Threat Analysis
fileDataAnalysis booleanflag to enable File Data Analysis
yaraRule booleanflag to enable Yara Rule Analysis
yaraRules object[]
yara rules configuration info
id int32name stringthreatNexus object
Threat Nexus Model for Threat Indicator Policy
cspm_dspm object
CSPM/DSPM Model for Threat Nexus Policy
acante booleanflag to enable Acante
dasera booleanflag to enable Dasera
networkAndDataSecurity object
Network And Data Security Model for Threat Nexus Policy
darktrace booleanflag to enable Darktrace
crowdstrike booleanflag to enable Crowdstrike
netskope booleanflag to enable Netskope
soar object
SOAR Model for Threat Nexus Policy
paloAlto_XSOAR booleanflag to enable Palo Alto – XSOAR
msSentinel booleanflag to enable MS Sentinel
splunk booleanflag to enable Splunk
accessNodesInfo object
access nodes info configured within Threat Indicator Plan
accessNodesGroup object
id int32name stringaccessNodes object[]
list of access nodes used for Threat Indicator Plan
id int32name stringschedule object
Describes the Schedule object for Data Classification Plan
name stringpattern object
Used to describe the frequency of backup
scheduleFrequencyType stringPossible values: [
MINUTES
,DAILY
,WEEKLY
,MONTHLY
,YEARLY
]Default value:
DAILY
schedule frequency type
frequency int32Possible values:
>= 1
Default value:
1
Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months
weeklyDays string[]Possible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
]Days of the week for weekly frequency
dayOfMonth int32Possible values:
>= 1
and<= 31
Day on which to run the schedule, applicable for monthly, yearly
weekOfMonth stringPossible values: [
FIRST
,SECOND
,THIRD
,FOURTH
,LAST
]Specific week of a month
dayOfWeek stringPossible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
,DAY
,WEEKDAY
,WEEKEND_DAYS
]monthOfYear stringPossible values: [
JANUARY
,FEBRUARY
,MARCH
,APRIL
,MAY
,JUNE
,JULY
,AUGUST
,SEPTEMBER
,OCTOBER
,NOVEMBER
,DECEMBER
]startTime int32Default value:
75600
start time of schedule in seconds for daily, weekly, monthly, yearly frequency
startDate int32start date of schedule in epoch format
exceptions object[]
Exceptions to when a schedule should not run, either in dates or week of month and day
onDates int32[]Possible values:
>= 1
and<= 31
list of dates in a month. For ex: 1, 20
onWeekOfTheMonth string[]Possible values: [
FIRST
,SECOND
,THIRD
,FOURTH
,LAST
]On which week of month, for ex: FIRST, LAST
onDayOfTheWeek string[]Possible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
,DAY
,WEEKDAY
,WEEKEND_DAYS
]On which days, for ex: MONDAY, FRIDAY
- 201
- 400
- 404
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
plan object
id int32GUID stringname stringerrors object[]
component stringPlan Entity for which error occured
errorCode int32Error Code for plan
errorMessage stringError message for plan
{
"plan": {
"id": 0,
"GUID": "string",
"name": "string"
},
"errors": [
{
"component": "string",
"errorCode": 0,
"errorMessage": "string"
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Requested Details not found
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}