How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Demisto Inv Playbook API

The Inv Playbook API from Demisto — 11 operation(s) for inv playbook.

Demisto Inv Playbook API is one of 24 APIs that Demisto publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Inv Playbook. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 11 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://hostname:443.

11 operations 11 paths 41 schemas 11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://xsoar.pan.dev
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Demisto Inv Playbook API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (api_key). An API key is passed in the header as X-XSRF-TOKEN (csrf_token). An API key is passed in the header as x-xdr-auth-id (x-xdr-auth-id). By default, every request must be authenticated.

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 11 POST. Each is listed below with its method, path, parameters, and response codes.

Inv Playbook 11
POST
/inv-playbook/task/add/{investigationId}
Add ad-hoc task
addAdHocTask 1 param body → 200
POST
/inv-playbook/task/assign
Assign task
taskAssign body → 200
POST
/inv-playbook/task/complete
[Deprecated] Complete a task
completeTask body → 200
POST
/inv-playbook/task/complete/simple
Complete task simple (no file)
simpleCompleteTask body → 200
POST
/inv-playbook/task/delete/{investigationId}/{invPBTaskId}
Delete ad-hoc task
deleteAdHocTask 2 params → 200
POST
/inv-playbook/task/due
Set task due date
taskSetDue body → 200
POST
/inv-playbook/task/edit/{investigationId}
Edit ad-hoc task
editAdHocTask 1 param body → 200
POST
/inv-playbook/task/note/add
Task add comment
taskAddComment body → 200
POST
/inv-playbook/task/uncomplete
Un complete a task
taskUnComplete body → 200
POST
/v2/inv-playbook/task/complete
Complete a task
completeTaskV2 body → 200
POST
/v2/inv-playbook/task/form/submit
Complete a task
submitTaskForm body → 200

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are InvestigationPlaybookTask (54 properties), InvestigationPlaybook (28 properties), Task (18 properties), InvestigationPlaybookData (15 properties). Each schema is shown below with its type and property counts.

TaskLoop
object
TaskLoop contains loop details
8 properties
TimerTrigger
object
2 properties
ArgAtomicFilter
object
ArgAtomicFilter - operator with two sides that return true/false
5 properties
InvPlaybookTaskCompleteData
object
11 properties
TaskView
object
TaskView represents the view in client of the tasks graph
TimerAction
string
InvestigationPlaybookTask
object
InvestigationPlaybookTask is the Task in the playbook context as a node
54 properties
InvestigationPlaybookData
object
InvestigationPlaybookData returns all data of an investigation playbook, not including history
15 properties
ComplexArg
object
ComplexArg - all info that is necessary to compute argument value from context Root - the root slice (or object) from to work against Filters - a slice of filt…
4 properties
OutputType
string
GridColumn
object
10 properties
PlaybookView
object
PlaybookView represents the view in client of playbook graph
PlaybookOutputs
array
PlaybookOutputs - array of PlaybookOutput
ReputationCalcAlg
number
invPlaybookDue
object
4 properties
TaskState
string
TaskState indicates the state of the task during the incident/investigation execution
EvidenceData
object
EvidenceData - all evidence properties to evaluate in task process
4 properties
TransformerOperatorID
string
PlaybookInput
object
PlaybookInput represents the playbook input
4 properties
ArgFilter
array
ArgFilter - represent a slice of atomic filters with OR condition between them (e.i. - atomic1 OR atomic2 OR ...)
DataCollectionForm
object
6 properties
TaskCondition
object
TaskCondition - contains a condition and a corresponding label if the condition satisfied - its label is taken as the next task(s) input (e.i. the label on the…
2 properties
PlaybookOutput
object
PlaybookOutput represents the playbook output
3 properties
TaskType
string
TaskType is the Task in the playbook context as a node
SLA
object
3 properties
InvestigationPlaybookState
string
InvestigationPlaybookState indicates the state of the running playbook
QuietMode
integer
QuietMode quiet mode for playbook task
NotifiableItem
object
10 properties
PlaybookInputs
array
PlaybookInputs - array of PlaybookInput
invTaskInfo
object
9 properties
OperatorArgument
object
2 properties
FilterOperatorID
string
ArgTransformer
object
2 properties
FieldMapping
object
FieldMapping - Map a task output (complex or simple value) to an incident field
2 properties
AdvanceArg
object
Simple: plain text such as "hello" (constant) or ${File.ID} (DT expression) Complex: struct with all info that is necessary to compute argument value from cont…
2 properties
InvPlaybookTaskData
object
7 properties
Task
object
Task is the basic task in the task repository that can be associated to an incident via playbook
18 properties
InvestigationPlaybook
object
InvestigationPlaybook is a wrapper for a linked list of Playbook tasks
28 properties
NotifyTimings
object
3 properties
invPlaybookAssignee
object
4 properties
Question
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

demisto-inv-playbook-api-openapi.yml Raw ↑

Other APIs Demisto publishes across the network.

Demisto Automation API
Demisto Classifier API
Demisto Contentpacks API
Demisto Dashboards API
Demisto Entry API
Demisto Evidence API
Demisto Incident API
Demisto Incidentfields API
Demisto Incidents API
Demisto Incidenttype API
Demisto Indicator API
Demisto Indicators API
Where this information came from

This is an independent, third-party profile of Demisto Inv Playbook API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.