Request body

Cortex XSOAR API

Cortex XSOAR API
Authentication methods
Default
revokeUserAPIKey
Path parameters
Responses
Create or update automation
Request body
Responses
Copy automation
Request body
Responses
Delete existing automation
Request body
Responses
Import an automation
Form parameters
Responses
Search Automation (aka scripts)
Request body
Responses
Import a classifier
Form parameters
Responses
Upload Pack
Form parameters
Responses
Import a dashboard
Form parameters
Responses
Create new entry in existing investigation
Request body
Responses
Download file
Path parameters
Responses
Create new entry in existing investigation
Request body
Responses
Export Artifact
Request body
Responses
Create new formatted entry in existing investigation
Request body
Responses
Mark entry as note
Request body
Responses
Set entry tags
Request body
Responses
Save evidence
Request body
Responses
delete evidence
Request body
Responses
Search evidence
Request body
Responses
Check if Cortex XSOAR server is available
Responses
Get health containers
Responses
Create single incident
Request body
Responses
Batch create incidents
Request body
Responses
Batch export incidents to csv
Request body
Responses
Batch close incidents
Request body
Responses
Batch delete incidents
Request body
Responses
Get incident as CSV
Path parameters
Responses
Create incident from JSON
Responses
incidentFileUpload
Path parameters
Form parameters
Responses
Set tags field
Path parameters
Request body
Responses
Get all incident fields associated with incident type
Path parameters
Responses
Import an incident field
Form parameters
Responses
Search incidents by filter
Request body
Responses
Create new Incident Type
Request body
Responses
Import an incident type
Form parameters
Responses
Create Indicator
Request body
Responses
Edit Indicator
Request body
Responses
Whitelists or deletes Indicator
Request body
Responses
Batch export indicators to STIX
Request body
Responses
Batch export indicators to csv
Request body
Responses
Batch whitelist or delete indicators
Request body
Responses
Get indicators as CSV
Path parameters
Responses
Create feed indicators from JSON
Request body
Responses
Search indicators
Request body
Responses
Get indicators as STIX V2
Path parameters
Responses
Delete indicators timeline
Request body
Responses
Create indicators
Form parameters
Responses
Create whitelisted
Request body
Responses
Add ad-hoc task
Path parameters
Request body
Responses
Assign task
Request body
Responses
[Deprecated] Complete a task
Form parameters
Responses
Complete task simple (no file)
Request body
Responses
Delete ad-hoc task
Path parameters
Responses
Set task due date
Request body
Responses
Edit ad-hoc task
Path parameters
Request body
Responses
Task add comment
Request body
Responses
Un complete a task
Request body
Responses
Search investigations by filter
Request body
Responses
Sign out all open users sessions
Responses
Sign out all my open sessions
Responses
Sign out all my other open sessions
Responses
Sign out all sessions of the provided username
Path parameters
Responses
Import and override playbook
Form parameters
Responses
Get latest report by ID
Path parameters
Responses
Execute report
Path parameters
Responses
Get all reports
Responses
Upload a report to Cortex XSOAR
Form parameters
Responses
Get report by ID
Path parameters
Responses
Get Audits
Request body
Responses
Get Docker Images
Responses
Create Image
Request body
Responses
Upload an integration
Form parameters
Responses
Reset ROI widget
Responses
[Deprecated] Get Dashboard Statistics
Responses
[Deprecated] Get Widget Statistics
Responses
getUnit42IndicatorHandler
Query parameters
Responses
samplesSearchHandler
Request body
Responses
sessionsSearchHandler
Request body
Responses
Complete a task
Form parameters
Responses
Complete a task
Form parameters
Responses
Get Dashboard Statistics
Responses
Get Widget Statistics
Responses
getAllWidgets
Responses
Add or update a widget
Request body
Responses
Import a widget
Form parameters
Responses
Get widget by ID
Path parameters
Responses
Remove existing widget
Path parameters
Responses
Get workers status
Responses
Models
APIExecutionMetric
AccountsMultiErrors ...
AdvanceArg - advance argument can be one of the following:
ArgAtomicFilter
ArgTransformer ...
Argument
Attachment ...
Audit
AutomationScript
Bucket - represents a specific condition term for merging groups into a custom group.
Command
Comment ...
CommentUpdate ...
CommentsFields ...
CommonFields
CommonUpdateBatch ...
ComplexArg
ConfigField
ContentItemExportableFields holds ContentItemExportableFields fields.
ContentItemFields
ContentItemVersionedFields holds ContentItemVersioned fields.
CreateIncidentRequest
CustomGroup
DBotScore
Dashboard ...
DataCollectionForm - a data collection form with questions.
DateRange
DateRangeFilter
DockerImage
DockerImagesResult
DownloadEntry ...
ElasticCommonFields
ElasticVersionFields
EngineInfo ...
Entry
EntryHistory ...
EntryReputation
EntryTask
Evidence details.
EvidenceData
EvidencesSearchResponse
ExpirationIndicator ...
ExpirationSource .. .
FeedIndicator ...
FeedIndicatorComment ...
FeedIndicatorCommentsFields ...
FeedIndicatorsRequest
FeedMetadata ...
FieldExtractSetting ...
FieldMapping
FieldsAlias ...
FileMetadata ...
FormDisplay - display options for communication/ask task (for both email and web forms).
FullVersion
GenericObjectDefinition ...
GenericObjectType
GenericStringDateFilter
GenericStringFilter
GridColumn ...
Group is the response that returns from a statistics query, describing a grouped value.
HumanCron ...
Important
Incident details.
IncidentField ...
IncidentFilter allows for very simple filtering.
IncidentSearchResponseWrapper
IncidentType ...
IncidentTypeExtractSettings ...
IncidentWrapper
IndicatorEditBulkResponse ...
IndicatorFilter
IndicatorResult ...
IndicatorTimelineFromEntry ...
Info
InsightCache
InstanceClassifier
IntegrationScript ...
InvPlaybookDebugInfo ...
InvPlaybookTaskCompleteData ...
InvPlaybookTaskData ...
InvTaskDebug ...
Investigation contains the investigation of a particular incident.
InvestigationFilter allows for very simple filtering.
InvestigationPlaybook
InvestigationPlaybookData
InvestigationPlaybookTask
InvestigationSearchResponse
IocObject
KeyValueArg ...
Label ...
Layout ...
LayoutAPI
LayoutCommon ...
LayoutField ...
LayoutSection ...
Location
Mapper
ModuleConfiguration
NewDockerImage
NewDockerImageResult
NotifiableItem ...
NotifyTimings - time control on notify items - retries max count and intervals.
OperatorArgument ...
Order
Output
Period holds the 'Period' query, such as last 3 days, last 6 hours, between 6 days from now until 3 days from now.
Playbook
PlaybookInput
PlaybookInputQuery
PlaybookOutput
PlaybookTask ...
ProcessInfo
QueryState
Question - question for a form with a given type.
RBAC
RelationshipAPI ...
RelationshipCommonFields ...
RelationshipFilter allows filtering on relationship objects. All given parameters must match to return a result,
Report
ReportAutomation ...
ReportFieldsDecoder ...
ReportQuery ...
ReputationData
SLA ...
Schedule ...
Scheduler ...
ScriptAPI ...
SearchIncidentsData ...
SearchInvestigationsData ...
SearchStats ...
SearchStatsDeletionResponse
SearchStatsResponse
Section ...
ShardedFields ...
StatsQueryResponse - Describe the data returned related to a specific widget cell in a dashboard.
StatsQueryResponseWithError - Describe the data returned related to a specific widget cell in a dashboard including errors.
StatsResponseWithReferenceLine - Describe the data returned related to a specific Line/Column chart widget cell in a dashboard.
StatsScatterResponse - Represent a scatter response from statistics.
StatsTextResponse - Describe the data returned related to a specific text widget cell in a dashboard.
StatsTrendsResponse
System
SystemAgent
Task
TaskCondition
TaskLoop
TerminalOptions
TimerTrigger ...
TypeAndKind
Unit42IndicatorLookup
Unit42SampleSearchFilter ...
Unit42SearchFilter ...
UpdateDataBatch ...
UpdateIndicatorBatch
UpdateResponse ...
Version represents a version.
VersionedCommit holds the commit info.
WhitelistedIndicator
Widget
WidgetCell ...
auditResult
automationScriptFilter
automationScriptFilterWrapper ...
automationScriptResult ...
containersInfo
deleteEvidence
evidencesFilterWrapper
genericIndicatorUpdateBatch
genericObjectTypesWithError
incidentFieldsWithErrors
incidentTypesWithErrors
indicatorContext
invPlaybookAssignee
invPlaybookDue
invTaskInfo
playbookWithWarnings
searchIncidents_200_response
tagsFieldValues
updateEntry
updateEntryTags
updateIndicatorReputationData
uploadedEntry

widget

optional

Widget

Body Parameter

Back to home page