Create a new automation
Authorizations:
Request Body schema: application/json
New automation
id required | string |
image required | string |
schema | string |
script required | string |
type required | Array of strings Items Enum: "artifact" "playbook" "global" |
Responses
Request samples
- Payload
{- "id": "string",
- "image": "string",
- "schema": "{}",
- "script": "string",
- "type": [
- "artifact"
]
}
Response samples
- 200
{- "id": "string",
- "image": "string",
- "schema": "{}",
- "script": "string",
- "type": [
- "artifact"
]
}
Update an existing automation
Authorizations:
path Parameters
id required | string Example: hash.sha1 Automation ID |
Request Body schema: application/json
Automation object that needs to be added
id required | string |
image required | string |
schema | string |
script required | string |
type required | Array of strings Items Enum: "artifact" "playbook" "global" |
Responses
Request samples
- Payload
{- "id": "string",
- "image": "string",
- "schema": "{}",
- "script": "string",
- "type": [
- "artifact"
]
}
Response samples
- 200
{- "id": "string",
- "image": "string",
- "schema": "{}",
- "script": "string",
- "type": [
- "artifact"
]
}
Create user
Authorizations:
Request Body schema: application/json
user object that needs to be added
apikey required | boolean |
blocked required | boolean |
id required | string |
roles required | Array of strings |
Responses
Request samples
- Payload
{- "apikey": true,
- "blocked": true,
- "id": "string",
- "roles": [
- "string"
]
}
Response samples
- 200
{- "blocked": true,
- "id": "string",
- "roles": [
- "string"
], - "secret": "string"
}
Update user
Authorizations:
path Parameters
id required | string Example: bob Template ID |
Request Body schema: application/json
user object that needs to be added
apikey required | boolean |
blocked required | boolean |
id required | string |
roles required | Array of strings |
Responses
Request samples
- Payload
{- "apikey": true,
- "blocked": true,
- "id": "string",
- "roles": [
- "string"
]
}
Response samples
- 200
{- "apikey": true,
- "blocked": true,
- "id": "string",
- "roles": [
- "string"
]
}
Update current user data
Authorizations:
Request Body schema: application/json
User data object that needs to be added
string | |
image | string |
name | string |
timeformat | string (Time Format (https://moment.github.io/luxon/docs/manual/formatting.html#table-of-tokens)) |
Responses
Request samples
- Payload
{- "email": "string",
- "image": "string",
- "name": "string",
- "timeformat": "string"
}
Response samples
- 200
{- "email": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "timeformat": "string"
}
Update an existing user data
Authorizations:
path Parameters
id required | string Example: bob User Data ID |
Request Body schema: application/json
User data object that needs to be added
string | |
image | string |
name | string |
timeformat | string (Time Format (https://moment.github.io/luxon/docs/manual/formatting.html#table-of-tokens)) |
Responses
Request samples
- Payload
{- "email": "string",
- "image": "string",
- "name": "string",
- "timeformat": "string"
}
Response samples
- 200
{- "email": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "timeformat": "string"
}
Response samples
- 200
[- {
- "automation": "string",
- "container": "string",
- "id": "string",
- "log": "string",
- "origin": {
- "artifact_origin": {
- "artifact": "string",
- "ticket_id": 0
}, - "task_origin": {
- "playbook_id": "string",
- "task_id": "string",
- "ticket_id": 0
}
}, - "output": { },
- "payload": { },
- "status": "string"
}
]
Start a new job
Authorizations:
Request Body schema: application/json
New job
automation required | string |
object (Origin) | |
payload | object |
Responses
Request samples
- Payload
{- "automation": "string",
- "origin": {
- "artifact_origin": {
- "artifact": "string",
- "ticket_id": 0
}, - "task_origin": {
- "playbook_id": "string",
- "task_id": "string",
- "ticket_id": 0
}
}, - "payload": { }
}
Get a single job
Authorizations:
path Parameters
id required | string Example: 99cd67131b48 Job ID |
Responses
Response samples
- 200
{- "automation": "string",
- "container": "string",
- "id": "string",
- "log": "string",
- "origin": {
- "artifact_origin": {
- "artifact": "string",
- "ticket_id": 0
}, - "task_origin": {
- "playbook_id": "string",
- "task_id": "string",
- "ticket_id": 0
}
}, - "output": { },
- "payload": { },
- "status": "string"
}
Update an existing job
Authorizations:
path Parameters
id required | string Example: 99cd67131b48 Job ID |
Request Body schema: application/json
Job object that needs to be added
automation required | string |
container | string |
log | string |
object (Origin) | |
output | object |
payload | object |
running required | boolean |
status required | string |
Responses
Request samples
- Payload
{- "automation": "string",
- "container": "string",
- "log": "string",
- "origin": {
- "artifact_origin": {
- "artifact": "string",
- "ticket_id": 0
}, - "task_origin": {
- "playbook_id": "string",
- "task_id": "string",
- "ticket_id": 0
}
}, - "output": { },
- "payload": { },
- "running": true,
- "status": "string"
}
Response samples
- 200
{- "automation": "string",
- "container": "string",
- "id": "string",
- "log": "string",
- "origin": {
- "artifact_origin": {
- "artifact": "string",
- "ticket_id": 0
}, - "task_origin": {
- "playbook_id": "string",
- "task_id": "string",
- "ticket_id": 0
}
}, - "output": { },
- "payload": { },
- "status": "string"
}
Update an existing ticket playbook
Authorizations:
path Parameters
id required | string Example: simple Playbook ID |
Request Body schema: application/json
Updated playbook
id | string |
yaml required | string |
Responses
Request samples
- Payload
{- "id": "string",
- "yaml": "string"
}
Response samples
- 200
{- "id": "string",
- "name": "string",
- "yaml": "string"
}
Response samples
- 200
{- "artifactStates": [
- {
- "color": "error",
- "icon": "string",
- "id": "string",
- "name": "string"
}
], - "roles": [
- "string"
], - "ticketTypes": [
- {
- "default_groups": [
- "string"
], - "default_playbooks": [
- "string"
], - "default_template": "string",
- "icon": "string",
- "id": "string",
- "name": "string"
}
], - "tier": "community",
- "timeformat": "string",
- "version": "string"
}
Response samples
- 200
[- {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
]
Create a new template
Authorizations:
Request Body schema: application/json
New template
id | string |
name required | string |
schema required | string |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "string",
- "schema": "string"
}
Response samples
- 200
{- "id": "string",
- "name": "string",
- "schema": "string"
}
Update an existing template
Authorizations:
path Parameters
id required | string Example: default Template ID |
Request Body schema: application/json
Template object that needs to be added
id | string |
name required | string |
schema required | string |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "string",
- "schema": "string"
}
Response samples
- 200
{- "id": "string",
- "name": "string",
- "schema": "string"
}
List tickets
Authorizations:
query Parameters
type | string Ticket Type |
offset | integer Default: 0 Offset of the list |
count | integer <= 100 Default: 25 Number of tickets |
sort | Array of strings Sort columns |
desc | Array of booleans Sort descending |
query | string Search query |
Responses
Response samples
- 200
{- "count": 3,
- "tickets": [
- {
- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
]
}
Create a new ticket
Authorizations:
Request Body schema: application/json
New ticket
Array of objects (Artifact) | |
Array of objects (Comment) | |
created | string <date-time> |
details | object |
Array of objects (File) | |
id | integer <int64> |
modified | string <date-time> |
name required | string |
owner | string |
Array of objects (PlaybookTemplateForm) | |
read | Array of strings |
Array of objects (Reference) | |
schema | string |
status required | string |
type required | string |
write | Array of strings |
Responses
Request samples
- Payload
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": [
- {
- "id": "string",
- "yaml": "string"
}
], - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Get a single ticket
Authorizations:
path Parameters
id required | integer <int64> Example: 8125 Ticket ID |
Responses
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Update an existing ticket
Authorizations:
path Parameters
id required | integer <int64> Example: 8125 Ticket ID |
Request Body schema: application/json
Updated ticket
Array of objects (Artifact) | |
Array of objects (Comment) | |
created required | string <date-time> |
details | object |
Array of objects (File) | |
modified required | string <date-time> |
name required | string |
owner | string |
object | |
read | Array of strings |
Array of objects (Reference) | |
schema required | string |
status required | string |
type required | string |
write | Array of strings |
Responses
Request samples
- Payload
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Add a single artifact
Authorizations:
path Parameters
id required | integer <int64> Example: 8123 Ticket ID |
Request Body schema: application/json
Artifact object that needs to be added
object | |
name required | string |
status | string |
type | string |
Responses
Request samples
- Payload
{- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Remove an artifact
Authorizations:
path Parameters
id required | integer <int64> Example: 8123 Ticket ID |
name required | string Example: leadreintermediate.io |
Responses
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Get a single artifact
Authorizations:
path Parameters
id required | integer <int64> Example: 8123 Ticket ID |
name required | string Example: leadreintermediate.io |
Responses
Response samples
- 200
{- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
Set a single artifact
Authorizations:
path Parameters
id required | integer <int64> Example: 8123 Ticket ID |
name required | string Example: leadreintermediate.io |
Request Body schema: application/json
object | |
name required | string |
status | string |
type | string |
Responses
Request samples
- Payload
{- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Enrich a single artifact
Authorizations:
path Parameters
id required | integer <int64> Example: 8123 Ticket ID |
name required | string Example: leadreintermediate.io |
Request Body schema: application/json
data required | object |
name required | string |
Responses
Request samples
- Payload
{- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
Response samples
- 200
{- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
Add ticket comment
Authorizations:
path Parameters
id required | integer <int64> Example: 8125 Ticket ID |
Request Body schema: application/json
Ticket comment
created | string <date-time> |
creator | string |
message required | string |
Responses
Request samples
- Payload
{- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Remove an comment from an ticket
Comment will be removed from the ticket.
Authorizations:
path Parameters
id required | integer <int64> Example: 8123 Ticket ID |
commentID required | integer Comment ID to remove |
Responses
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Link files to an ticket
Link files to an ticket. The files themself will be stored in object storage.
Authorizations:
path Parameters
id required | integer <int64> Example: 8125 Ticket ID |
Request Body schema: application/json
Added files
key required | string |
name required | string |
Responses
Request samples
- Payload
[- {
- "key": "myfile",
- "name": "notes.docx"
}
]
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Add a new ticket playbook
path Parameters
id required | integer <int64> Example: 8125 Ticket ID |
Request Body schema: application/json
Ticket playbook object that needs to be added
id | string |
yaml required | string |
Responses
Request samples
- Payload
{- "id": "string",
- "yaml": "string"
}
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Remove an ticket playbook
Authorizations:
path Parameters
id required | integer <int64> Example: 8123 Ticket ID |
playbookID required | string Example: phishing Playbook ID |
Responses
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Set a ticket playbook task
Authorizations:
path Parameters
id required | integer <int64> Example: 8123 Ticket ID |
playbookID required | string Example: phishing Playbook ID |
taskID required | string Example: board Task ID |
Request Body schema: application/json
Task
automation | string |
closed | string <date-time> |
created required | string <date-time> |
data | object |
done required | boolean |
join | boolean |
name required | string |
object | |
owner | string |
object | |
schema | object |
type required | string Enum: "task" "input" "automation" |
Responses
Request samples
- Payload
{- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Complete ticket playbook task
Authorizations:
path Parameters
id required | integer <int64> Example: 8123 Ticket ID |
playbookID required | string Example: phishing Playbook ID |
taskID required | string Example: board Task ID |
Request Body schema: application/json
Ticket playbook object that needs to be added
Responses
Request samples
- Payload
{ }
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Set ticket references
Authorizations:
path Parameters
id required | integer <int64> Example: 8125 Ticket ID |
Request Body schema: application/json
All ticket references
href required | string |
name required | string |
Responses
Request samples
- Payload
[
]
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Set ticket schema
Authorizations:
path Parameters
id required | integer <int64> Example: 8125 Ticket ID |
Request Body schema: application/json
New ticket schema
Responses
Request samples
- Payload
"string"
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Unlink an ticket to an ticket
Authorizations:
path Parameters
id required | integer <int64> Example: 8126 Ticket ID |
Request Body schema: application/json
Added ticket ID
Responses
Request samples
- Payload
0
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}, - "property2": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "b7a067a742c20d07a7456646de89bc2d408a1153"
}, - "name": "hash.sha1"
}
}, - "name": "2.2.2.2",
- "status": "Unknown",
- "type": "string"
}
], - "comments": [
- {
- "created": "2019-08-24T14:15:22Z",
- "creator": "string",
- "message": "string"
}
], - "created": "2019-08-24T14:15:22Z",
- "details": {
- "description": "my little incident"
}, - "files": [
- {
- "key": "myfile",
- "name": "notes.docx"
}
], - "id": 123,
- "modified": "2019-08-24T14:15:22Z",
- "name": "WannyCry",
- "owner": "bob",
- "playbooks": {
- "property1": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}, - "property2": {
- "name": "Phishing",
- "tasks": {
- "property1": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}, - "property2": {
- "active": false,
- "automation": "string",
- "closed": "2019-08-24T14:15:22Z",
- "created": "2019-08-24T14:15:22Z",
- "data": { },
- "done": true,
- "join": false,
- "name": "Inform user",
- "next": {
- "property1": "string",
- "property2": "string"
}, - "order": 2,
- "owner": "string",
- "payload": {
- "property1": "string",
- "property2": "string"
}, - "schema": { },
- "type": "task"
}
}
}
}, - "read": [
- "bob"
], - "references": [
], - "schema": "{}",
- "status": "open",
- "type": "incident",
- "write": [
- "alice"
]
}
Link an ticket to an ticket
Authorizations:
path Parameters
id required | integer <int64> Example: 8126 Ticket ID |
Request Body schema: application/json
Added ticket ID
Responses
Request samples
- Payload
0
Response samples
- 200
{- "artifacts": [
- {
- "enrichments": {
- "property1": {
- "created": "2019-08-24T14:15:22Z",
- "data": {
- "hash": "