System Management

APIs for system management

Check if Cortex XSOAR server is available

get

Check if Cortex XSOAR server is available

Authorizations

AuthorizationstringRequired

Responses

200

OK status

application/json

stringOptional

get/health

GET /health HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*

200

OK status

text

Get health containers

get

Gets info on the containers - amount of running, inactive and total containers

Authorizations

AuthorizationstringRequired

Responses

200

Gets info on the containers - amount of running, inactive and total containers

application/json

Info - holds all containers info

allinteger · int64Optional

inactiveinteger · int64Optional

runninginteger · int64Optional

get/health/containers

GET /health/containers HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*

200

Gets info on the containers - amount of running, inactive and total containers

{
  "all": 1,
  "inactive": 1,
  "running": 1
}

Get Docker Images

get

Get list of all available docker image names

Authorizations

AuthorizationstringRequired

Responses

200

DockerImagesResult

application/json

DockerImagesResult for the get images request

get/settings/docker-images

GET /settings/docker-images HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*

200

DockerImagesResult

{
  "images": [
    {
      "createdAt": "text",
      "createdSince": "text",
      "id": "text",
      "repository": "text",
      "size": "text",
      "tag": "text"
    }
  ]
}

Create Image

post

Create an image with a given list of dependencies

Authorizations

AuthorizationstringRequired

Body

NewDockerImage creation request

basestringOptional

dependenciesstring[]Optional

namestringOptional

packagesstring[]Optional

Responses

200

NewDockerImageResult

application/json

NewDockerImageResult of the command

createdNamestringOptional

outputstringOptional

post/settings/docker-images

POST /settings/docker-images HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "base": "text",
  "dependencies": [
    "text"
  ],
  "name": "text",
  "packages": [
    "text"
  ]
}

200

NewDockerImageResult

{
  "createdName": "text",
  "output": "text"
}

Get workers status

get

Get workers status

Authorizations

AuthorizationstringRequired

Responses

200

Workers status

application/json

Info - holds all workers status

Availablenumber · doubleOptional

BufferSpaceinteger · int64Optional

Busyinteger · int64Optional

HighPriorityAvailablenumber · doubleOptional

HighPriorityBufferSpaceinteger · int64Optional

NamestringOptional

ShouldStopbooleanOptional

Totalinteger · int64Optional

TotalBufferinteger · int64Optional

get/workers/status

GET /workers/status HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*

200

Workers status

{
  "Available": 1,
  "BufferSpace": 1,
  "Busy": 1,
  "HighPriorityAvailable": 1,
  "HighPriorityBufferSpace": 1,
  "Name": "text",
  "ProcessInfo": [
    {
      "Details": "text",
      "Duration": 1,
      "HighPriority": true,
      "StartedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "ShouldStop": true,
  "Total": 1,
  "TotalBuffer": 1
}