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

# Lists

APIs for managing lists

## Get all lists

> Get all lists defined in the system.\
> \
> For more details on lists in XSOAR, see \[Lists]\(<https://cortex-docs.paloaltonetworks.com/xsoar-6-administrator-guide/6.10/learn-about-cortex-xsoar/lists>).

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Lists","description":"APIs for managing lists"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/lists":{"get":{"summary":"Get all lists","tags":["Lists"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"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"},"packID":{"type":"string"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"fromServerVersion":{"type":"string"},"toServerVersion":{"type":"string"},"propagationLabels":{"type":"array","items":{"type":"string"}},"definitionId":{"type":"string"},"vcShouldIgnore":{"type":"boolean"},"vcShouldKeepItemLegacyProdMachine":{"type":"boolean"},"commitMessage":{"type":"string"},"shouldCommit":{"type":"boolean"},"allRead":{"type":"boolean"},"allReadWrite":{"type":"boolean"},"previousAllRead":{"type":"boolean"},"previousAllReadWrite":{"type":"boolean"},"name":{"type":"string"},"prevName":{"type":"string"},"data":{"type":"string"},"locked":{"type":"boolean"},"nameLocked":{"type":"boolean"},"system":{"type":"boolean"},"truncated":{"type":"boolean"},"type":{"type":"string"},"tags":{"type":"null"},"description":{"type":"string"},"detached":{"type":"boolean"}}}}}}}},"operationId":"get-xsoar-public-v1-lists","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 lists defined in the system.\n\nFor more details on lists in XSOAR, see [Lists](https://cortex-docs.paloaltonetworks.com/xsoar-6-administrator-guide/6.10/learn-about-cortex-xsoar/lists)."}}}}
```

## Delete a list

> Delete the list specified by its ID.\
> \
> For more details on lists in XSOAR, see \[Lists]\(<https://cortex-docs.paloaltonetworks.com/xsoar-6-administrator-guide/6.10/learn-about-cortex-xsoar/lists>).

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Lists","description":"APIs for managing lists"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/lists/delete":{"post":{"summary":"Delete a list","tags":["Lists"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"operationId":"post-xsoar-public-v1-lists-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 list specified by its ID.\n\nFor more details on lists in XSOAR, see [Lists](https://cortex-docs.paloaltonetworks.com/xsoar-6-administrator-guide/6.10/learn-about-cortex-xsoar/lists).","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}}}}}}
```

## Create or update a list

> Create a new list or update an existing one. To update an existing list, send the request with the \`id\` of the existing list and the lastest \`version\`\
> \
> For more details on lists in XSOAR, see \[Lists]\(<https://cortex-docs.paloaltonetworks.com/xsoar-6-administrator-guide/6.10/learn-about-cortex-xsoar/lists>).

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Lists","description":"APIs for managing lists"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/lists/save":{"post":{"summary":"Create or update a list","tags":["Lists"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer"},"cacheVersn":{"type":"integer"},"sequenceNumber":{"type":"integer"},"primaryTerm":{"type":"integer"},"modified":{"type":"string"},"sizeInBytes":{"type":"integer"},"packID":{"type":"string"},"packName":{"type":"string"},"itemVersion":{"type":"string"},"fromServerVersion":{"type":"string"},"toServerVersion":{"type":"string"},"propagationLabels":{"type":"array","items":{"type":"string"}},"definitionId":{"type":"string"},"vcShouldIgnore":{"type":"boolean"},"vcShouldKeepItemLegacyProdMachine":{"type":"boolean"},"commitMessage":{"type":"string"},"shouldCommit":{"type":"boolean"},"allRead":{"type":"boolean"},"allReadWrite":{"type":"boolean"},"previousAllRead":{"type":"boolean"},"previousAllReadWrite":{"type":"boolean"},"name":{"type":"string"},"prevName":{"type":"string"},"data":{"type":"string"},"locked":{"type":"boolean"},"nameLocked":{"type":"boolean"},"system":{"type":"boolean"},"truncated":{"type":"boolean"},"type":{"type":"string"},"tags":{"type":"null"},"description":{"type":"string"},"detached":{"type":"boolean"}}}}}}},"operationId":"post-xsoar-public-v1-lists-save","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","properties":{"propagationLabels":{"type":"array","items":{"type":"string"}},"type":{"type":"string"},"allRead":{"type":"boolean"},"allReadWrite":{"type":"boolean"},"name":{"type":"string"},"orgList":{"type":"object","properties":{"propagationLabels":{"type":"array","items":{"type":"string"}},"type":{"type":"string"},"allRead":{"type":"boolean"},"allReadWrite":{"type":"boolean"}}},"data":{"type":"string"},"commitMessage":{"type":"string"},"shouldPublish":{"type":"boolean"},"shouldCommit":{"type":"boolean"}}}}}},"description":"Create a new list or update an existing one. To update an existing list, send the request with the `id` of the existing list and the lastest `version`\n\nFor more details on lists in XSOAR, see [Lists](https://cortex-docs.paloaltonetworks.com/xsoar-6-administrator-guide/6.10/learn-about-cortex-xsoar/lists)."}}}}
```

## Get the specified list

> Download the list specified by list ID.\
> \
> For more details on lists in XSOAR, see \[Lists]\(<https://cortex-docs.paloaltonetworks.com/xsoar-6-administrator-guide/6.10/learn-about-cortex-xsoar/lists>).

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 8 API","version":"XSOAR 8 Cloud"},"tags":[{"name":"Lists","description":"APIs for managing lists"}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/xsoar/public/v1/lists/download/{list_id}":{"get":{"summary":"Get the specified list","tags":["Lists"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"operationId":"get-xsoar-public-v1-lists-download-list_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":"Download the list specified by list ID.\n\nFor more details on lists in XSOAR, see [Lists](https://cortex-docs.paloaltonetworks.com/xsoar-6-administrator-guide/6.10/learn-about-cortex-xsoar/lists)."}}}}
```


---

# 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/lists.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.