Integrations

APIs for managing integrations

Upload an integration

post

Upload an integration to Cortex XSOAR

Authorizations

AuthorizationstringRequired

Body

filestringOptional

file

Responses

200

The saved configuration

application/json

ModuleConfiguration is the configuration parameters for a module

betabooleanOptional

brandstringOptional

cacheVersninteger · int64Optional

canGetSamplesbooleanOptional

categorystringOptional

cmdlinestringOptional

commitMessagestringOptional

createdstring · date-timeOptional

defaultClassifierstringOptional

defaultMapperInstringOptional

defaultMapperOutstringOptional

definitionIdstringOptional

deprecatedbooleanOptional

descriptionstringOptional

detailedDescriptionstringOptional

displaystringOptional

executablestringOptional

hiddenbooleanOptional

hideEnginesbooleanOptional

iconstringOptional

idstringOptional

imagestringOptional

indexNamestringOptional

isPasswordProtectedbooleanOptional

lockedbooleanOptional

modifiedstring · date-timeOptional

namestringOptional

numericIdinteger · int64Optional

packIDstringOptional

packNamestringOptional

packPropagationLabelsstring[]Optional

pathstringOptional

prevNamestringOptional

primaryTerminteger · int64Optional

privatebooleanOptional

propagationLabelsstring[]Optional

readonlybooleanOptional

remotebooleanOptional

scriptNotVisiblebooleanOptional

sectionOrderstring[]Optional

sequenceNumberinteger · int64Optional

shouldCommitbooleanOptional

sizeInBytesinteger · int64Optional

sortValuesstring[]Optional

sourceModuleIDstringOptional

syncHashstringOptional

systembooleanOptional

typestringOptional

vcShouldIgnorebooleanOptional

vcShouldKeepItemLegacyProdMachinebooleanOptional

versioninteger · int64Optional

videosstring[]Optional

post/settings/integration-conf/upload

POST /settings/integration-conf/upload HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15

{
  "file": "text"
}

200

The saved configuration

{
  "beta": true,
  "brand": "text",
  "cacheVersn": 1,
  "canGetSamples": true,
  "category": "text",
  "cmdline": "text",
  "commitMessage": "text",
  "configuration": [
    {
      "advanced": true,
      "defaultValue": "text",
      "display": "text",
      "displayPassword": "text",
      "hidden": true,
      "hiddenPassword": true,
      "hiddenUsername": true,
      "info": "text",
      "name": "text",
      "options": [
        "text"
      ],
      "required": true,
      "section": "text",
      "type": 1
    }
  ],
  "created": "2026-01-01T00:00:00.000Z",
  "defaultClassifier": "text",
  "defaultMapperIn": "text",
  "defaultMapperOut": "text",
  "definitionId": "text",
  "deprecated": true,
  "description": "text",
  "detailedDescription": "text",
  "display": "text",
  "executable": "text",
  "fromServerVersion": {
    "Digits": [
      1
    ],
    "Label": "text"
  },
  "hidden": true,
  "hideEngines": true,
  "highlight": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "icon": "text",
  "id": "text",
  "image": "text",
  "indexName": "text",
  "integrationScript": {
    "commands": [
      {
        "arguments": [
          {
            "auto": "text",
            "default": true,
            "defaultValue": "text",
            "deprecated": true,
            "description": "text",
            "hidden": true,
            "isArray": true,
            "name": "text",
            "predefined": [
              "text"
            ],
            "required": true,
            "secret": true,
            "type": "text"
          }
        ],
        "cartesian": true,
        "definitionId": "text",
        "deprecated": true,
        "description": "text",
        "docsHidden": true,
        "execution": true,
        "gomAction": true,
        "hidden": true,
        "important": [
          {
            "contextPath": "text",
            "description": "text",
            "related": "text"
          }
        ],
        "indicatorAction": true,
        "name": "text",
        "outputs": [
          {
            "contentPath": "text",
            "contextPath": "text",
            "description": {},
            "type": "text"
          }
        ],
        "permitted": true,
        "polling": true,
        "sensitive": true,
        "timeout": 1
      }
    ],
    "dockerImage": "text",
    "feed": true,
    "isFetch": true,
    "isFetchCredentials": true,
    "isFetchEvents": true,
    "isFetchSamples": true,
    "isMappable": true,
    "isRemoteSyncIn": true,
    "isRemoteSyncOut": true,
    "longRunning": true,
    "longRunningPortMapping": true,
    "resetContext": true,
    "runOnce": true,
    "script": "text",
    "subtype": "text",
    "type": "text"
  },
  "isPasswordProtected": true,
  "itemVersion": {
    "Digits": [
      1
    ],
    "Label": "text"
  },
  "locked": true,
  "modified": "2026-01-01T00:00:00.000Z",
  "name": "text",
  "numericId": 1,
  "packID": "text",
  "packName": "text",
  "packPropagationLabels": [
    "text"
  ],
  "path": "text",
  "prevName": "text",
  "primaryTerm": 1,
  "private": true,
  "propagationLabels": [
    "text"
  ],
  "readonly": true,
  "remote": true,
  "scriptNotVisible": true,
  "sectionOrder": [
    "text"
  ],
  "sequenceNumber": 1,
  "shouldCommit": true,
  "sizeInBytes": 1,
  "sortValues": [
    "text"
  ],
  "sourceModuleID": "text",
  "syncHash": "text",
  "system": true,
  "toServerVersion": {
    "Digits": [
      1
    ],
    "Label": "text"
  },
  "type": "text",
  "vcShouldIgnore": true,
  "vcShouldKeepItemLegacyProdMachine": true,
  "version": 1,
  "videos": [
    "text"
  ]
}