> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/xsoar-6-api/cortex-xsoar-6.x-apis/integrations.md).

# Integrations

APIs for managing integrations

## Upload an integration

> Upload an integration to Cortex XSOAR

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 6 API","version":"6"},"tags":[{"name":"Integrations","description":"APIs for managing integrations"}],"servers":[{"url":"https://hostname"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header"}},"requestBodies":{"importScript":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"file","type":"string"}}}}}}},"schemas":{"ModuleConfiguration":{"type":"object","description":"ModuleConfiguration is the configuration parameters for a module","properties":{"beta":{"type":"boolean"},"brand":{"type":"string"},"cacheVersn":{"type":"integer","format":"int64"},"canGetSamples":{"type":"boolean"},"category":{"type":"string"},"cmdline":{"type":"string"},"commitMessage":{"type":"string"},"configuration":{"type":"array","items":{"$ref":"#/components/schemas/ConfigField"}},"created":{"type":"string","format":"date-time"},"defaultClassifier":{"type":"string"},"defaultMapperIn":{"type":"string"},"defaultMapperOut":{"type":"string"},"definitionId":{"type":"string"},"deprecated":{"type":"boolean"},"description":{"type":"string"},"detailedDescription":{"type":"string"},"display":{"type":"string"},"executable":{"type":"string"},"fromServerVersion":{"$ref":"#/components/schemas/Version"},"hidden":{"type":"boolean"},"hideEngines":{"type":"boolean"},"highlight":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"icon":{"type":"string"},"id":{"type":"string"},"image":{"type":"string"},"indexName":{"type":"string"},"integrationScript":{"$ref":"#/components/schemas/IntegrationScript"},"isPasswordProtected":{"type":"boolean"},"itemVersion":{"$ref":"#/components/schemas/Version"},"locked":{"type":"boolean"},"modified":{"type":"string","format":"date-time"},"name":{"type":"string"},"numericId":{"type":"integer","format":"int64"},"packID":{"type":"string"},"packName":{"type":"string"},"packPropagationLabels":{"type":"array","items":{"type":"string"}},"path":{"type":"string"},"prevName":{"type":"string"},"primaryTerm":{"type":"integer","format":"int64"},"private":{"type":"boolean"},"propagationLabels":{"type":"array","items":{"type":"string"}},"readonly":{"type":"boolean"},"remote":{"type":"boolean"},"scriptNotVisible":{"type":"boolean"},"sectionOrder":{"type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"integer","format":"int64"},"shouldCommit":{"type":"boolean"},"sizeInBytes":{"type":"integer","format":"int64"},"sortValues":{"type":"array","items":{"type":"string"}},"sourceModuleID":{"type":"string"},"syncHash":{"type":"string"},"system":{"type":"boolean"},"toServerVersion":{"$ref":"#/components/schemas/Version"},"type":{"type":"string"},"vcShouldIgnore":{"type":"boolean"},"vcShouldKeepItemLegacyProdMachine":{"type":"boolean"},"version":{"type":"integer","format":"int64"},"videos":{"type":"array","items":{"type":"string"}}}},"ConfigField":{"type":"object","description":"ConfigField holds a configuration field","properties":{"advanced":{"type":"boolean"},"defaultValue":{"type":"string"},"display":{"type":"string"},"displayPassword":{"type":"string"},"hidden":{"type":"boolean"},"hiddenPassword":{"type":"boolean"},"hiddenUsername":{"type":"boolean"},"info":{"type":"string"},"name":{"type":"string"},"options":{"type":"array","items":{"type":"string"}},"required":{"type":"boolean"},"section":{"type":"string"},"type":{"$ref":"#/components/schemas/ConfigDataType"}}},"ConfigDataType":{"type":"number","description":"ConfigDataType holds the type of a configuration field or command argument","format":"double"},"Version":{"type":"object","title":"Version represents a version.","properties":{"Digits":{"type":"array","description":"WARNING: when adding new attributes or changing the names\nof the existing ones, remember to add support in UnmarshalJSON\nfor items that were exported by msgpack.","items":{"type":"integer","format":"int64"}},"Label":{"type":"string"}}},"IntegrationScript":{"type":"object","title":"IntegrationScript ...","properties":{"commands":{"type":"array","items":{"$ref":"#/components/schemas/Command"}},"dockerImage":{"type":"string"},"feed":{"type":"boolean"},"isFetch":{"type":"boolean"},"isFetchCredentials":{"type":"boolean"},"isFetchEvents":{"type":"boolean"},"isFetchSamples":{"type":"boolean"},"isMappable":{"type":"boolean"},"isRemoteSyncIn":{"type":"boolean"},"isRemoteSyncOut":{"type":"boolean"},"longRunning":{"type":"boolean"},"longRunningPortMapping":{"type":"boolean"},"resetContext":{"type":"boolean"},"runOnce":{"type":"boolean"},"script":{"type":"string"},"subtype":{"$ref":"#/components/schemas/ScriptSubType"},"type":{"$ref":"#/components/schemas/ScriptType"}}},"Command":{"type":"object","description":"Command supported by a module","properties":{"arguments":{"type":"array","items":{"$ref":"#/components/schemas/Argument"}},"cartesian":{"type":"boolean"},"definitionId":{"type":"string"},"deprecated":{"type":"boolean"},"description":{"type":"string"},"docsHidden":{"type":"boolean"},"execution":{"type":"boolean"},"gomAction":{"type":"boolean"},"hidden":{"type":"boolean"},"important":{"type":"array","items":{"$ref":"#/components/schemas/Important"}},"indicatorAction":{"type":"boolean"},"name":{"type":"string"},"outputs":{"type":"array","items":{"$ref":"#/components/schemas/Output"}},"permitted":{"type":"boolean"},"polling":{"type":"boolean"},"sensitive":{"type":"boolean"},"timeout":{"type":"integer","format":"int64"}}},"Argument":{"type":"object","description":"Argument to a module command","properties":{"auto":{"type":"string"},"default":{"type":"boolean"},"defaultValue":{"type":"string"},"deprecated":{"type":"boolean"},"description":{"type":"string"},"hidden":{"type":"boolean"},"isArray":{"type":"boolean"},"name":{"type":"string"},"predefined":{"type":"array","items":{"type":"string"}},"required":{"type":"boolean"},"secret":{"type":"boolean"},"type":{"$ref":"#/components/schemas/ArgumentType"}}},"ArgumentType":{"type":"string","title":"ArgumentType ..."},"Important":{"type":"object","description":"Important The important outputs of a given command","properties":{"contextPath":{"type":"string"},"description":{"type":"string","description":"Description is either a string or a map from string to interface"},"related":{"type":"string","description":"To what other context path this output is related"}}},"Output":{"type":"object","description":"Output of a module command","properties":{"contentPath":{"type":"string"},"contextPath":{"type":"string"},"description":{"type":"object","description":"Description is either a string or a map from string to interface"},"type":{"$ref":"#/components/schemas/OutputType"}}},"OutputType":{"type":"string","title":"OutputType ..."},"ScriptSubType":{"type":"string","description":"ScriptSubType holds the script type version"},"ScriptType":{"type":"string","description":"ScriptType holds the type of a script"}}},"paths":{"/settings/integration-conf/upload":{"post":{"summary":"Upload an integration","description":"Upload an integration to Cortex XSOAR","operationId":"integrationUpload","requestBody":{"$ref":"#/components/requestBodies/importScript"},"responses":{"200":{"description":"The saved configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleConfiguration"}}}}},"tags":["Integrations"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://cortex-docs.paloaltonetworks.com/xsoar-6-api/cortex-xsoar-6.x-apis/integrations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.