Upload an integration

Cortex XSOAR 6 API

post /settings/integration-conf/upload

Upload an integration to Cortex XSOAR

CURL
curl -X POST \ -H "Authorization: [[apiKey]]" \ -H "Accept: application/json" \ -H "Content-Type: multipart/form-data" \ "https://hostname:443/settings/integration-conf/upload"
Authentication: api_key Api Key "Authorization"
Form parameters
file
required
Object format: binary
file format: binary
Example: BINARY_DATA_HERE
Responses

The saved configuration

Body
ModuleConfiguration is the configuration parameters for a module
beta
optional
Boolean
brand
optional
String
cacheVersn
optional
Number (Long)
format: int64
canGetSamples
optional
Boolean
category
optional
String
cmdline
optional
String
commitMessage
optional
String
configuration
optional
Array
ConfigField holds a configuration field
advanced
optional
Boolean
defaultValue
optional
String
display
optional
String
displayPassword
optional
String
hidden
optional
Boolean
hiddenPassword
optional
Boolean
hiddenUsername
optional
Boolean
info
optional
String
name
optional
String
options
optional
Array of strings
required
optional
Boolean
section
optional
String
type
optional
Number (Double)
ConfigDataType holds the type of a configuration field or command argument format: double
created
optional
Object
format: date-time
defaultClassifier
optional
String
defaultMapperIn
optional
String
defaultMapperOut
optional
String
definitionId
optional
String
deprecated
optional
Boolean
description
optional
String
detailedDescription
optional
String
display
optional
String
executable
optional
String
fromServerVersion
optional
Digits
optional
Array of numbers (Long)
WARNING: when adding new attributes or changing the names of the existing ones, remember to add support in UnmarshalJSON for items that were exported by msgpack. format: int64
Label
optional
String
hidden
optional
Boolean
hideEngines
optional
Boolean
highlight
optional
Map
icon
optional
String
id
optional
String
image
optional
String
indexName
optional
String
integrationScript
optional
commands
optional
Array
Command supported by a module
arguments
optional
Array
Argument to a module command
auto
optional
String
default
optional
Boolean
defaultValue
optional
String
deprecated
optional
Boolean
description
optional
String
hidden
optional
Boolean
isArray
optional
Boolean
name
optional
String
predefined
optional
Array of strings
required
optional
Boolean
secret
optional
Boolean
type
optional
String
cartesian
optional
Boolean
definitionId
optional
String
deprecated
optional
Boolean
description
optional
String
docsHidden
optional
Boolean
execution
optional
Boolean
gomAction
optional
Boolean
hidden
optional
Boolean
important
optional
Array
Important The important outputs of a given command
contextPath
optional
String
description
optional
String
Description is either a string or a map from string to interface
related
optional
String
To what other context path this output is related
indicatorAction
optional
Boolean
name
optional
String
outputs
optional
Array
Output of a module command
contentPath
optional
String
contextPath
optional
String
description
optional
Object
Description is either a string or a map from string to interface
type
optional
String
permitted
optional
Boolean
polling
optional
Boolean
sensitive
optional
Boolean
timeout
optional
Number (Long)
format: int64
dockerImage
optional
String
feed
optional
Boolean
isFetch
optional
Boolean
isFetchCredentials
optional
Boolean
isFetchEvents
optional
Boolean
isFetchSamples
optional
Boolean
isMappable
optional
Boolean
isRemoteSyncIn
optional
Boolean
isRemoteSyncOut
optional
Boolean
longRunning
optional
Boolean
longRunningPortMapping
optional
Boolean
resetContext
optional
Boolean
runOnce
optional
Boolean
script
optional
String
subtype
optional
String
ScriptSubType holds the script type version
type
optional
String
ScriptType holds the type of a script
isPasswordProtected
optional
Boolean
itemVersion
optional
Digits
optional
Array of numbers (Long)
WARNING: when adding new attributes or changing the names of the existing ones, remember to add support in UnmarshalJSON for items that were exported by msgpack. format: int64
Label
optional
String
locked
optional
Boolean
modified
optional
Object
format: date-time
name
optional
String
numericId
optional
Number (Long)
format: int64
packID
optional
String
packName
optional
String
packPropagationLabels
optional
Array of strings
path
optional
String
prevName
optional
String
primaryTerm
optional
Number (Long)
format: int64
private
optional
Boolean
propagationLabels
optional
Array of strings
readonly
optional
Boolean
remote
optional
Boolean
scriptNotVisible
optional
Boolean
sectionOrder
optional
Array of strings
sequenceNumber
optional
Number (Long)
format: int64
shouldCommit
optional
Boolean
sizeInBytes
optional
Number (Long)
format: int64
sortValues
optional
Array of strings
sourceModuleID
optional
String
syncHash
optional
String
system
optional
Boolean
toServerVersion
optional
Digits
optional
Array of numbers (Long)
WARNING: when adding new attributes or changing the names of the existing ones, remember to add support in UnmarshalJSON for items that were exported by msgpack. format: int64
Label
optional
String
type
optional
String
vcShouldIgnore
optional
Boolean
vcShouldKeepItemLegacyProdMachine
optional
Boolean
version
optional
Number (Long)
format: int64
videos
optional
Array of strings