Skip to main content

Download OpenAPI specification:Download

API for the catalyst incident response platform.

automations

List automations

Authorizations:
None

Responses

Response samples

Content type
[
  • {
    }
]

Create a new automation

Authorizations:
None
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

Content type
application/json
{
  • "id": "string",
  • "image": "string",
  • "schema": "{}",
  • "script": "string",
  • "type": [
    ]
}

Response samples

Content type
{
  • "id": "string",
  • "image": "string",
  • "schema": "{}",
  • "script": "string",
  • "type": [
    ]
}

Delete a automation

Authorizations:
None
path Parameters
id
required
string
Example: hash.sha1

Automation ID

Responses

Get a single automation

Authorizations:
None
path Parameters
id
required
string
Example: hash.sha1

Automation ID

Responses

Response samples

Content type
{
  • "id": "string",
  • "image": "string",
  • "schema": "{}",
  • "script": "string",
  • "type": [
    ]
}

Update an existing automation

Authorizations:
None
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

Content type
application/json
{
  • "id": "string",
  • "image": "string",
  • "schema": "{}",
  • "script": "string",
  • "type": [
    ]
}

Response samples

Content type
{
  • "id": "string",
  • "image": "string",
  • "schema": "{}",
  • "script": "string",
  • "type": [
    ]
}

users

Get current user

Authorizations:
None

Responses

Response samples

Content type
{
  • "apikey": true,
  • "blocked": true,
  • "id": "string",
  • "roles": [
    ]
}

List users

Authorizations:
None

Responses

Response samples

Content type
[
  • {
    }
]

Create user

Authorizations:
None
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

Content type
application/json
{
  • "apikey": true,
  • "blocked": true,
  • "id": "string",
  • "roles": [
    ]
}

Response samples

Content type
{
  • "blocked": true,
  • "id": "string",
  • "roles": [
    ],
  • "secret": "string"
}

Delete user

Authorizations:
None
path Parameters
id
required
string
Example: script

user ID

Responses

Get a single user

Authorizations:
None
path Parameters
id
required
string
Example: script

user ID

Responses

Response samples

Content type
{
  • "apikey": true,
  • "blocked": true,
  • "id": "string",
  • "roles": [
    ]
}

Update user

Authorizations:
None
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

Content type
application/json
{
  • "apikey": true,
  • "blocked": true,
  • "id": "string",
  • "roles": [
    ]
}

Response samples

Content type
{
  • "apikey": true,
  • "blocked": true,
  • "id": "string",
  • "roles": [
    ]
}

userdata

Get current user data

Authorizations:
None

Responses

Response samples

Content type
{
  • "email": "string",
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "timeformat": "string"
}

Update current user data

Authorizations:
None
Request Body schema: application/json

User data object that needs to be added

email
string
image
string
name
string
timeformat
string (Time Format (https://moment.github.io/luxon/docs/manual/formatting.html#table-of-tokens))

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "image": "string",
  • "name": "string",
  • "timeformat": "string"
}

Response samples

Content type
{
  • "email": "string",
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "timeformat": "string"
}

List userdata

Authorizations:
None

Responses

Response samples

Content type
[
  • {
    }
]

Get a single user data

Authorizations:
None
path Parameters
id
required
string
Example: bob

User Data ID

Responses

Response samples

Content type
{
  • "email": "string",
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "timeformat": "string"
}

Update an existing user data

Authorizations:
None
path Parameters
id
required
string
Example: bob

User Data ID

Request Body schema: application/json

User data object that needs to be added

email
string
image
string
name
string
timeformat
string (Time Format (https://moment.github.io/luxon/docs/manual/formatting.html#table-of-tokens))

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "image": "string",
  • "name": "string",
  • "timeformat": "string"
}

Response samples

Content type
{
  • "email": "string",
  • "id": "string",
  • "image": "string",
  • "name": "string",
  • "timeformat": "string"
}

jobs

List jobs

Authorizations:
None

Responses

Response samples

Content type
[
  • {
    }
]

Start a new job

Authorizations:
None
Request Body schema: application/json

New job

automation
required
string
object (Origin)
payload
object

Responses

Request samples

Content type
application/json
{
  • "automation": "string",
  • "origin": {
    },
  • "payload": { }
}

Get a single job

Authorizations:
None
path Parameters
id
required
string
Example: 99cd67131b48

Job ID

Responses

Response samples

Content type
{
  • "automation": "string",
  • "container": "string",
  • "id": "string",
  • "log": "string",
  • "origin": {
    },
  • "output": { },
  • "payload": { },
  • "status": "string"
}

Update an existing job

Authorizations:
None
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

Content type
application/json
{
  • "automation": "string",
  • "container": "string",
  • "log": "string",
  • "origin": {
    },
  • "output": { },
  • "payload": { },
  • "running": true,
  • "status": "string"
}

Response samples

Content type
{
  • "automation": "string",
  • "container": "string",
  • "id": "string",
  • "log": "string",
  • "origin": {
    },
  • "output": { },
  • "payload": { },
  • "status": "string"
}

logs

Get log entries

Authorizations:
None
path Parameters
reference
required
string
Example: tickets%2F294511

Reference

Responses

Response samples

Content type
[
  • {
    }
]

playbooks

List playbooks

Authorizations:
None

Responses

Response samples

Content type
[
  • {
    }
]

Create a playbook

Authorizations:
None
Request Body schema: application/json

New playbook

id
string
yaml
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "yaml": "string"
}

Response samples

Content type
[
  • {
    }
]

Delete a playbook

Authorizations:
None
path Parameters
id
required
string
Example: simple

Playbook name

Responses

Get a single playbook

Authorizations:
None
path Parameters
id
required
string
Example: simple

Playbook name

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "yaml": "string"
}

Update an existing ticket playbook

Authorizations:
None
path Parameters
id
required
string
Example: simple

Playbook ID

Request Body schema: application/json

Updated playbook

id
string
yaml
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "yaml": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "yaml": "string"
}

settings

Get settings

Authorizations:
None

Responses

Response samples

Content type
{
  • "artifactStates": [
    ],
  • "roles": [
    ],
  • "ticketTypes": [
    ],
  • "tier": "community",
  • "timeformat": "string",
  • "version": "string"
}

statistics

Get statistics

Authorizations:
None

Responses

Response samples

Content type
{
  • "open_tickets_per_user": {
    },
  • "tickets_per_type": {
    },
  • "tickets_per_week": {
    },
  • "unassigned": 0
}

tasks

List tasks

Authorizations:
None

Responses

Response samples

Content type
[
  • {
    }
]

templates

List templates

Authorizations:
None

Responses

Response samples

Content type
[
  • {
    }
]

Create a new template

Authorizations:
None
Request Body schema: application/json

New template

id
string
name
required
string
schema
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "schema": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "schema": "string"
}

Delete a template

Authorizations:
None
path Parameters
id
required
string
Example: default

Template ID

Responses

Get a single template

Authorizations:
None
path Parameters
id
required
string
Example: default

Template ID

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "schema": "string"
}

Update an existing template

Authorizations:
None
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

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "schema": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "schema": "string"
}

tickets

List tickets

Authorizations:
None
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

Content type
{
  • "count": 3,
  • "tickets": [
    ]
}

Create a new ticket

Authorizations:
None
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

Content type
application/json
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": [
    ],
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Delete an ticket

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8125

Ticket ID

Responses

Get a single ticket

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8125

Ticket ID

Responses

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Update an existing ticket

Authorizations:
None
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

Content type
application/json
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Add a single artifact

Authorizations:
None
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

Content type
application/json
{
  • "enrichments": {
    },
  • "name": "2.2.2.2",
  • "status": "Unknown",
  • "type": "string"
}

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Remove an artifact

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8123

Ticket ID

name
required
string
Example: leadreintermediate.io

Responses

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Get a single artifact

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8123

Ticket ID

name
required
string
Example: leadreintermediate.io

Responses

Response samples

Content type
{
  • "enrichments": {
    },
  • "name": "2.2.2.2",
  • "status": "Unknown",
  • "type": "string"
}

Set a single artifact

Authorizations:
None
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

Content type
application/json
{
  • "enrichments": {
    },
  • "name": "2.2.2.2",
  • "status": "Unknown",
  • "type": "string"
}

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Enrich a single artifact

Authorizations:
None
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

Content type
application/json
{
  • "data": {
    },
  • "name": "hash.sha1"
}

Response samples

Content type
{
  • "enrichments": {
    },
  • "name": "2.2.2.2",
  • "status": "Unknown",
  • "type": "string"
}

Run automation on a single artifact

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8123

Ticket ID

name
required
string
Example: leadreintermediate.io
automation
required
string
Example: hash.sha1

Responses

Add ticket comment

Authorizations:
None
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

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "creator": "string",
  • "message": "string"
}

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Remove an comment from an ticket

Comment will be removed from the ticket.

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8123

Ticket ID

commentID
required
integer

Comment ID to remove

Responses

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Link files to an ticket

Link files to an ticket. The files themself will be stored in object storage.

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8125

Ticket ID

Request Body schema: application/json

Added files

Array
key
required
string
name
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

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

Content type
application/json
{
  • "id": "string",
  • "yaml": "string"
}

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Remove an ticket playbook

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8123

Ticket ID

playbookID
required
string
Example: phishing

Playbook ID

Responses

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Set a ticket playbook task

Authorizations:
None
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

Content type
application/json
{
  • "automation": "string",
  • "closed": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "data": { },
  • "done": true,
  • "join": false,
  • "name": "Inform user",
  • "next": {
    },
  • "owner": "string",
  • "payload": {
    },
  • "schema": { },
  • "type": "task"
}

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Complete ticket playbook task

Authorizations:
None
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

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Run ticket playbook task

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8123

Ticket ID

playbookID
required
string
Example: phishing

Playbook ID

taskID
required
string
Example: board

Task ID

Responses

Set ticket references

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8125

Ticket ID

Request Body schema: application/json

All ticket references

Array
href
required
string
name
required
string

Responses

Request samples

Content type
application/json

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Set ticket schema

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8125

Ticket ID

Request Body schema: application/json

New ticket schema

string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Unlink an ticket to an ticket

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8126

Ticket ID

Request Body schema: application/json

Added ticket ID

integer <int64>

Responses

Request samples

Content type
application/json
0
0

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Link an ticket to an ticket

Authorizations:
None
path Parameters
id
required
integer <int64>
Example: 8126

Ticket ID

Request Body schema: application/json

Added ticket ID

integer <int64>

Responses

Request samples

Content type
application/json
0
0

Response samples

Content type
{
  • "artifacts": [
    ],
  • "comments": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "details": {
    },
  • "files": [
    ],
  • "id": 123,
  • "modified": "2019-08-24T14:15:22Z",
  • "name": "WannyCry",
  • "owner": "bob",
  • "playbooks": {
    },
  • "read": [
    ],
  • "references": [],
  • "schema": "{}",
  • "status": "open",
  • "type": "incident",
  • "write": [
    ]
}

Create a new tickets in batch

Authorizations:
None
Request Body schema: application/json

New ticket

Array
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

Content type
application/json
[
  • {
    }
]

tickettypes

List tickettypes

Authorizations:
None

Responses

Response samples

Content type
[
  • {
    }
]

Create a new tickettype

Authorizations:
None
Request Body schema: application/json

New tickettype

default_groups
Array of strings
default_playbooks
required
Array of strings
default_template
required
string
icon
required
string
id
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "default_groups": [
    ],
  • "default_playbooks": [
    ],
  • "default_template": "string",
  • "icon": "string",
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "default_groups": [
    ],
  • "default_playbooks": [
    ],
  • "default_template": "string",
  • "icon": "string",
  • "id": "string",
  • "name": "string"
}

Delete a tickettype

Authorizations:
None
path Parameters
id
required
string
Example: alert

TicketType ID

Responses

Get a single tickettype

Authorizations:
None
path Parameters
id
required
string
Example: alert

TicketType ID

Responses

Response samples

Content type
{
  • "default_groups": [
    ],
  • "default_playbooks": [
    ],
  • "default_template": "string",
  • "icon": "string",
  • "id": "string",
  • "name": "string"
}

Update an existing tickettype

Authorizations:
None
path Parameters
id
required
string
Example: alert

TicketType ID

Request Body schema: application/json

TicketType object that needs to be added

default_groups
Array of strings
default_playbooks
required
Array of strings
default_template
required
string
icon
required
string
id
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "default_groups": [
    ],
  • "default_playbooks": [
    ],
  • "default_template": "string",
  • "icon": "string",
  • "id": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "default_groups": [
    ],
  • "default_playbooks": [
    ],
  • "default_template": "string",
  • "icon": "string",
  • "id": "string",
  • "name": "string"
}