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

# Investigations

APIs for managing playground investigations

## Search investigations by filter

> This will search investigations across all indices\
> You can filter by multiple options

```json
{"openapi":"3.0.1","info":{"title":"Cortex XSOAR 6 API","version":"6"},"tags":[{"name":"Investigations","description":"APIs for managing playground investigations"}],"servers":[{"url":"https://hostname"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"SearchInvestigationsData":{"type":"object","title":"SearchInvestigationsData ...","properties":{"filter":{"$ref":"#/components/schemas/InvestigationFilter"}}},"InvestigationFilter":{"type":"object","title":"InvestigationFilter allows for very simple filtering.","properties":{"Cache":{"type":"object","description":"Cache of join functions","additionalProperties":{"type":"array","items":{"type":"string"}}},"andOp":{"type":"boolean"},"category":{"type":"array","items":{"type":"string"}},"fromCloseDate":{"type":"string","format":"date-time"},"fromDate":{"type":"string","format":"date-time"},"fromDateLicense":{"type":"string","format":"date-time"},"id":{"type":"array","items":{"type":"string"}},"idsOnly":{"type":"boolean"},"ignoreWorkers":{"type":"boolean","description":"Do not use workers mechanism while searching bleve"},"includeChildInv":{"type":"boolean"},"name":{"type":"array","items":{"type":"string"}},"notCategory":{"type":"array","items":{"type":"string"}},"notIDs":{"type":"array","items":{"type":"string"}},"page":{"type":"integer","description":"0-based page","format":"int64"},"period":{"$ref":"#/components/schemas/Period"},"reason":{"type":"array","items":{"type":"string"}},"searchAfter":{"type":"array","description":"Efficient next page, pass max sort value from previous page","items":{"type":"string"}},"searchAfterElastic":{"type":"array","description":"Efficient next page, pass max ES sort value from previous page","items":{"type":"string"}},"searchAfterMap":{"type":"object","description":"Map accounts search after values - stores next page sort values per account.\nThere is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter]\nMore, there is no way to generate correct searchBefore from current page as some tenants may not appear at all.\nThe map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map.","additionalProperties":{"type":"array","items":{"type":"string"}}},"searchAfterMapOrder":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"searchBefore":{"type":"array","description":"Efficient prev page, pass min sort value from next page","items":{"type":"string"}},"searchBeforeElastic":{"type":"array","description":"Efficient prev page, pass min ES sort value from next page","items":{"type":"string"}},"size":{"type":"integer","description":"Size is limited to 1000, if not passed it defaults to 0, and no results will return","format":"int64"},"sort":{"type":"array","description":"The sort order","items":{"$ref":"#/components/schemas/Order"}},"status":{"type":"array","items":{"$ref":"#/components/schemas/InvestigationStatus"}},"timeFrame":{"$ref":"#/components/schemas/Duration"},"toCloseDate":{"type":"string","format":"date-time"},"toDate":{"type":"string","format":"date-time"},"type":{"type":"array","items":{"$ref":"#/components/schemas/InvestigationType"}},"user":{"type":"array","items":{"type":"string"}}}},"Period":{"type":"object","title":"Period holds the 'Period' query, such as last 3 days, last 6 hours, between 6 days from now until 3 days from now.","properties":{"by":{"type":"string","description":"By is used for legacty, and if exists it will override ByTo and ByFrom"},"byFrom":{"type":"string"},"byTo":{"type":"string"},"field":{"type":"string"},"fromValue":{"type":"string","format":"duration"},"toValue":{"type":"string","format":"duration"}}},"Order":{"type":"object","description":"Order struct holds a sort field and the direction of sorting","properties":{"asc":{"type":"boolean"},"field":{"type":"string"},"fieldType":{"type":"string"}}},"InvestigationStatus":{"type":"number","description":"InvestigationStatus is the status type","format":"double"},"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"},"InvestigationType":{"type":"number","title":"InvestigationType ...","format":"double"},"InvestigationSearchResponse":{"type":"object","description":"InvestigationSearchResponse returns the response from the investigation search","properties":{"data":{"type":"array","description":"in: body","items":{"$ref":"#/components/schemas/Investigation"}},"total":{"type":"integer","format":"int64"}}},"Investigation":{"type":"object","title":"Investigation contains the investigation of a particular incident.","description":"A special investigation called playground is created for each user-project combination and is a private space for the researcher to play in.","properties":{"ShardID":{"type":"integer","format":"int64"},"allRead":{"type":"boolean"},"allReadWrite":{"type":"boolean"},"cacheVersn":{"type":"integer","format":"int64"},"category":{"type":"string","description":"Category of the investigation"},"childInvestigations":{"type":"array","description":"ChildInvestigations id's","items":{"type":"string"}},"closed":{"type":"string","description":"When was this closed","format":"date-time"},"closingUserId":{"type":"string","description":"The user ID that closed this investigation"},"created":{"type":"string","format":"date-time"},"creatingUserId":{"type":"string","description":"The user ID that created this investigation"},"dbotCreatedBy":{"type":"string","description":"Who has created this event - relevant only for manual incidents"},"details":{"type":"string","description":"User defined free text details"},"entitlements":{"type":"array","description":"One time entitlements","items":{"type":"string"}},"entryUsers":{"type":"array","description":"EntryUsers","items":{"type":"string"}},"hasRole":{"type":"boolean","description":"Internal field to make queries on role faster"},"highPriority":{"type":"boolean","description":"HighPriority - tasks of this investigation should run in high priority"},"highlight":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"id":{"type":"string"},"indexName":{"type":"string"},"isChildInvestigation":{"type":"boolean","description":"IsChildInvestigation"},"isDebug":{"type":"boolean","description":"IsDebug ..."},"lastOpen":{"type":"string","format":"date-time"},"mirrorAutoClose":{"type":"object","description":"MirrorAutoClose will tell us to close the Chat Module channel if we close investigation","additionalProperties":{"type":"boolean"}},"mirrorTypes":{"type":"object","description":"MirrorTypes holds info about mirror direction and message type to be mirrored\nmessage type can be either 'all' or 'chat'\ndirection can be either 'FromDemisto', 'ToDemisto' or 'Both' if this investigation is mirrored","additionalProperties":{"type":"string"}},"modified":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The name of the investigation, which is unique to the project"},"numericId":{"type":"integer","format":"int64"},"openDuration":{"type":"integer","description":"Duration from open to close time","format":"int64"},"parentInvestigation":{"type":"string","description":"ParentInvestigation - parent id, in case this is a child investigation of another investigation"},"persistentEntitlements":{"type":"object","description":"Persistent entitlement per tag. Empty tag will also return an entitlement","additionalProperties":{"type":"string"}},"previousAllRead":{"type":"boolean"},"previousAllReadWrite":{"type":"boolean"},"previousRoles":{"type":"array","description":"Do not change this field manually","items":{"type":"string"}},"primaryTerm":{"type":"integer","format":"int64"},"rawCategory":{"type":"string"},"reason":{"type":"object","description":"The reason for the status (resolve)","additionalProperties":{"type":"string"}},"roles":{"type":"array","description":"The role assigned to this investigation","items":{"type":"string"}},"runStatus":{"$ref":"#/components/schemas/RunStatus"},"sequenceNumber":{"type":"integer","format":"int64"},"sizeInBytes":{"type":"integer","format":"int64"},"slackMirrorAutoClose":{"type":"boolean","description":"DEPRECATED - DeprecatedSlackMirrorAutoClose will tell us to close the Slack channel if we close investigation"},"slackMirrorType":{"type":"string","description":"DEPRECATED - DeprecatedSlackMirrorType holds info about mirror direction and message type to be mirror\nmessage type can be either 'all' or 'chat'\ndirection can be either 'demisto2Slack', 'slack2Demisto' or 'both' if this investigation is mirrored to Slack"},"sortValues":{"type":"array","items":{"type":"string"}},"status":{"$ref":"#/components/schemas/InvestigationStatus"},"syncHash":{"type":"string"},"systems":{"type":"array","description":"The systems involved","items":{"$ref":"#/components/schemas/System"}},"tags":{"type":"array","description":"Tags","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/InvestigationType"},"users":{"type":"array","description":"The users who share this investigation","items":{"type":"string"}},"version":{"type":"integer","format":"int64"},"xsoarHasReadOnlyRole":{"type":"boolean"},"xsoarPreviousReadOnlyRoles":{"type":"array","items":{"type":"string"}},"xsoarReadOnlyRoles":{"type":"array","items":{"type":"string"}}}},"RunStatus":{"type":"string","description":"RunStatus of a job"},"System":{"type":"object","description":"System - URL stands for ip or hostname","properties":{"agent":{"$ref":"#/components/schemas/SystemAgent"},"arch":{"type":"string"},"ciphers":{"type":"array","items":{"type":"string"}},"credentials":{"type":"string"},"engineId":{"type":"string"},"host":{"type":"string"},"integrationinstanceid":{"type":"string"},"issharedagent":{"type":"boolean"},"name":{"type":"string"},"os":{"type":"string"},"password":{"type":"string"},"servicesID":{"type":"string"},"smb":{"type":"integer","format":"int64"},"smbport":{"type":"integer","format":"uint16"},"sshkey":{"type":"string"},"sshport":{"type":"integer","format":"uint16"},"terminalOptions":{"$ref":"#/components/schemas/TerminalOptions"},"user":{"type":"string"},"workgroup":{"type":"string"}}},"SystemAgent":{"type":"object","description":"SystemAgent - represents agent status and holds server context","properties":{"servercontext":{"type":"array","items":{"type":"integer","format":"uint8"}}}},"TerminalOptions":{"type":"object","description":"TerminalOptions - terminal options to use in case of using pty","properties":{"Echo":{"type":"integer","format":"uint32"},"Terminal":{"type":"boolean"},"TerminalHeight":{"type":"integer","format":"int64"},"TerminalType":{"type":"string"},"TerminalWidth":{"type":"integer","format":"int64"},"TyISpeed":{"type":"integer","format":"uint32"},"TyOSpeed":{"type":"integer","format":"uint32"}}}}},"paths":{"/investigations/search":{"post":{"summary":"Search investigations by filter","description":"This will search investigations across all indices\nYou can filter by multiple options","operationId":"searchInvestigations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchInvestigationsData"}},"application/xml":{"schema":{"$ref":"#/components/schemas/SearchInvestigationsData"}}}},"responses":{"200":{"description":"investigationSearchResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvestigationSearchResponse"}}}}},"tags":["Investigations"]}}}}
```


---

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