> 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-8-api/cortex-xsoar-8.x-apis/integrations.md).

# Integrations

APIs for managing indicators

## Get all integrations

> Get all integrations.

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Integrations","description":"APIs for managing indicators"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/settings/integration-commands":{"get":{"summary":"Get all integrations","tags":["Integrations"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"display":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"detailedDescription":{"type":"string"},"feed":{"type":"boolean"},"commands":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"deprecated":{"type":"boolean"},"arguments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"deprecated":{"type":"boolean"},"hidden":{"type":"boolean"},"default":{"type":"boolean"},"secret":{"type":"boolean"},"description":{"type":"string"},"defaultValue":{"type":"string"},"type":{"type":"string"}}}},"outputs":{"type":"null"},"important":{"type":"null"},"description":{"type":"string"},"execution":{"type":"boolean"},"cartesian":{"type":"boolean"},"hidden":{"type":"boolean"},"docsHidden":{"type":"boolean"},"sensitive":{"type":"boolean"},"timeout":{"type":"integer"},"permitted":{"type":"boolean"},"indicatorAction":{"type":"boolean"},"definitionId":{"type":"string"},"gomAction":{"type":"boolean"},"polling":{"type":"boolean"}}}}}}}}}}},"operationId":"get-xsoar-settings-integration-commands","description":"Get all integrations."}}}}
```

## Get an integration instance by its ID

> Search for integration instances by instance ID.
> \\
>
> \
> \*\*Note:\*\* This endpoint is supported in XSOAR 8.8 and later.

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Integrations","description":"APIs for managing indicators"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/settings/integration/search?id=instanceID":{"post":{"summary":"Get an integration instance by its ID","tags":["Integrations"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"instances":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"sequenceNumber":{"type":"integer"},"primaryTerm":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"sortValues":{"type":"array","items":{"type":"string"}},"packID":{"type":"string"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"fromServerVersion":{"type":"string"},"toServerVersion":{"type":"string"},"propagationLabels":{"type":"array","items":{"type":"string"}},"definitionId":{"type":"string"},"prevName":{"type":"string"},"password":{"type":"string"},"enabled":{"type":"string"},"name":{"type":"string"},"configvalues":{"type":"object","properties":{"create_relationships":{"type":"boolean"},"feed":{"type":"boolean"},"feedBypassExclusionList":{"type":"boolean"},"feedFetchInterval":{"type":"string"},"feedIncremental":{"type":"boolean"},"feedReliability":{"type":"string"},"url":{"type":"string"}}},"configtypes":{"type":"object","properties":{"create_relationships":{"type":"integer"},"feed":{"type":"integer"},"feedBypassExclusionList":{"type":"integer"},"feedFetchInterval":{"type":"integer"},"feedIncremental":{"type":"integer"},"feedReliability":{"type":"integer"},"url":{"type":"integer"}}},"brand":{"type":"string"},"category":{"type":"string"},"path":{"type":"string"},"executable":{"type":"string"},"cmdline":{"type":"string"},"engine":{"type":"string"},"engineGroup":{"type":"string"},"hidden":{"type":"boolean"},"isIntegrationScript":{"type":"boolean"},"islongRunning":{"type":"boolean"},"mappingId":{"type":"string"},"outgoingMapperId":{"type":"string"},"incomingMapperId":{"type":"string"},"remoteSync":{"type":"boolean"},"isSystemIntegration":{"type":"boolean"},"canSample":{"type":"boolean"},"defaultIgnore":{"type":"boolean"},"integrationLogLevel":{"type":"string"},"commandsPermissions":{"type":"null"},"longRunningId":{"type":"string"},"incidentFetchInterval":{"type":"integer"},"eventFetchInterval":{"type":"integer"},"assetsFetchInterval":{"type":"integer"},"servicesID":{"type":"string"},"isBuiltin":{"type":"boolean"},"configuration":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"packID":{"type":"string"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"fromServerVersion":{"type":"string"},"toServerVersion":{"type":"string"},"definitionId":{"type":"string"},"vcShouldIgnore":{"type":"boolean"},"vcShouldKeepItemLegacyProdMachine":{"type":"boolean"},"commitMessage":{"type":"string"},"shouldCommit":{"type":"boolean"},"name":{"type":"string"},"prevName":{"type":"string"},"display":{"type":"string"},"brand":{"type":"string"},"category":{"type":"string"},"icon":{"type":"string"},"description":{"type":"string"},"configuration":{"type":"null"},"integrationScript":{"type":"null"},"hidden":{"type":"boolean"},"canGetSamples":{"type":"boolean"}}},"data":{"type":"array","items":{"type":"object","properties":{"display":{"type":"string"},"displayPassword":{"type":"string"},"name":{"type":"string"},"defaultValue":{"type":"string"},"type":{"type":"integer"},"required":{"type":"boolean"},"hidden":{"type":"boolean"},"hiddenUsername":{"type":"boolean"},"hiddenPassword":{"type":"boolean"},"options":{"type":["array","null"],"items":{"type":"string"}},"info":{"type":"string"},"hasvalue":{"type":"boolean"},"value":{"type":["boolean","string"]}}}},"displayPassword":{"type":"string"},"passwordProtected":{"type":"boolean"},"mappable":{"type":"boolean"},"remoteSyncableIn":{"type":"boolean"},"remoteSyncableOut":{"type":"boolean"},"isFetchSamples":{"type":"boolean"},"debugMode":{"type":"boolean"}}}},"configurations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"sequenceNumber":{"type":"integer"},"primaryTerm":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"sortValues":{"type":"array","items":{"type":"string"}},"packID":{"type":"string"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"fromServerVersion":{"type":"string"},"toServerVersion":{"type":"string"},"propagationLabels":{"type":"array","items":{"type":"object","properties":{}}},"packPropagationLabels":{"type":"array","items":{"type":"string"}},"definitionId":{"type":"string"},"vcShouldIgnore":{"type":"boolean"},"vcShouldKeepItemLegacyProdMachine":{"type":"boolean"},"commitMessage":{"type":"string"},"shouldCommit":{"type":"boolean"},"name":{"type":"string"},"prevName":{"type":"string"},"display":{"type":"string"},"brand":{"type":"string"},"category":{"type":"string"},"icon":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"detailedDescription":{"type":"string"},"configuration":{"type":"array","items":{"type":"object","properties":{"display":{"type":"string"},"displayPassword":{"type":"string"},"name":{"type":"string"},"defaultValue":{"type":"string"},"type":{"type":"integer"},"required":{"type":"boolean"},"hidden":{"type":"boolean"},"hiddenUsername":{"type":"boolean"},"hiddenPassword":{"type":"boolean"},"options":{"type":"null"},"info":{"type":"string"}}}},"integrationScript":{"type":"object","properties":{"script":{"type":"string"},"type":{"type":"string"},"commands":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"deprecated":{"type":"boolean"},"arguments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"deprecated":{"type":"boolean"},"hidden":{"type":"boolean"},"default":{"type":"boolean"},"secret":{"type":"boolean"},"description":{"type":"string"},"type":{"type":"string"}}}},"outputs":{"type":"array","items":{"type":"object","properties":{"contentPath":{"type":"string"},"contextPath":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"}}}},"important":{"type":"null"},"description":{"type":"string"},"execution":{"type":"boolean"},"cartesian":{"type":"boolean"},"hidden":{"type":"boolean"},"docsHidden":{"type":"boolean"},"sensitive":{"type":"boolean"},"timeout":{"type":"integer"},"permitted":{"type":"boolean"},"indicatorAction":{"type":"boolean"},"definitionId":{"type":"string"},"gomAction":{"type":"boolean"},"polling":{"type":"boolean"}}}},"dockerImage":{"type":"string"},"isFetch":{"type":"boolean"},"isFetchEvents":{"type":"boolean"},"isFetchAssets":{"type":"boolean"},"feed":{"type":"boolean"},"isFetchCredentials":{"type":"boolean"},"runOnce":{"type":"boolean"},"longRunning":{"type":"boolean"},"longRunningPortMapping":{"type":"boolean"},"subtype":{"type":"string"},"isMappable":{"type":"boolean"},"isRemoteSyncIn":{"type":"boolean"},"isRemoteSyncOut":{"type":"boolean"},"isFetchSamples":{"type":"boolean"},"resetContext":{"type":"boolean"}}},"system":{"type":"boolean"},"hidden":{"type":"boolean"},"canGetSamples":{"type":"boolean"}}}},"engines":{"type":"object","properties":{"engines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"sequenceNumber":{"type":"integer"},"primaryTerm":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"sortValues":{"type":"array","items":{"type":"string"}},"packID":{"type":"string"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"fromServerVersion":{"type":"string"},"toServerVersion":{"type":"string"},"definitionId":{"type":"string"},"prevName":{"type":"string"},"name":{"type":"string"},"allowOnTenant":{"type":"boolean"},"locked":{"type":"boolean"},"lastSeen":{"type":"string"},"firstSeen":{"type":"string"},"lastConnectedApp":{"type":"string"},"lastDisconnect":{"type":"string"},"serviceName":{"type":"string"},"host":{"type":"string"},"user":{"type":"string"},"pkgType":{"type":"string"},"pkgName":{"type":"string"},"config":{"type":"string"},"baseUrl":{"type":"string"},"engineGroup":{"type":"string"},"protocolVersion":{"type":"string"},"os":{"type":"string"},"demistoVersion":{"type":"string"},"buildVersion":{"type":"string"},"md5":{"type":"string"},"underUpgrade":{"type":"boolean"},"tenantNames":{"type":"null"},"workers":{"type":"integer"},"isDefault":{"type":"boolean"},"isLegacy":{"type":"boolean"},"packageFileHash":{"type":"string"},"pyramidAPIEncryptedAuthenticationHeader":{"type":"string"},"pyramidAPIEncryptedAuthenticationHeaderTenants":{"type":"null"},"connected":{"type":"boolean"},"modules":{"type":"null"}}}},"total":{"type":"integer"},"pkgTypes":{"type":"array","items":{"type":"string"}},"requestedLogs":{"type":"object","properties":{}},"engineGroups":{"type":"array","items":{"type":"object","properties":{}}}}},"health":{"type":"object","properties":{"AutoFocusTagsFeed_default_instance":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"sequenceNumber":{"type":"integer"},"primaryTerm":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"sortValues":{"type":"array","items":{"type":"string"}},"brand":{"type":"string"},"instance":{"type":"string"},"incidentsPulled":{"type":"integer"},"indicatorsPulled":{"type":"integer"},"eventsPulled":{"type":"integer"},"assetsPulled":{"type":"integer"},"type":{"type":"integer"},"incidentsDropped":{"type":"integer"},"lastPullTime":{"type":"string"},"lastError":{"type":"string"},"lastIngestionDuration":{"type":"integer"},"fetchDuration":{"type":"integer"},"creation_time":{"type":"string"},"sum_hour":{"type":"integer"},"sum_day":{"type":"integer"},"sum_week":{"type":"integer"}}}}}}}}}}},"operationId":"post-xsoar-settings-integration-search","description":"Search for integration instances by instance ID.\r\n\r\n**Note:** This endpoint is supported in XSOAR 8.8 and later.","parameters":[{"schema":{"type":"string"},"in":"query","name":"id","description":"Integration instance ID"}]}}}}
```

## Delete an integration instance by its ID

> Delete an integration instance identified by its ID.

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Integrations","description":"APIs for managing indicators"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/settings/integration/{instance_id}":{"delete":{"summary":"Delete an integration instance by its ID","tags":["Integrations"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"operationId":"delete-settings-integration-id","parameters":[{"schema":{"type":"string"},"in":"header","name":"authorization","description":"api_key","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"api_key_id","required":true}],"description":"Delete an integration instance identified by its ID."}}}}
```

## Get details on integration instances, engines, and health

> Get details on all of the integrations, integration instances, engines, and health.
> \\
>
> \
> The response is likely to be very large.

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Integrations","description":"APIs for managing indicators"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/settings/integration/search":{"post":{"summary":"Get details on integration instances, engines, and health","tags":["Integrations"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"configurations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"sequenceNumber":{"type":"integer"},"primaryTerm":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"sortValues":{"type":"array","items":{"type":"string"}},"packID":{"type":"string"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"fromServerVersion":{"type":"string"},"toServerVersion":{"type":"string"},"propagationLabels":{"type":"array","items":{"type":"object","properties":{}}},"packPropagationLabels":{"type":"array","items":{"type":"string"}},"definitionId":{"type":"string"},"vcShouldIgnore":{"type":"boolean"},"vcShouldKeepItemLegacyProdMachine":{"type":"boolean"},"commitMessage":{"type":"string"},"shouldCommit":{"type":"boolean"},"name":{"type":"string"},"prevName":{"type":"string"},"display":{"type":"string"},"brand":{"type":"string"},"category":{"type":"string"},"icon":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"detailedDescription":{"type":"string"},"configuration":{"type":"array","items":{"type":"object","properties":{"display":{"type":"string"},"displayPassword":{"type":"string"},"name":{"type":"string"},"defaultValue":{"type":"string"},"type":{"type":"integer"},"required":{"type":"boolean"},"hidden":{"type":"boolean"},"hiddenUsername":{"type":"boolean"},"hiddenPassword":{"type":"boolean"},"options":{"type":["array","null"],"items":{"type":"string"}},"info":{"type":"string"}}}},"integrationScript":{"type":"object","properties":{"script":{"type":"string"},"type":{"type":"string"},"commands":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"deprecated":{"type":"boolean"},"arguments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"required":{"type":"boolean"},"deprecated":{"type":"boolean"},"hidden":{"type":"boolean"},"default":{"type":"boolean"},"secret":{"type":"boolean"},"description":{"type":"string"},"defaultValue":{"type":"string"},"type":{"type":"string"}}}},"outputs":{"type":"null"},"important":{"type":"null"},"description":{"type":"string"},"execution":{"type":"boolean"},"cartesian":{"type":"boolean"},"hidden":{"type":"boolean"},"docsHidden":{"type":"boolean"},"sensitive":{"type":"boolean"},"timeout":{"type":"integer"},"permitted":{"type":"boolean"},"indicatorAction":{"type":"boolean"},"definitionId":{"type":"string"},"gomAction":{"type":"boolean"},"polling":{"type":"boolean"}}}},"dockerImage":{"type":"string"},"nativeImage":{"type":"array","items":{"type":"string"}},"isFetch":{"type":"boolean"},"isFetchEvents":{"type":"boolean"},"isFetchAssets":{"type":"boolean"},"feed":{"type":"boolean"},"isFetchCredentials":{"type":"boolean"},"runOnce":{"type":"boolean"},"longRunning":{"type":"boolean"},"longRunningPortMapping":{"type":"boolean"},"subtype":{"type":"string"},"isMappable":{"type":"boolean"},"isRemoteSyncIn":{"type":"boolean"},"isRemoteSyncOut":{"type":"boolean"},"isFetchSamples":{"type":"boolean"},"resetContext":{"type":"boolean"}}},"system":{"type":"boolean"},"hidden":{"type":"boolean"},"canGetSamples":{"type":"boolean"}}}},"engines":{"type":"object","properties":{"engines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"sequenceNumber":{"type":"integer"},"primaryTerm":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"sortValues":{"type":"array","items":{"type":"string"}},"packID":{"type":"string"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"fromServerVersion":{"type":"string"},"toServerVersion":{"type":"string"},"definitionId":{"type":"string"},"prevName":{"type":"string"},"name":{"type":"string"},"allowOnTenant":{"type":"boolean"},"locked":{"type":"boolean"},"lastSeen":{"type":"string"},"firstSeen":{"type":"string"},"lastConnectedApp":{"type":"string"},"lastDisconnect":{"type":"string"},"serviceName":{"type":"string"},"host":{"type":"string"},"user":{"type":"string"},"pkgType":{"type":"string"},"pkgName":{"type":"string"},"config":{"type":"string"},"baseUrl":{"type":"string"},"engineGroup":{"type":"string"},"protocolVersion":{"type":"string"},"os":{"type":"string"},"demistoVersion":{"type":"string"},"buildVersion":{"type":"string"},"md5":{"type":"string"},"underUpgrade":{"type":"boolean"},"tenantNames":{"type":"null"},"workers":{"type":"integer"},"isDefault":{"type":"boolean"},"isLegacy":{"type":"boolean"},"packageFileHash":{"type":"string"},"pyramidAPIEncryptedAuthenticationHeader":{"type":"string"},"pyramidAPIEncryptedAuthenticationHeaderTenants":{"type":"null"},"connected":{"type":"boolean"},"modules":{"type":"null"}}}},"total":{"type":"integer"},"pkgTypes":{"type":"array","items":{"type":"string"}},"requestedLogs":{"type":"object","properties":{}},"engineGroups":{"type":"array","items":{"type":"object","properties":{}}}}},"health":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"sequenceNumber":{"type":"integer"},"primaryTerm":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"sortValues":{"type":"array","items":{"type":"string"}},"brand":{"type":"string"},"instance":{"type":"string"},"incidentsPulled":{"type":"integer"},"indicatorsPulled":{"type":"integer"},"eventsPulled":{"type":"integer"},"assetsPulled":{"type":"integer"},"type":{"type":"integer"},"incidentsDropped":{"type":"integer"},"lastPullTime":{"type":"string"},"lastError":{"type":"string"},"lastIngestionDuration":{"type":"integer"},"fetchDuration":{"type":"integer"},"creation_time":{"type":"string"},"sum_hour":{"type":"integer"},"sum_day":{"type":"integer"},"sum_week":{"type":"integer"}}},"rocket_test_xsoar_long_running_integration_fetch_incidents_NbrfwigR":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"sequenceNumber":{"type":"integer"},"primaryTerm":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"sortValues":{"type":"array","items":{"type":"string"}},"brand":{"type":"string"},"instance":{"type":"string"},"incidentsPulled":{"type":"integer"},"indicatorsPulled":{"type":"integer"},"eventsPulled":{"type":"integer"},"assetsPulled":{"type":"integer"},"type":{"type":"integer"},"incidentsDropped":{"type":"integer"},"lastPullTime":{"type":"string"},"lastError":{"type":"string"},"lastIngestionDuration":{"type":"integer"},"fetchDuration":{"type":"integer"},"creation_time":{"type":"string"},"sum_hour":{"type":"integer"},"sum_day":{"type":"integer"},"sum_week":{"type":"integer"}}},"instances":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"sequenceNumber":{"type":"integer"},"primaryTerm":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"sortValues":{"type":"array","items":{"type":"string"}},"packID":{"type":"string"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"fromServerVersion":{"type":"string"},"toServerVersion":{"type":"string"},"propagationLabels":{"type":"array","items":{"type":"string"}},"definitionId":{"type":"string"},"prevName":{"type":"string"},"password":{"type":"string"},"enabled":{"type":"string"},"name":{"type":"string"},"configvalues":{"type":"object","properties":{"create_relationships":{"type":"boolean"},"feed":{"type":"boolean"},"feedBypassExclusionList":{"type":"boolean"},"feedFetchInterval":{"type":"string"},"feedIncremental":{"type":"boolean"},"feedReliability":{"type":"string"},"url":{"type":"string"}}},"configtypes":{"type":"object","properties":{"create_relationships":{"type":"integer"},"feed":{"type":"integer"},"feedBypassExclusionList":{"type":"integer"},"feedFetchInterval":{"type":"integer"},"feedIncremental":{"type":"integer"},"feedReliability":{"type":"integer"},"url":{"type":"integer"}}},"brand":{"type":"string"},"category":{"type":"string"},"path":{"type":"string"},"executable":{"type":"string"},"cmdline":{"type":"string"},"engine":{"type":"string"},"engineGroup":{"type":"string"},"hidden":{"type":"boolean"},"isIntegrationScript":{"type":"boolean"},"islongRunning":{"type":"boolean"},"mappingId":{"type":"string"},"outgoingMapperId":{"type":"string"},"incomingMapperId":{"type":"string"},"remoteSync":{"type":"boolean"},"isSystemIntegration":{"type":"boolean"},"canSample":{"type":"boolean"},"defaultIgnore":{"type":"boolean"},"integrationLogLevel":{"type":"string"},"commandsPermissions":{"type":"null"},"longRunningId":{"type":"string"},"incidentFetchInterval":{"type":"integer"},"eventFetchInterval":{"type":"integer"},"assetsFetchInterval":{"type":"integer"},"servicesID":{"type":"string"},"isBuiltin":{"type":"boolean"},"hybrid":{"type":"boolean"},"configuration":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"packID":{"type":"string"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"fromServerVersion":{"type":"string"},"toServerVersion":{"type":"string"},"definitionId":{"type":"string"},"vcShouldIgnore":{"type":"boolean"},"vcShouldKeepItemLegacyProdMachine":{"type":"boolean"},"commitMessage":{"type":"string"},"shouldCommit":{"type":"boolean"},"name":{"type":"string"},"prevName":{"type":"string"},"display":{"type":"string"},"brand":{"type":"string"},"category":{"type":"string"},"icon":{"type":"string"},"description":{"type":"string"},"configuration":{"type":"null"},"integrationScript":{"type":"null"},"hidden":{"type":"boolean"},"canGetSamples":{"type":"boolean"}}},"data":{"type":"array","items":{"type":"object","properties":{"display":{"type":"string"},"displayPassword":{"type":"string"},"name":{"type":"string"},"defaultValue":{"type":"string"},"type":{"type":"integer"},"required":{"type":"boolean"},"hidden":{"type":"boolean"},"hiddenUsername":{"type":"boolean"},"hiddenPassword":{"type":"boolean"},"options":{"type":"null"},"info":{"type":"string"},"hasvalue":{"type":"boolean"},"value":{"type":["boolean","string"]}}}},"displayPassword":{"type":"string"},"passwordProtected":{"type":"boolean"},"mappable":{"type":"boolean"},"remoteSyncableIn":{"type":"boolean"},"remoteSyncableOut":{"type":"boolean"},"isFetchSamples":{"type":"boolean"},"debugMode":{"type":"boolean"}}}}}}}}}},"operationId":"post-settings-integration-search","parameters":[{"schema":{"type":"string"},"in":"header","name":"authorization","description":"api_key","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"api_key_id","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"description":"Get details on all of the integrations, integration instances, engines, and health.\r\n\r\nThe response is likely to be very large."}}}}
```

## Fetch a integration instance's execution history

> For integrations that fetch incidents or indicators in predefined intervals, fetch the execution history for the specified integration instance.\
> \
> \*\*Note:\*\* The \`lastRun\` field in each history entry is a serialized JSON string representing internal integration state. This field has a size limitation and may be truncated for integrations with large state objects. When truncated, the value may not be valid JSON. Do not rely on parsing \`lastRun\` for production monitoring workflows.

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Integrations","description":"APIs for managing indicators"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/settings/integration/fetch-history":{"post":{"summary":"Fetch a integration instance's execution history","tags":["Integrations"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"brand":{"type":"string"},"instance":{"type":"string"},"incidentsPulled":{"type":"integer"},"indicatorsPulled":{"type":"integer"},"eventsPulled":{"type":"integer"},"assetsPulled":{"type":"integer"},"type":{"type":"integer"},"incidentsDropped":{"type":"integer"},"lastPullTime":{"type":"string"},"lastError":{"type":"string"},"lastIngestionDuration":{"type":"integer"},"fetchDuration":{"type":"integer"},"creation_time":{"type":"string"},"sum_hour":{"type":"integer"},"sum_day":{"type":"integer"},"sum_week":{"type":"integer"},"status":{"type":"string"},"lastRun":{"type":"string","description":"A serialized JSON string containing the integration instance's internal fetch state. This field has a size limitation and may be truncated, resulting in invalid JSON."}}}},"instance":{"type":"string"},"brand":{"type":"string"}}}}}}},"operationId":"post-xsoar-public-v1-settings-integration-fetch-history","parameters":[{"schema":{"type":"string"},"in":"header","name":"authorization","description":"api_key","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"api_key_id","required":true}],"description":"For integrations that fetch incidents or indicators in predefined intervals, fetch the execution history for the specified integration instance.\n\n**Note:** The `lastRun` field in each history entry is a serialized JSON string representing internal integration state. This field has a size limitation and may be truncated for integrations with large state objects. When truncated, the value may not be valid JSON. Do not rely on parsing `lastRun` for production monitoring workflows.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"brand":{"type":"string","description":"Integration name"},"instance":{"type":"string","description":"Instance name"}}}}}}}}}}
```

## Create an instance of an integration

> Create a new instance of an integration.

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Integrations","description":"APIs for managing indicators"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/settings/integration":{"put":{"summary":"Create an instance of an integration","tags":["Integrations"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"assetsFetchInterval":{"type":"integer"},"brand":{"type":"string"},"cacheVersn":{"type":"integer"},"canSample":{"type":"boolean"},"category":{"type":"string"},"cmdline":{"type":"string"},"commandsPermissions":{"type":"null"},"configtypes":{"type":"null"},"configuration":{"type":"object","properties":{"brand":{"type":"string"},"cacheVersn":{"type":"integer"},"canGetSamples":{"type":"boolean"},"category":{"type":"string"},"commitMessage":{"type":"string"},"configuration":{"type":"null"},"definitionId":{"type":"string"},"description":{"type":"string"},"detailedDescription":{"type":"string"},"display":{"type":"string"},"fromServerVersion":{"type":"string"},"hidden":{"type":"boolean"},"icon":{"type":"string"},"id":{"type":"string"},"integrationScript":{"type":"object","properties":{"commands":{"type":"array","items":{"type":"object","properties":{}}},"dockerImage":{"type":"string"},"feed":{"type":"boolean"},"isFetch":{"type":"boolean"},"isFetchAssets":{"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"},"subtype":{"type":"string"},"type":{"type":"string"}}},"itemVersion":{"type":"string"},"modified":{"type":"string"},"name":{"type":"string"},"packID":{"type":"string"},"packName":{"type":"string"},"prevName":{"type":"string"},"primaryTerm":{"type":"integer"},"propagationLabels":{"type":"array","items":{"type":"object","properties":{}}},"sequenceNumber":{"type":"integer"},"shouldCommit":{"type":"boolean"},"sizeInBytes":{"type":"integer"},"toServerVersion":{"type":"string"},"vcShouldIgnore":{"type":"boolean"},"vcShouldKeepItemLegacyProdMachine":{"type":"boolean"},"version":{"type":"integer"}}},"configvalues":{"type":"object","properties":{}},"data":{"type":"null"},"debugMode":{"type":"boolean"},"defaultIgnore":{"type":"boolean"},"definitionId":{"type":"string"},"displayPassword":{"type":"string"},"enabled":{"type":"string"},"engine":{"type":"string"},"engineGroup":{"type":"string"},"eventFetchInterval":{"type":"integer"},"executable":{"type":"string"},"fromServerVersion":{"type":"string"},"hidden":{"type":"boolean"},"hybrid":{"type":"boolean"},"id":{"type":"string"},"incidentFetchInterval":{"type":"integer"},"incomingMapperId":{"type":"string"},"integrationLogLevel":{"type":"string"},"isBuiltin":{"type":"boolean"},"isFetchSamples":{"type":"boolean"},"isIntegrationScript":{"type":"boolean"},"isSystemIntegration":{"type":"boolean"},"islongRunning":{"type":"boolean"},"itemVersion":{"type":"string"},"longRunningId":{"type":"string"},"mappable":{"type":"boolean"},"mappingId":{"type":"string"},"modified":{"type":"string"},"name":{"type":"string"},"outgoingMapperId":{"type":"string"},"packID":{"type":"string"},"packName":{"type":"string"},"passwordProtected":{"type":"boolean"},"path":{"type":"string"},"prevName":{"type":"string"},"primaryTerm":{"type":"integer"},"propagationLabels":{"type":"array","items":{"type":"string"}},"remoteSync":{"type":"boolean"},"remoteSyncableIn":{"type":"boolean"},"remoteSyncableOut":{"type":"boolean"},"sequenceNumber":{"type":"integer"},"servicesID":{"type":"string"},"sizeInBytes":{"type":"integer"},"toServerVersion":{"type":"string"},"version":{"type":"integer"}}}}}}},"operationId":"put-xsoar-public-v1-settings-integration","parameters":[{"schema":{"type":"string"},"in":"header","name":"authorization","description":"api_key","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"api_key_id","required":true}],"description":"Create a new instance of an integration.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Instance name"},"id":{"type":"string"},"engine":{"type":"string"},"engineGroup":{"type":"string"},"defaultIgnore":{"type":"boolean"},"configuration":{"type":"object","properties":{"display":{"type":"string"},"canGetSamples":{"type":"boolean"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"sizeInBytes":{"type":"integer"},"brand":{"type":"string"},"modified":{"type":"string"},"shouldCommit":{"type":"boolean"},"hidden":{"type":"boolean"},"sequenceNumber":{"type":"integer"},"fromServerVersion":{"type":"string"},"propagationLabels":{"type":"array","items":{"type":"object"}},"name":{"type":"string"},"detailedDescription":{"type":"string"},"primaryTerm":{"type":"integer"},"definitionId":{"type":"string"},"vcShouldKeepItemLegacyProdMachine":{"type":"boolean"},"commitMessage":{"type":"string"},"vcShouldIgnore":{"type":"boolean"},"packID":{"type":"string"},"configuration":{"nullable":true},"version":{"type":"integer"},"icon":{"type":"string"},"toServerVersion":{"type":"string"},"id":{"type":"string"},"cacheVersn":{"type":"integer"},"description":{"type":"string"},"category":{"type":"string"},"prevName":{"type":"string"},"integrationScript":{"type":"object","properties":{"resetContext":{"type":"boolean"},"isRemoteSyncOut":{"type":"boolean"},"longRunning":{"type":"boolean"},"commands":{"type":"array","items":{"type":"object"}},"isFetchEvents":{"type":"boolean"},"longRunningPortMapping":{"type":"boolean"},"script":{"type":"string"},"isFetchCredentials":{"type":"boolean"},"runOnce":{"type":"boolean"},"isRemoteSyncIn":{"type":"boolean"},"isFetch":{"type":"boolean"},"isFetchAssets":{"type":"boolean"},"isMappable":{"type":"boolean"},"isFetchSamples":{"type":"boolean"},"subtype":{"type":"string"},"type":{"type":"string"},"dockerImage":{"type":"string"},"feed":{"type":"boolean"}}},"instances":{"type":"array","items":{"type":"object"}}}},"enabled":{"type":"string"},"propagationLabels":{"type":"array","items":{"type":"string"}},"data":{"type":"array","items":{"type":"object","properties":{"defaultValue":{"type":"string"},"display":{"type":"string"},"displayPassword":{"type":"string"},"hasvalue":{"type":"boolean"},"hidden":{"type":"boolean"},"hiddenPassword":{"type":"boolean"},"hiddenUsername":{"type":"boolean"},"info":{"type":"string"},"name":{"type":"string"},"options":{"type":"string","nullable":true},"required":{"type":"integer"},"type":{"type":"string"},"value":{"type":"string"}}}},"brand":{"type":"string"},"canSample":{"type":"boolean"},"category":{"type":"string"},"version":{"type":"integer"},"isIntegrationScript":{"type":"boolean"},"isLongRunning":{"type":"boolean"},"passwordProtected":{"type":"boolean"},"mappingId":{"type":"string"},"incomingMapperId":{"type":"string"},"outgoingMapperId":{"type":"string"},"resetContext":{"type":"boolean"},"integrationLogLevel":{"type":"string"}}}}}}}}}}
```

## Reset integration instance last run timestamp

> Reset the last run timestamp on the specified integration instance.

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Integrations","description":"APIs for managing indicators"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/settings/integration/reset/{instance_id}":{"post":{"summary":"Reset integration instance last run timestamp","tags":["Integrations"],"responses":{"200":{"description":"OK"}},"operationId":"post-xsoar-public-v1-settings-integration-reset-instance_id","parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true}],"description":"Reset the last run timestamp on the specified integration instance.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}}}}
```

## Delete credentials

> Delete the integration instance credentials specified by ID.\
> \
> For more information on integration instance credentials, see \[Manage credentials]\(<https://cortex-docs.paloaltonetworks.com/cortex-xsoar-8-on-prem/8.14/configure-cortex-xsoar/integrations/manage-credentials>).

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Integrations","description":"APIs for managing indicators"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/settings/credentials/delete":{"post":{"summary":"Delete credentials","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"operationId":"post-xsoar-public-v1-settings-credentials-delete","parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true}],"description":"Delete the integration instance credentials specified by ID.\n\nFor more information on integration instance credentials, see [Manage credentials](https://cortex-docs.paloaltonetworks.com/cortex-xsoar-8-on-prem/8.14/configure-cortex-xsoar/integrations/manage-credentials).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}},"tags":["Integrations"]}}}}
```

## Get all credentials

> Get all integration instance credentials and their details.\
> \
> For more information on integration instance credentials, see \[Manage credentials]\(<https://cortex-docs.paloaltonetworks.com/cortex-xsoar-8-on-prem/8.14/configure-cortex-xsoar/integrations/manage-credentials>).

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Integrations","description":"APIs for managing indicators"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/settings/credentials":{"post":{"summary":"Get all credentials","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"credentials":{"type":"array","items":{"type":"object","properties":{"cacheVersn":{"type":"integer"},"hasCertificate":{"type":"boolean"},"hasCertificatePass":{"type":"boolean"},"hasPassword":{"type":"boolean"},"id":{"type":"string"},"locked":{"type":"boolean"},"modified":{"type":"string"},"name":{"type":"string"},"primaryTerm":{"type":"integer"},"sequenceNumber":{"type":"integer"},"sizeInBytes":{"type":"integer"},"user":{"type":"string"},"vaultInstanceId":{"type":"string"},"version":{"type":"integer"},"workgroup":{"type":"string"}}}},"total":{"type":"integer","description":"Total number of credentials returned."}}}}}}},"operationId":"post-xsoar-public-v1-settings-credentials","parameters":[{"schema":{"type":"string"},"in":"header","name":"Authorization","description":"{api_key}","required":true},{"schema":{"type":"string"},"in":"header","name":"x-xdr-auth-id","description":"{api_key_id}","required":true}],"description":"Get all integration instance credentials and their details.\n\nFor more information on integration instance credentials, see [Manage credentials](https://cortex-docs.paloaltonetworks.com/cortex-xsoar-8-on-prem/8.14/configure-cortex-xsoar/integrations/manage-credentials).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer"},"size":{"type":"integer"},"query":{"type":"string"}}}}}},"tags":["Integrations"]}}}}
```

## Create or update credentials

> Create integration instance credentials or update existing credentials.\
> \
> For more information on integration instance credentials, see \[Manage credentials]\(<https://cortex-docs.paloaltonetworks.com/cortex-xsoar-8-on-prem/8.14/configure-cortex-xsoar/integrations/manage-credentials>).

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Integrations","description":"APIs for managing indicators"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/settings/credentials":{"put":{"summary":"Create or update credentials","description":"Create integration instance credentials or update existing credentials.\n\nFor more information on integration instance credentials, see [Manage credentials](https://cortex-docs.paloaltonetworks.com/cortex-xsoar-8-on-prem/8.14/configure-cortex-xsoar/integrations/manage-credentials).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"cacheVersn":{"type":"integer"},"hasCertificate":{"type":"boolean"},"hasCertificatePass":{"type":"boolean"},"hasPassword":{"type":"boolean"},"id":{"type":"string"},"locked":{"type":"boolean"},"modified":{"type":"string"},"name":{"type":"string"},"primaryTerm":{"type":"integer"},"sequenceNumber":{"type":"integer"},"sizeInBytes":{"type":"integer"},"user":{"type":"string"},"vaultInstanceId":{"type":"string"},"version":{"type":"integer"},"workgroup":{"type":"string"}}}}}}},"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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.