> 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/system-management.md).

# System Management

APIs for system management

## Check if Cortex XSOAR server is available

> Check if Cortex XSOAR server is available

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 6 API","version":"6"},"tags":[{"name":"System Management","description":"APIs for system management"}],"servers":[{"url":"https://hostname"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header"}}},"paths":{"/health":{"get":{"summary":"Check if Cortex XSOAR server is available","description":"Check if Cortex XSOAR server is available","operationId":"healthHandler","responses":{"200":{"description":"OK status","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["System Management"]}}}}
```

## Get health containers

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

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 6 API","version":"6"},"tags":[{"name":"System Management","description":"APIs for system management"}],"servers":[{"url":"https://hostname"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"containersInfo":{"type":"object","description":"Info - holds all containers info","properties":{"all":{"type":"integer","format":"int64"},"inactive":{"type":"integer","format":"int64"},"running":{"type":"integer","format":"int64"}}}}},"paths":{"/health/containers":{"get":{"summary":"Get health containers","description":"Gets info on the containers - amount of running, inactive and total containers","operationId":"getContainers","responses":{"200":{"description":"Gets info on the containers - amount of running, inactive and total containers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/containersInfo"}}}}},"tags":["System Management"]}}}}
```

## Get Docker Images

> Get list of all available docker image names

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 6 API","version":"6"},"tags":[{"name":"System Management","description":"APIs for system management"}],"servers":[{"url":"https://hostname"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"DockerImagesResult":{"type":"object","description":"DockerImagesResult for the get images request","properties":{"images":{"type":"array","items":{"$ref":"#/components/schemas/DockerImage"}}}},"DockerImage":{"type":"object","description":"DockerImage details","properties":{"createdAt":{"type":"string"},"createdSince":{"type":"string"},"id":{"type":"string"},"repository":{"type":"string"},"size":{"type":"string"},"tag":{"type":"string"}}}}},"paths":{"/settings/docker-images":{"get":{"summary":"Get Docker Images","description":"Get list of all available docker image names","operationId":"getDockerImages","responses":{"200":{"description":"DockerImagesResult","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DockerImagesResult"}}}}},"tags":["System Management"]}}}}
```

## Create Image

> Create an image with a given list of dependencies

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 6 API","version":"6"},"tags":[{"name":"System Management","description":"APIs for system management"}],"servers":[{"url":"https://hostname"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"NewDockerImage":{"type":"object","description":"NewDockerImage creation request","properties":{"base":{"type":"string"},"dependencies":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"packages":{"type":"array","items":{"type":"string"}}}},"NewDockerImageResult":{"type":"object","description":"NewDockerImageResult of the command","properties":{"createdName":{"type":"string"},"output":{"type":"string"}}}}},"paths":{"/settings/docker-images":{"post":{"summary":"Create Image","description":"Create an image with a given list of dependencies","operationId":"createDockerImage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewDockerImage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/NewDockerImage"}}}},"responses":{"200":{"description":"NewDockerImageResult","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewDockerImageResult"}}}}},"tags":["System Management"]}}}}
```

## Get workers status

> Get workers status

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 6 API","version":"6"},"tags":[{"name":"System Management","description":"APIs for system management"}],"servers":[{"url":"https://hostname"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"Info":{"type":"object","description":"Info - holds all workers status","properties":{"Available":{"type":"number","format":"double"},"BufferSpace":{"type":"integer","format":"int64"},"Busy":{"type":"integer","format":"int64"},"HighPriorityAvailable":{"type":"number","format":"double"},"HighPriorityBufferSpace":{"type":"integer","format":"int64"},"Name":{"type":"string"},"ProcessInfo":{"type":"array","items":{"$ref":"#/components/schemas/ProcessInfo"}},"ShouldStop":{"type":"boolean"},"Total":{"type":"integer","format":"int64"},"TotalBuffer":{"type":"integer","format":"int64"}}},"ProcessInfo":{"type":"object","description":"ProcessInfo - holds info per worker","properties":{"Details":{"type":"string"},"Duration":{"$ref":"#/components/schemas/Duration"},"HighPriority":{"type":"boolean"},"StartedAt":{"type":"string","format":"date-time"}}},"Duration":{"type":"integer","description":"A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.","format":"int64"}}},"paths":{"/workers/status":{"get":{"summary":"Get workers status","description":"Get workers status","operationId":"workersStatusHandler","responses":{"200":{"description":"Workers status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Info"}}}}},"tags":["System Management"]}}}}
```


---

# 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-6-api/cortex-xsoar-6.x-apis/system-management.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.