Ctrlk
BlogSupport
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Engines

APIs for managing engines

Create an engine

post

An engine is a proxy server application that is installed on a remote machine and enables communication between the remote machine and the Cortex XSOAR tenant. You can run playbooks, scripts, commands, and integrations on the remote machine and the results are returned to the tenant.

For more information on Cortex XSOAR engines, see What is an engine?.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
namestringRequired

Unique name for the engine.

pkgTypeundefined · enumRequired

Select the installer type:

  • shell: For all Linux deployments, including Ubuntu and SUSE. Automatically installs Docker/Podman, downloads Docker/Podman images, enables remote engine upgrade, and allows installation of multiple engines on the same machine.
  • zip: For Amazon Linux 2 machines.
  • deb: For Ubuntu operating systems.
  • rpm: For RHEL operating systems.
  • conf: A configuration file for download. When you install one of the other options, this configuration file (d1.conf) is installed on the engine machine.

Note: Use deb and rpm installation when shell installation is not available. You need to manually install Docker or Podman and any dependencies, including enabling IPv4 forwarding. You must also install Python (including 3.x).

Possible values:
serviceNamestringOptional

If you are using a shell installer type and want to enable multiple engines to run on the same machine, enter the service name for the engine. The service name will have d1_ added as a prefix. For example, "d1_test-engine".

Responses
200

OK

application/json
idstringOptional

Engine ID

versionintegerOptional

Engine version

cacheVersnintegerOptional
sequenceNumberintegerOptional
primaryTermintegerOptional
modifiedstringOptional
sizeInBytesintegerOptional
packIDstringOptional
packNamestringOptional
itemVersionstringOptional
fromServerVersionstringOptional
toServerVersionstringOptional
propagationLabelsany · nullableOptional
definitionIdstringOptional
prevNamestringOptional
isOverridablebooleanOptional
namestringOptional
allowOnTenantbooleanOptional
lockedbooleanOptional
lastSeenstringOptional
firstSeenstringOptional
lastConnectedAppstringOptional
lastDisconnectstringOptional
serviceNamestringOptional
hoststringOptional
userstringOptional
pkgTypestringOptional
pkgNamestringOptional
configstringOptional
baseUrlstringOptional
engineGroupstringOptional
protocolVersionstringOptional
osstringOptional
demistoVersionstringOptional
upgradeAvailablebooleanOptional
buildVersionstringOptional
md5stringOptional
underUpgradebooleanOptional
upgradeStartTimestringOptional
tenantNamesany · nullableOptional
workersintegerOptional
isDefaultbooleanOptional
isLegacybooleanOptional
packageFileHashstringOptional
pyramidAPIEncryptedAuthenticationHeaderstringOptional
pyramidAPIEncryptedAuthenticationHeaderTenantsany · nullableOptional
post/xsoar/public/v1/engines
POST /xsoar/public/v1/engines HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "name": "test-engine",
  "pkgType": "shell",
  "serviceName": "test-engine"
}
{
  "id": "0e8c1a1b-8e16-41e3-8533-f78f78a3adea",
  "version": -1,
  "cacheVersn": 0,
  "sequenceNumber": 2042067,
  "primaryTerm": 1,
  "modified": "2025-01-06T16:24:55.586630341Z",
  "sizeInBytes": 1493,
  "packID": "",
  "packName": "",
  "itemVersion": "",
  "fromServerVersion": "",
  "toServerVersion": "",
  "propagationLabels": null,
  "definitionId": "",
  "prevName": "",
  "isOverridable": false,
  "name": "test-engine",
  "allowOnTenant": false,
  "locked": false,
  "lastSeen": "0001-01-01T00:00:00Z",
  "firstSeen": "0001-01-01T00:00:00Z",
  "lastConnectedApp": "",
  "lastDisconnect": "0001-01-01T00:00:00Z",
  "serviceName": "d1_test-engine",
  "host": "",
  "user": "APIKeyUser_47",
  "pkgType": "shell",
  "pkgName": "/var/lib/demisto/downloads/d1-test-engine-8.9-1851546.sh",
  "config": "",
  "baseUrl": "",
  "engineGroup": "",
  "protocolVersion": "",
  "os": "",
  "demistoVersion": "",
  "upgradeAvailable": false,
  "buildVersion": "5887a1b1fe3e0662c6a0b6d000c209407b7c0bde",
  "md5": "e5882e2c9b7fedf708d5ccdc0a997094",
  "underUpgrade": false,
  "upgradeStartTime": "0001-01-01T00:00:00Z",
  "tenantNames": null,
  "workers": 0,
  "isDefault": false,
  "isLegacy": false,
  "packageFileHash": "df2c8b968c52cd7820d1dfc5658d3934eaf8bc1f64980d74f919f2f6cdb5f4bc",
  "pyramidAPIEncryptedAuthenticationHeader": "{TOMMED}iRdHwJmIjsnePNE2nwj++hDptvtB0hozvRtziFRLwWfQMA468DW2oMOAiLUMhiBw+O24ps9dW3XTi2jAxMWdBje9T4DpYUlzYQvzgDRSVx37ganFExe7fMr8dxWIvJ2SKSxUGLvbsxxAzvbq8+57a68s0Qsl9jIK8MEPNcwFeHhuOhEbWOxZs0B9ou/r2H9utvzwUoojM1sajhnGGLNOq7IelgVYNWiTWyl+cy9IrjWksoZG6MYBQ5MFuak4YOxSLqSPxFwE1JDqY+bHGSPfBZOOLQQ1Vr+6bGizfXPbsEU=",
  "pyramidAPIEncryptedAuthenticationHeaderTenants": null
}

Get all engines

get

Get detailed information on all of the tenant's engines, including engine names, hosts, status, and connection.

Note: If the name returns with a "d1_" prefix, this indicates that it is a multiple engine (more than one engine running on the same machine).

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Responses
200

OK

application/json
totalintegerOptional
pkgTypesstring[]Optional
requestedLogsobjectOptional
engineGroupsobject[]Optional
get/xsoar/public/v1/engines/get
GET /xsoar/public/v1/engines/get HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Accept: */*
200

OK

{
  "engines": [
    {
      "id": "3f4d65e0-3bd6-4348-82b2-17e32f8c90d7",
      "version": 4,
      "cacheVersn": 0,
      "sequenceNumber": 824009,
      "primaryTerm": 1,
      "modified": "2024-12-24T09:34:52.954219442Z",
      "sizeInBytes": 1503,
      "sortValues": [
        "1351"
      ],
      "packID": "",
      "packName": "",
      "itemVersion": "",
      "fromServerVersion": "",
      "toServerVersion": "",
      "definitionId": "",
      "prevName": "",
      "isOverridable": false,
      "name": "test-engine7",
      "allowOnTenant": false,
      "locked": false,
      "lastSeen": "0001-01-01T00:00:00Z",
      "firstSeen": "0001-01-01T00:00:00Z",
      "lastConnectedApp": "",
      "lastDisconnect": "0001-01-01T00:00:00Z",
      "serviceName": "",
      "host": "",
      "user": "APIKeyUser_1",
      "pkgType": "shell",
      "pkgName": "/var/lib/demisto/downloads/d1-test-engine7-8.9-1851546.sh",
      "config": "",
      "baseUrl": "",
      "engineGroup": "",
      "protocolVersion": "",
      "os": "",
      "demistoVersion": "",
      "upgradeAvailable": false,
      "buildVersion": "5887a1b1fe3e0662c6a0b6d000c209407b7c0bde",
      "md5": "d09ec137a472510c73cbc10863533495",
      "underUpgrade": false,
      "upgradeStartTime": "0001-01-01T00:00:00Z",
      "tenantNames": null,
      "workers": 0,
      "isDefault": false,
      "isLegacy": false,
      "packageFileHash": "c72bf93cac3a2cdc5119574b35e916e69bdaa8ea8107dd5b8ea1bf4156ab480d",
      "pyramidAPIEncryptedAuthenticationHeader": "{TOMMED}2geXpQuRFYiMvha+37b1WlozW6DyQPa1zi1sPZSnq2bIwGnby6+KOpE3EvPC0isznM/xVYfJSt+Hx2V/kG+kX3zQYhehXsD9H+whK67T0R5Ciaq1zggpJ7Z14mKb3C9a9qxj8jc35a7XaAHALjU925s9A7dcU9Vc/Wi0UipkinM2VSkw/IoOJdj6JDM5fP1FzLwsevaa+c1btdkP/jRbDt5TkoGGuYGmDjCjuoQEzyZRFpxM02j/rWNyLODzJ+2acL3kgFb6OL/ygLpMVINEAsyaRup5/L+2Hy9x6YZ27w4=",
      "pyramidAPIEncryptedAuthenticationHeaderTenants": null,
      "connected": false,
      "modules": null
    },
    {
      "id": "99b398ef-4c41-4330-922b-bc0d7dde6026",
      "version": 1,
      "cacheVersn": 0,
      "sequenceNumber": 1459284,
      "primaryTerm": 1,
      "modified": "2024-12-31T07:53:26.695745201Z",
      "sizeInBytes": 1467,
      "sortValues": [
        "1843"
      ],
      "packID": "",
      "packName": "",
      "itemVersion": "",
      "fromServerVersion": "",
      "toServerVersion": "",
      "propagationLabels": [
        "child1",
        "child2"
      ],
      "definitionId": "",
      "prevName": "",
      "isOverridable": false,
      "name": "test-engine200",
      "allowOnTenant": true,
      "locked": false,
      "lastSeen": "0001-01-01T00:00:00Z",
      "firstSeen": "0001-01-01T00:00:00Z",
      "lastConnectedApp": "",
      "lastDisconnect": "0001-01-01T00:00:00Z",
      "serviceName": "",
      "host": "",
      "user": "APIKeyUser_1",
      "pkgType": "zip",
      "pkgName": "/var/lib/demisto/downloads/d1_test-engine200.zip",
      "config": "",
      "baseUrl": "",
      "engineGroup": "",
      "protocolVersion": "",
      "os": "",
      "demistoVersion": "",
      "upgradeAvailable": false,
      "buildVersion": "5887a1b1fe3e0662c6a0b6d000c209407b7c0bde",
      "md5": "3bcd9faddc7dfb0b3d8c12df4fc9bfea",
      "underUpgrade": false,
      "upgradeStartTime": "0001-01-01T00:00:00Z",
      "tenantNames": null,
      "workers": 0,
      "isDefault": false,
      "isLegacy": false,
      "packageFileHash": "7e6f47fb3c4456b32edb9a5d2190a9402b04e58e5e6048601551f47ef5414dfe",
      "pyramidAPIEncryptedAuthenticationHeader": "{TOMMED}2JOPfhUjBOcbFN77NWbDmw282JaZgVHdGgrDEUi2EnIzOz+mDPY/9vFHOhludoEAZPj3lxUiTg4NujRkTrFW3d2xGjr3xTcTZmwTGNml0noVdpCJ2yhSgasUFFiTzQaeg7hFo7/XXCuTZGOjjHPT9ZK+di+AQEESDCEtgSOuLMyu9jV7ZnIXcPyFA9Y5ufGLFq2725JXH39lyZXfPyONTx49d3lqgEdbabror/lsTuAUnJI9gGJ21C7Y9v2JqgLQAq1zIUF6laG6hVVxoDKxM5tHAz8zkQ3ccFIVqHuYaHQ=",
      "pyramidAPIEncryptedAuthenticationHeaderTenants": null,
      "connected": false,
      "modules": null
    },
    {
      "id": "6d091ae3-7b30-436a-9e80-ed6f2eafe9b1",
      "version": 1,
      "cacheVersn": 0,
      "sequenceNumber": 2036375,
      "primaryTerm": 1,
      "modified": "2025-01-06T15:10:07.979410327Z",
      "sizeInBytes": 1495,
      "sortValues": [
        "5073"
      ],
      "packID": "",
      "packName": "",
      "itemVersion": "",
      "fromServerVersion": "",
      "toServerVersion": "",
      "propagationLabels": [
        "child1",
        "child2"
      ],
      "definitionId": "",
      "prevName": "",
      "isOverridable": false,
      "name": "test-engine301",
      "allowOnTenant": true,
      "locked": false,
      "lastSeen": "0001-01-01T00:00:00Z",
      "firstSeen": "0001-01-01T00:00:00Z",
      "lastConnectedApp": "",
      "lastDisconnect": "0001-01-01T00:00:00Z",
      "serviceName": "",
      "host": "",
      "user": "APIKeyUser_1",
      "pkgType": "rpm",
      "pkgName": "/var/lib/demisto/downloads/x86_64/d1_test-engine301-8.9_1851546-1.x86_64.rpm",
      "config": "",
      "baseUrl": "",
      "engineGroup": "",
      "protocolVersion": "",
      "os": "",
      "demistoVersion": "",
      "upgradeAvailable": false,
      "buildVersion": "5887a1b1fe3e0662c6a0b6d000c209407b7c0bde",
      "md5": "8b59e476d1a10a6b5a9ad9133b43a3f3",
      "underUpgrade": false,
      "upgradeStartTime": "0001-01-01T00:00:00Z",
      "tenantNames": null,
      "workers": 0,
      "isDefault": false,
      "isLegacy": false,
      "packageFileHash": "ee7cecf3acc1ac35cdf9f15feeffab0595dd925d47d0125e07278041d04ebdb6",
      "pyramidAPIEncryptedAuthenticationHeader": "{TOMMED}7FkkSjvFrbgSGRno2RZcWcl6pfj+8zv5BGIxp+h1zn3cnw8DoghtMQYK7LLigDXZ0YIVGIeBbGrZaTEwD3OzuClIm/vmnuhjFiObyJMUMt/eOGiRIL7ynHyjFHFjhY8a3hdH7N3OpdxpFwsAwDfHzathYpGoLtOrrthUkFMXF0qWiaumfbtL/AFZUpWwYk17+iY0b0N7U4Z7ASC0ntgHSgUUOvEIBvNQ1ZWw5pVP6Pl6gULiOhY/dqWlyJ4KNpnWuqq12uxJ1CtfG29ja24BF9Pz85wVdOwIByYTgB58ewc=",
      "pyramidAPIEncryptedAuthenticationHeaderTenants": null,
      "connected": false,
      "modules": null
    },
    {
      "id": "c289e8e9-c3d6-4374-96ad-f6ba3c624af0",
      "version": 1,
      "cacheVersn": 0,
      "sequenceNumber": 2036769,
      "primaryTerm": 1,
      "modified": "2025-01-06T15:16:32.08660575Z",
      "sizeInBytes": 1484,
      "sortValues": [
        "5074"
      ],
      "packID": "",
      "packName": "",
      "itemVersion": "",
      "fromServerVersion": "",
      "toServerVersion": "",
      "propagationLabels": [
        "child1",
        "child2"
      ],
      "definitionId": "",
      "prevName": "",
      "isOverridable": false,
      "name": "test-engine302",
      "allowOnTenant": true,
      "locked": false,
      "lastSeen": "0001-01-01T00:00:00Z",
      "firstSeen": "0001-01-01T00:00:00Z",
      "lastConnectedApp": "",
      "lastDisconnect": "0001-01-01T00:00:00Z",
      "serviceName": "",
      "host": "",
      "user": "APIKeyUser_1",
      "pkgType": "deb",
      "pkgName": "/var/lib/demisto/downloads/d1_test-engine302_8.9-1851546_amd64.deb",
      "config": "",
      "baseUrl": "",
      "engineGroup": "",
      "protocolVersion": "",
      "os": "",
      "demistoVersion": "",
      "upgradeAvailable": false,
      "buildVersion": "5887a1b1fe3e0662c6a0b6d000c209407b7c0bde",
      "md5": "45580cd1ee0325e7b38389e7ed0f9505",
      "underUpgrade": false,
      "upgradeStartTime": "0001-01-01T00:00:00Z",
      "tenantNames": null,
      "workers": 0,
      "isDefault": false,
      "isLegacy": false,
      "packageFileHash": "cc6c0085ed0210c9fae95f65b12f7c1afa63e219caf25bb0f61bb45935f17a4f",
      "pyramidAPIEncryptedAuthenticationHeader": "{TOMMED}E6fJMxT4+B+xE3o26o2YP7vQTeLRC250SHmZKLoD9jZq+FHclY+EaXQW0aiEYWsB+JLDEodLeQOOd1u2EpvitGwrxRyPjQu4NBnseA3UH7ZOS0SJ9Ez29zUvE96I1gE9k2weEctoCsW8387pnVbY8fxcBKgdEpE2rDEoxbh3hy753OO8xhTDL9BNv2PQ2XFwvus9e76/DBco17qsomQLmCT9VOJY0KdAPd1HtIfz3ksWetnZ9mZThMjWAV2uB3CvObx02KHQg8sEovHRrIGeIWB+Jv78lPT1GiphS6xBhIA=",
      "pyramidAPIEncryptedAuthenticationHeaderTenants": null,
      "connected": false,
      "modules": null
    },
    {
      "id": "10fde7e5-21fd-29ca-972e-1a3ea099c10f",
      "version": 1,
      "cacheVersn": 0,
      "sequenceNumber": 2039242,
      "primaryTerm": 1,
      "modified": "2025-01-06T15:39:45.991670461Z",
      "sizeInBytes": 1447,
      "sortValues": [
        "6128"
      ],
      "packID": "",
      "packName": "",
      "itemVersion": "",
      "fromServerVersion": "",
      "toServerVersion": "",
      "definitionId": "",
      "prevName": "",
      "isOverridable": false,
      "name": "test-engine305",
      "allowOnTenant": false,
      "locked": false,
      "lastSeen": "0001-01-01T00:00:00Z",
      "firstSeen": "0001-01-01T00:00:00Z",
      "lastConnectedApp": "",
      "lastDisconnect": "0001-01-01T00:00:00Z",
      "serviceName": "",
      "host": "",
      "user": "APIKeyUser_1",
      "pkgType": "conf",
      "pkgName": "/var/lib/demisto/downloads/test-engine305",
      "config": "",
      "baseUrl": "",
      "engineGroup": "",
      "protocolVersion": "",
      "os": "",
      "demistoVersion": "",
      "upgradeAvailable": false,
      "buildVersion": "5887a1b1fe3e0662c6a0b6d000c209407b7c0bde",
      "md5": "85192e6df4f14e67d0ce782bf0e224c9",
      "underUpgrade": false,
      "upgradeStartTime": "0001-01-01T00:00:00Z",
      "tenantNames": null,
      "workers": 0,
      "isDefault": false,
      "isLegacy": false,
      "packageFileHash": "9aad326baa22469149b332f8a83afe8da5fe36b3a29b827e30e3b596a6e14dbd",
      "pyramidAPIEncryptedAuthenticationHeader": "{TOMMED}NsN8Z1iNOzffU35YmPB8m8Xru2EK7cWeF0v5OY5rYdFSDXtdqL3nfad94h+ZwZ6FynyZDCWvSATa+e+qr3aaRl5RzCzBB/g8QWgALbpQky0RVvl3U9wrMC7gFJN/1dSbA1nG95Vvm3WA9lfstv5p7N2m8j6ANGVNlk5n/yASpSKogb6/SWDmZ9D4Z3B9lmxsgRLRXsKlwwDgWUG/FgybfzaCZ5x6C8pcMaLZZia8uvxpk54MsOA8Jxeim3TzGydB2cQMTZwzr2f5Gd87339il9r8gOqI3Iza0TliWryE7FU=",
      "pyramidAPIEncryptedAuthenticationHeaderTenants": null,
      "connected": false,
      "modules": null
    }
  ],
  "total": 5,
  "pkgTypes": [
    "shell",
    "zip",
    "deb",
    "rpm",
    "conf"
  ],
  "requestedLogs": {},
  "engineGroups": []
}

Get details by engine ID

get

Get detailed information on the specified engine, including engine name, host, status, and connection.

Note: If the name returns with a "d1_" prefix, this indicates that it is a multiple engine (more than one engine running on the same machine).

Path parameters
idstringRequired

Engine ID

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Responses
200

OK

application/json
totalintegerOptional
pkgTypesstring[]Optional
requestedLogsobjectOptional
engineGroupsobject[]Optional
get/xsoar/public/v1/engines/get/{id}
GET /xsoar/public/v1/engines/get/{id} HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Accept: */*
200

OK

{
  "engines": [
    {
      "id": "0e8c1a1b-8e16-41e3-8533-f78f78a3adea",
      "version": 1,
      "cacheVersn": 0,
      "sequenceNumber": 2042067,
      "primaryTerm": 1,
      "modified": "2025-01-06T16:24:55.586630341Z",
      "sizeInBytes": 1493,
      "packID": "",
      "packName": "",
      "itemVersion": "",
      "fromServerVersion": "",
      "toServerVersion": "",
      "definitionId": "",
      "prevName": "",
      "isOverridable": false,
      "name": "test-engine-sarah",
      "allowOnTenant": false,
      "locked": false,
      "lastSeen": "0001-01-01T00:00:00Z",
      "firstSeen": "0001-01-01T00:00:00Z",
      "lastConnectedApp": "",
      "lastDisconnect": "0001-01-01T00:00:00Z",
      "serviceName": "d1_test-engine-sarah",
      "host": "",
      "user": "APIKeyUser_47",
      "pkgType": "shell",
      "pkgName": "/var/lib/demisto/downloads/d1-test-engine-sarah-8.9-1851546.sh",
      "config": "",
      "baseUrl": "",
      "engineGroup": "",
      "protocolVersion": "",
      "os": "",
      "demistoVersion": "",
      "upgradeAvailable": false,
      "buildVersion": "5887a1b1fe3e0662c6a0b6d000c209407b7c0bde",
      "md5": "e5882e2c9b7fedf708d5ccdc0a997094",
      "underUpgrade": false,
      "upgradeStartTime": "0001-01-01T00:00:00Z",
      "tenantNames": null,
      "workers": 0,
      "isDefault": false,
      "isLegacy": false,
      "packageFileHash": "df2c8b968c53cd7820d1dfc5658d3934eaf8bf1f64980d74f919f2f6cab5f1bc",
      "pyramidAPIEncryptedAuthenticationHeader": "{TOMMED}iRdHwJmIjsmePNE2nwj++hDptvtB0hozvRtziFRLwWfQMA478DW2oMOAiLUMhiBw+O24ps9dW3VTi2jAxMWdBje9T4DpYUlzYQvzgDRSVx37ganFExe7fMr8dxWIvJ2SKSxUGLvbsxxAzvbq8+57a68s0Qsl9jIK8MEPNcwFeHhuOhEbWOxZs0B9ou/r2H9utvzwUoojM1sajhnGGLNOq7IelgVYNWiTWyl+cy9IrjWksoZG6MYBQ5MFuak4YOxSLqSPxFwE1JDqY+bHGSPfBZOOLQQ1Vr+6bGizfXPbsEU=",
      "pyramidAPIEncryptedAuthenticationHeaderTenants": null,
      "connected": false,
      "modules": null
    }
  ],
  "total": 1,
  "pkgTypes": [
    "shell",
    "zip",
    "deb",
    "rpm",
    "conf"
  ],
  "requestedLogs": {},
  "engineGroups": []
}

Download the engine configuration file

get

Download the d1.conf file to view the attribute values. This is only supported for engines installed with a configuration file ("pkgType":"conf").

Path parameters
idstringRequired

Engine ID

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Responses
200

OK

application/json
LogLevelstringOptional
LogFilestringOptional
EngineURLsstring[]Optional
AgentURLsnullOptional
BindAddressstringOptional
EngineIDstringOptional
ServerPublicstringOptional
ArtifactsFolderstringOptional
TempFolderstringOptional
Server.ExternalHostNamestringOptional
http.authentication.headerstringOptional
python.engine.dockerbooleanOptional
powershell.engine.dockerbooleanOptional
get/xsoar/public/v1/engines/download/{id}
GET /xsoar/public/v1/engines/download/{id} HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Accept: */*
200

OK

{
  "LogLevel": "info",
  "LogFile": "/var/log/demisto/d1.log",
  "EngineURLs": [
    "wss://api-xsoar.company.us.paloaltonetworks.com/xsoar/d1ws"
  ],
  "AgentURLs": null,
  "BindAddress": ":8443",
  "EngineID": "10fde7e5-21fe-49ca-972f-1c3ea399c10f",
  "ServerPublic": "MIIBIjANBgkqhdiG9w0BAQEFACOCAQ8AMIIBCgKCAQEAvUcSAmhhQQ4z5EDB67nHBMqhgTbykBusLIAZTJA8vbBtU+bz+v/m5iJLEfZTCu8YenYuJ8agF9F6alJW62ZIN6YvO6nOzDfCQkIQhwSf1xl9E4ZRxaeuqzB9DpT2vjX7dA7PH35Ut7GDYpGO5yQTjA3h5610ZCVZlfrTQYQO8vlhq6PVaVrnnSYGufMwd68d95ei2nAEEZM52SdPA566Q/9YrNgoe10ImRGkRYHvIU58qs393GKyNT9eLtk3ptihHwP58Wq2RFOZyF6dihbVXMrbeb6NZa98KlP28zK54Bx2TU+tM/2Ifm0+J8jkhhTuL/E0bVpDYs80QRneeCrARQIDAQAB",
  "ArtifactsFolder": "",
  "TempFolder": "",
  "Server.ExternalHostName": "xsoar.company.us.paloaltonetworks.com",
  "http.authentication.header": "{TOMMED}NsN8Z1iHOzffU35YmPB8m8Xru2EK7cWeF0v4OY5rYdFSDXtdqL3nfad94h+ZwZ6FynyZDCWvSATa+e+qr3abRl5RzCzBB/g8QWgALbpQky0RVvl3U9wrMC7gFJN/1dSbA1nG95Vvm3WA9lfstv5p7N2m8j6ANGVNlk5n/yASpSKogb6/SWDmZ9D4Z3B9lmxsgRLRXsKlwwDgWUG/FgybfzaCZ5x6C8pcMaLZZia8uvxpk54MsOA8Jxeim3TzGydB2cQMTZwzr2f5Gd87339il9r8gOqI3Iza0TliWryE7FU=",
  "python.engine.docker": true,
  "powershell.engine.docker": true
}

Delete an engine

delete

Delete the engine specified by engine ID.

Path parameters
idstringRequired

Engine ID

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Responses
200

OK

application/json
objectOptional
delete/xsoar/public/v1/engines/{id}
DELETE /xsoar/public/v1/engines/{id} HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Accept: */*

{}

Update engine configuration

post

Update an engine configuration.

See Configure Engines for a table that describes the common properties when editing an engine configuration.

Note: The engine must be connected to update its configuration.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
idstringOptional

Engine ID

Responses
200

OK

No content
post/xsoar/public/v1/engines/config
POST /xsoar/public/v1/engines/config HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 587

{
  "id": "4c732c16-3df3-4fcd-b5ff-be12ae4d2e5d",
  "data": {
    "LogLevel": "debug",
    "LogFile": "/var/log/demisto/d1.log",
    "EngineURLs": [
      "wss://api-company.us.paloaltonetworks.com/xsoar/d1ws"
    ],
    "AgentURLs": null,
    "BindAddress": ":8443",
    "EngineID": "4c732c16-3df3-4fcd-b5ff-be12ae4d2e5d",
    "ServerPublic": "MIIBIjANBgkqhkiG9w0GgfEPP1BbmQGKnkOK9Sfz2Z1YxBPdyBW17pjOYNAb47Ke7KjWTY9zc58pVYBXikvefrRUTAiTBdQIDAQAB",
    "ArtifactsFolder": "",
    "TempFolder": "",
    "Server.ExtealHostName": "ç",
    "http.authentication.header": "{TOMMED}Dh7MoZrkBajbbwBZvcUa2b/VYOIcA+o8Pc",
    "python.engine.docker": true,
    "powershell.engine.docker": true
  }
}
No content

Upgrade specified engines

post

Whenever there is a Cortex XSOAR major version change or a change in tenant-engine protocol version, your engines require an upgrade. In the UI on the Engines page, the Status column shows those engines that require upgrades.

Use this endpoint to upgrade engines specified by their engine ID.

Note: The engine must be connected to be upgraded. You can only upgrade engines if you have installed the engine using the Shell installer. If you didn't install the engine using the Shell installer, you need to remove the engine and do a fresh install.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
idsstring[]Optional

List of engine IDs you wish to upgrade.

Responses
post/xsoar/public/v1/engines/upgrade
POST /xsoar/public/v1/engines/upgrade HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "ids": [
    "0e8c1a1b-8e16-41e3-8533-f78f78a3adea"
  ]
}
PreviousDashboards
NextEntry

Last updated

Was this helpful?