API docs by Redocly

Cydarm API (v0.8.43.0)

Download OpenAPI specification:Download

Cydarm Support: support@cydarm.com URL: https://cydarm.com License: Copyright 2024 Cydarm Technologies Pty Ltd

Cydarm Secure Case Management Platform

acl

Gets a list of ACLs.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an ACL.

Authorizations:
api_key
Request Body schema: application/json
required

The ACL to create

required
Array of objects (aci) non-empty

A list of ACIs for this ACL

deprecated
required
boolean non-empty

A boolean flag that specifies whether this ACL is deprecated

description
required
string non-empty

A description for this ACL

forData
required
boolean non-empty

A boolean flag that specifies whether this ACL is intended for data

uuid
required
string <uuid> = 36 characters

The UUID of the ACL

Responses

Request samples

Content type
application/json
{
  • "aci": [
    ],
  • "deprecated": true,
  • "description": "string",
  • "forData": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "aci": [
    ],
  • "deprecated": true,
  • "description": "string",
  • "forData": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Searches for ACLs.

Authorizations:
api_key
Request Body schema: application/json
required

The ACL to search for

required
Array of objects (aci) non-empty

A list of ACIs for this ACL

deprecated
required
boolean non-empty

A boolean flag that specifies whether this ACL is deprecated

description
required
string non-empty

A description for this ACL

forData
required
boolean non-empty

A boolean flag that specifies whether this ACL is intended for data

uuid
required
string <uuid> = 36 characters

The UUID of the ACL

Responses

Request samples

Content type
application/json
{
  • "aci": [
    ],
  • "deprecated": true,
  • "description": "string",
  • "forData": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "aci": [
    ],
  • "deprecated": true,
  • "description": "string",
  • "forData": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Gets the default ACL for the current session.

Authorizations:
api_key
path Parameters
sessionUuid
required
string

The UUID of the session to retrieve.

Responses

Response samples

Content type
application/json
{
  • "aci": [
    ],
  • "deprecated": true,
  • "description": "string",
  • "forData": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Deletes an ACL.

Authorizations:
api_key
path Parameters
aclUuid
required
string

The UUID of the ACL to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets an ACL.

Authorizations:
api_key
path Parameters
aclUuid
required
string

The UUID of the ACL to retrieve.

Responses

Response samples

Content type
application/json
{
  • "aci": [
    ],
  • "deprecated": true,
  • "description": "string",
  • "forData": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

case

GET a data item on a case or case playbook action.

Authorizations:
api_key
path Parameters
actionInstanceUuid
required
string

The case action instance to get from.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a data item on a case action.

Authorizations:
api_key
path Parameters
actionInstanceUuid
required
string

The case action instance to add to.

Request Body schema: application/json
required

The data item to create.

acl_uuid
string <uuid>

The UUID of the ACL of the data object

audit
boolean

Is this data item an audit message

created
string = 25 characters

The time the item was created, as an ISO8601 timestamp

data
required
string

The raw bytes comprising the data, encoded in base 64

dataSource
string

Where the data came from

encryptionkey
string

The identifier of the encryption key to use on this data (if any)

fileLastMod
integer <int64> = 25 characters

The time the file was last modified, as an ISO8601 timestamp

fileName
string

The file name of the data, if it is a file

hidden
boolean

Is this data item hidden

mimeType
required
string

The MIME type of the data

parentStubUuid
required
string <uuid> = 36 characters

The UUID of the parent data object

significance
required
string

The signficance level of the data item

userUuid
required
string <uuid> = 36 characters

The UUID of the creator user

Responses

Request samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "audit": true,
  • "created": "stringstringstringstrings",
  • "data": "string",
  • "dataSource": "string",
  • "encryptionkey": "string",
  • "fileLastMod": 0,
  • "fileName": "string",
  • "hidden": true,
  • "mimeType": "string",
  • "parentStubUuid": "4667ea44-479a-4fb0-bd53-33f403c2e183",
  • "significance": "string",
  • "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "audit": true,
  • "caseuuid": "519d5a33-a250-4f92-902b-f611373d6a2c",
  • "created": "stringstringstringstrings",
  • "creatorusername": "string",
  • "creatoruuid": "ccbafeff-c915-43d6-87d7-522425158a2c",
  • "datalocation": "string",
  • "datalocationtype": "string",
  • "datasize": 0,
  • "datasource": "string",
  • "deleted": true,
  • "edited": true,
  • "editorusername": "string",
  • "editoruuid": "e03292bb-2028-453b-ac58-61c54556974e",
  • "filename": "string",
  • "hidden": true,
  • "lastmodified": "stringstringstringstrings",
  • "location": "string",
  • "mimetype": "string",
  • "parentuuid": "aa1c3a76-8333-4916-8af9-6cefa79a483e",
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0
}

Gets a list of cases, using filtering and sorting.

Authorizations:
api_key
query Parameters
page[number]
required
integer

The page offset to retrieve.

page[size]
required
integer

The number of items per page.

filter[create_start]
string

Earliest creation timestamp

filter[create_end]
string

Latest creation timestamp

filter[mod_start]
string

Earliest modification timestamp

filter[mod_end]
string

Latest modification timestamp

filter[state]
string

Comma-delimited list of state names

filter[org]
string

Comma-delimited list of org names

filter[assignee]
string

Comma-delimited list of assignee names

filter[severity]
string

Comma-delimited list of severity names

filter[inc_tag]
string

Comma-delimited list of tags to include

filter[exc_tag]
string

Comma-delimited list of tags to exclude

filter[text]
string

Text to search for in case locator, description, and metadata values

filter[parent_uuid]
string

Comma-delimited list of parent case uuids

sort
string

Field to sort on, one of: description, created, modified, org, assignee, status, severity, severity_name, min_sla_name, min_sla_seconds, closed, actions, completed_actions

sort_dir
string

Sort direction, one of asc or desc

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Creates a case.

Authorizations:
api_key
Request Body schema: application/json
required

The case to create.

tags
Array of strings

The tags attached to this case

acl
string

The ACL of the data object

assignee
string non-empty

The name of the current assignee

closed
string

The time at which the case was closed

created
string

The time at which the case was created

deletable
required
boolean

Whether the data is deletable in the current context

description
required
string non-empty

A description

editable
required
boolean

Whether the data is editable in the current context

locator
string >= 6 characters

The locator of the case

manageable
required
boolean

Whether the data is manageable in the current context

members
Array of strings <uuid> non-empty [ items <uuid > ]

UUIDs of member cases (if this case is a group)

object non-empty

Metadata fields attached to the case

minSlaName
string

The minimum SLA name

minSlaSeconds
integer <int64>

The minimum SLA remaining time, in seconds

modified
string

The time at which the case was modified

org
required
string non-empty

The name of the organisation who the case is relevant to

readable
required
boolean

Whether the data is readable in the current context

severity
integer <int64> non-empty

The severity of the case

severityName
string non-empty

The severity name for the case

status
string non-empty

The current status of the case

totalActionsInAllPlaybooks
integer <int64>

The total number of actions for all playbooks in a case

totalCompletedActionsInAllPlaybooks
integer <int64>

The number of actions that are completed for all playbooks in a case

updateAcls
boolean

Update all ACLS for the case including data items

uuid
string <uuid> = 36 characters

The UUID of the case

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "acl": "string",
  • "assignee": "string",
  • "closed": "string",
  • "created": "string",
  • "deletable": true,
  • "description": "string",
  • "editable": true,
  • "locator": "string",
  • "manageable": true,
  • "members": [
    ],
  • "metadata": {
    },
  • "minSlaName": "string",
  • "minSlaSeconds": 0,
  • "modified": "string",
  • "org": "string",
  • "readable": true,
  • "severity": 0,
  • "severityName": "string",
  • "status": "string",
  • "totalActionsInAllPlaybooks": 0,
  • "totalCompletedActionsInAllPlaybooks": 0,
  • "updateAcls": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Gets a case by locator.

Authorizations:
api_key
path Parameters
locator
required
string

The locator of the case to retrieve.

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ],
  • "acl": "string",
  • "assignee": "string",
  • "closed": "string",
  • "created": "string",
  • "deletable": true,
  • "description": "string",
  • "editable": true,
  • "locator": "string",
  • "manageable": true,
  • "members": [
    ],
  • "metadata": {
    },
  • "minSlaName": "string",
  • "minSlaSeconds": 0,
  • "modified": "string",
  • "org": "string",
  • "readable": true,
  • "severity": 0,
  • "severityName": "string",
  • "status": "string",
  • "totalActionsInAllPlaybooks": 0,
  • "totalCompletedActionsInAllPlaybooks": 0,
  • "updateAcls": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Search cases.

Authorizations:
api_key
Request Body schema: application/json
required

The terms to search for.

searchString
required
string non-empty

The search string

Responses

Request samples

Content type
application/json
{
  • "searchString": "string"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "case": {
    },
  • "rank": 0.1,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Gets a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to retrieve.

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ],
  • "acl": "string",
  • "assignee": "string",
  • "closed": "string",
  • "created": "string",
  • "deletable": true,
  • "description": "string",
  • "editable": true,
  • "locator": "string",
  • "manageable": true,
  • "members": [
    ],
  • "metadata": {
    },
  • "minSlaName": "string",
  • "minSlaSeconds": 0,
  • "modified": "string",
  • "org": "string",
  • "readable": true,
  • "severity": 0,
  • "severityName": "string",
  • "status": "string",
  • "totalActionsInAllPlaybooks": 0,
  • "totalCompletedActionsInAllPlaybooks": 0,
  • "updateAcls": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Updates a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to update.

Request Body schema: application/json
required

The case to update.

tags
Array of strings

The tags attached to this case

acl
string

The ACL of the data object

assignee
string non-empty

The name of the current assignee

closed
string

The time at which the case was closed

created
string

The time at which the case was created

deletable
required
boolean

Whether the data is deletable in the current context

description
required
string non-empty

A description

editable
required
boolean

Whether the data is editable in the current context

locator
string >= 6 characters

The locator of the case

manageable
required
boolean

Whether the data is manageable in the current context

members
Array of strings <uuid> non-empty [ items <uuid > ]

UUIDs of member cases (if this case is a group)

object non-empty

Metadata fields attached to the case

minSlaName
string

The minimum SLA name

minSlaSeconds
integer <int64>

The minimum SLA remaining time, in seconds

modified
string

The time at which the case was modified

org
required
string non-empty

The name of the organisation who the case is relevant to

readable
required
boolean

Whether the data is readable in the current context

severity
integer <int64> non-empty

The severity of the case

severityName
string non-empty

The severity name for the case

status
string non-empty

The current status of the case

totalActionsInAllPlaybooks
integer <int64>

The total number of actions for all playbooks in a case

totalCompletedActionsInAllPlaybooks
integer <int64>

The number of actions that are completed for all playbooks in a case

updateAcls
boolean

Update all ACLS for the case including data items

uuid
string <uuid> = 36 characters

The UUID of the case

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "acl": "string",
  • "assignee": "string",
  • "closed": "string",
  • "created": "string",
  • "deletable": true,
  • "description": "string",
  • "editable": true,
  • "locator": "string",
  • "manageable": true,
  • "members": [
    ],
  • "metadata": {
    },
  • "minSlaName": "string",
  • "minSlaSeconds": 0,
  • "modified": "string",
  • "org": "string",
  • "readable": true,
  • "severity": 0,
  • "severityName": "string",
  • "status": "string",
  • "totalActionsInAllPlaybooks": 0,
  • "totalCompletedActionsInAllPlaybooks": 0,
  • "updateAcls": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a list of action for a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove an action from a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case.

actionInstanceUuid
required
string

The UUID of the action instance to update.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Update an action for a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case.

actionInstanceUuid
required
string

The UUID of the action instance to update.

Request Body schema: application/json
required

The action update request

assignee
string <uuid> = 36 characters

The UUID of the assignee, if any

status
required
string

The status of the action

status_message
string

The message associated with this status change

object

The names and values of the action variables

Responses

Request samples

Content type
application/json
{
  • "assignee": "52cf793d-61ec-4818-938e-7a539e4f8457",
  • "status": "string",
  • "status_message": "string",
  • "variable_bindings": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Add an action to a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case.

actionUuid
required
string

The UUID of the action.

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ],
  • "Case": "599eebb3-c463-4512-8293-dc088ef8c694",
  • "Playbook": "1d411c3b-a5f8-4cdc-94c5-822f56130c9c",
  • "PlaybookPrecedence": 0,
  • "actionDescription": "string",
  • "actionInstanceUuid": "817995d4-8b9e-43b0-b00a-989262e393bf",
  • "actionName": "string",
  • "actionUuid": "b5518aa7-cf8f-47d8-a193-175d3437bc0a",
  • "assignedAt": "string",
  • "assigneeUuid": "b659b047-cabf-4272-9dd4-e4f0a7b48d5c",
  • "case_playbook_uuid": "14235c14-607d-4c7e-9018-65c72b59d8ac",
  • "created": "stringstringstringstrings",
  • "position": 0,
  • "status": "string",
  • "statusAt": "stringstringstringstrings",
  • "statusMsg": "string",
  • "variable_bindings": {
    }
}

Gets a list of data items for a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to get data for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a data item on a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to add to.

Request Body schema: application/json
required

The data item to create.

acl_uuid
string <uuid>

The UUID of the ACL of the data object

audit
boolean

Is this data item an audit message

created
string = 25 characters

The time the item was created, as an ISO8601 timestamp

data
required
string

The raw bytes comprising the data, encoded in base 64

dataSource
string

Where the data came from

encryptionkey
string

The identifier of the encryption key to use on this data (if any)

fileLastMod
integer <int64> = 25 characters

The time the file was last modified, as an ISO8601 timestamp

fileName
string

The file name of the data, if it is a file

hidden
boolean

Is this data item hidden

mimeType
required
string

The MIME type of the data

parentStubUuid
required
string <uuid> = 36 characters

The UUID of the parent data object

significance
required
string

The signficance level of the data item

userUuid
required
string <uuid> = 36 characters

The UUID of the creator user

Responses

Request samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "audit": true,
  • "created": "stringstringstringstrings",
  • "data": "string",
  • "dataSource": "string",
  • "encryptionkey": "string",
  • "fileLastMod": 0,
  • "fileName": "string",
  • "hidden": true,
  • "mimeType": "string",
  • "parentStubUuid": "4667ea44-479a-4fb0-bd53-33f403c2e183",
  • "significance": "string",
  • "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "audit": true,
  • "caseuuid": "519d5a33-a250-4f92-902b-f611373d6a2c",
  • "created": "stringstringstringstrings",
  • "creatorusername": "string",
  • "creatoruuid": "ccbafeff-c915-43d6-87d7-522425158a2c",
  • "datalocation": "string",
  • "datalocationtype": "string",
  • "datasize": 0,
  • "datasource": "string",
  • "deleted": true,
  • "edited": true,
  • "editorusername": "string",
  • "editoruuid": "e03292bb-2028-453b-ac58-61c54556974e",
  • "filename": "string",
  • "hidden": true,
  • "lastmodified": "stringstringstringstrings",
  • "location": "string",
  • "mimetype": "string",
  • "parentuuid": "aa1c3a76-8333-4916-8af9-6cefa79a483e",
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0
}

Creates a data item on a case, under a parent. Deprecated

This endpoint is deprecated. Use endpoint /data/{parentStudUuid} instead.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to add to.

parentStubId
required
string

The parent to add under.

Request Body schema: application/json
required

The data item to create.

acl_uuid
string <uuid>

The UUID of the ACL of the data object

audit
boolean

Is this data item an audit message

created
string = 25 characters

The time the item was created, as an ISO8601 timestamp

data
required
string

The raw bytes comprising the data, encoded in base 64

dataSource
string

Where the data came from

encryptionkey
string

The identifier of the encryption key to use on this data (if any)

fileLastMod
integer <int64> = 25 characters

The time the file was last modified, as an ISO8601 timestamp

fileName
string

The file name of the data, if it is a file

hidden
boolean

Is this data item hidden

mimeType
required
string

The MIME type of the data

parentStubUuid
required
string <uuid> = 36 characters

The UUID of the parent data object

significance
required
string

The signficance level of the data item

userUuid
required
string <uuid> = 36 characters

The UUID of the creator user

Responses

Request samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "audit": true,
  • "created": "stringstringstringstrings",
  • "data": "string",
  • "dataSource": "string",
  • "encryptionkey": "string",
  • "fileLastMod": 0,
  • "fileName": "string",
  • "hidden": true,
  • "mimeType": "string",
  • "parentStubUuid": "4667ea44-479a-4fb0-bd53-33f403c2e183",
  • "significance": "string",
  • "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "audit": true,
  • "caseuuid": "519d5a33-a250-4f92-902b-f611373d6a2c",
  • "created": "stringstringstringstrings",
  • "creatorusername": "string",
  • "creatoruuid": "ccbafeff-c915-43d6-87d7-522425158a2c",
  • "datalocation": "string",
  • "datalocationtype": "string",
  • "datasize": 0,
  • "datasource": "string",
  • "deleted": true,
  • "edited": true,
  • "editorusername": "string",
  • "editoruuid": "e03292bb-2028-453b-ac58-61c54556974e",
  • "filename": "string",
  • "hidden": true,
  • "lastmodified": "stringstringstringstrings",
  • "location": "string",
  • "mimetype": "string",
  • "parentuuid": "aa1c3a76-8333-4916-8af9-6cefa79a483e",
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0
}

Updates a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to update.

Request Body schema: application/json
required

The case to update.

tags
Array of strings

The tags attached to this case

acl
string

The ACL of the data object

assignee
string non-empty

The name of the current assignee

closed
string

The time at which the case was closed

created
string

The time at which the case was created

deletable
required
boolean

Whether the data is deletable in the current context

description
required
string non-empty

A description

editable
required
boolean

Whether the data is editable in the current context

locator
string >= 6 characters

The locator of the case

manageable
required
boolean

Whether the data is manageable in the current context

members
Array of strings <uuid> non-empty [ items <uuid > ]

UUIDs of member cases (if this case is a group)

object non-empty

Metadata fields attached to the case

minSlaName
string

The minimum SLA name

minSlaSeconds
integer <int64>

The minimum SLA remaining time, in seconds

modified
string

The time at which the case was modified

org
required
string non-empty

The name of the organisation who the case is relevant to

readable
required
boolean

Whether the data is readable in the current context

severity
integer <int64> non-empty

The severity of the case

severityName
string non-empty

The severity name for the case

status
string non-empty

The current status of the case

totalActionsInAllPlaybooks
integer <int64>

The total number of actions for all playbooks in a case

totalCompletedActionsInAllPlaybooks
integer <int64>

The number of actions that are completed for all playbooks in a case

updateAcls
boolean

Update all ACLS for the case including data items

uuid
string <uuid> = 36 characters

The UUID of the case

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "acl": "string",
  • "assignee": "string",
  • "closed": "string",
  • "created": "string",
  • "deletable": true,
  • "description": "string",
  • "editable": true,
  • "locator": "string",
  • "manageable": true,
  • "members": [
    ],
  • "metadata": {
    },
  • "minSlaName": "string",
  • "minSlaSeconds": 0,
  • "modified": "string",
  • "org": "string",
  • "readable": true,
  • "severity": 0,
  • "severityName": "string",
  • "status": "string",
  • "totalActionsInAllPlaybooks": 0,
  • "totalCompletedActionsInAllPlaybooks": 0,
  • "updateAcls": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Retroactively creates a data item on a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to add to.

Request Body schema: application/json
required

The data item to create.

acl_uuid
string <uuid>

The UUID of the ACL of the data object

audit
boolean

Is this data item an audit message

created
string = 25 characters

The time the item was created, as an ISO8601 timestamp

data
required
string

The raw bytes comprising the data, encoded in base 64

dataSource
string

Where the data came from

encryptionkey
string

The identifier of the encryption key to use on this data (if any)

fileLastMod
integer <int64> = 25 characters

The time the file was last modified, as an ISO8601 timestamp

fileName
string

The file name of the data, if it is a file

hidden
boolean

Is this data item hidden

mimeType
required
string

The MIME type of the data

parentStubUuid
required
string <uuid> = 36 characters

The UUID of the parent data object

significance
required
string

The signficance level of the data item

userUuid
required
string <uuid> = 36 characters

The UUID of the creator user

Responses

Request samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "audit": true,
  • "created": "stringstringstringstrings",
  • "data": "string",
  • "dataSource": "string",
  • "encryptionkey": "string",
  • "fileLastMod": 0,
  • "fileName": "string",
  • "hidden": true,
  • "mimeType": "string",
  • "parentStubUuid": "4667ea44-479a-4fb0-bd53-33f403c2e183",
  • "significance": "string",
  • "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "audit": true,
  • "caseuuid": "519d5a33-a250-4f92-902b-f611373d6a2c",
  • "created": "stringstringstringstrings",
  • "creatorusername": "string",
  • "creatoruuid": "ccbafeff-c915-43d6-87d7-522425158a2c",
  • "datalocation": "string",
  • "datalocationtype": "string",
  • "datasize": 0,
  • "datasource": "string",
  • "deleted": true,
  • "edited": true,
  • "editorusername": "string",
  • "editoruuid": "e03292bb-2028-453b-ac58-61c54556974e",
  • "filename": "string",
  • "hidden": true,
  • "lastmodified": "stringstringstringstrings",
  • "location": "string",
  • "mimetype": "string",
  • "parentuuid": "aa1c3a76-8333-4916-8af9-6cefa79a483e",
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0
}

GetGroupsContainingCase

Returns the UUID of all case groups that contain a given case

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Removes a case member from a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to update.

memberUuid
required
string

The UUID of the case to remove.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Adds a case as a member of another case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to update.

memberUuid
required
string

The UUID of the case to add.

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Creates a case metadata entry.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to update.

Request Body schema: application/json
required

The case metadata to create.

Array of objects (caseMeta)

List of metadata items to create

delete
Array of strings <uuid> [ items <uuid > ]

List of metadata items to delete

Array of objects (caseMeta)

List of metadata items to update

Responses

Request samples

Content type
application/json
{
  • "create": [
    ],
  • "delete": [
    ],
  • "update": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a list of playbooks for a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Removes a playbook from a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to remove from.

casePlaybookUuid
required
string

The UUID of the playbook to remove.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets the status of each action, for a playbook on a given case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case.

casePlaybookUuid
required
string

The UUID of the playbook.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a playbook.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to which the playbook will be assigned.

casePlaybookUuid
required
string

The UUID of the playbook to be assigned.

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Updates a playbook instance on a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case.

casePlaybookUuid
required
string

The UUID of the playbook instance to be updated.

Request Body schema: application/json
required

The update request

object

The new bindings for variables declared in the playbook

Responses

Request samples

Content type
application/json
{
  • "variable_bindings": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Updates a playbook action for a given playbook on a given case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to update.

casePlaybookUuid
required
string

The UUID of the playbook to update.

actionInstanceUuid
required
string

The UUID of the action instance to update.

Request Body schema: application/json
required

The action update request

assignee
string <uuid> = 36 characters

The UUID of the assignee, if any

status
required
string

The status of the action

status_message
string

The message associated with this status change

object

The names and values of the action variables

Responses

Request samples

Content type
application/json
{
  • "assignee": "52cf793d-61ec-4818-938e-7a539e4f8457",
  • "status": "string",
  • "status_message": "string",
  • "variable_bindings": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Removes a tag from a case playbook action.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to remove from.

casePlaybookUuid
required
string

The UUID of the playbook to remove.

actionInstanceUuid
required
string

The UUID of the action instance to update.

tagUuid
required
string

The UUID of the tag to remove.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Add a tag from a case playbook action.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to add from.

casePlaybookUuid
required
string

The UUID of the playbook to add.

actionInstanceUuid
required
string

The UUID of the action instance to update.

tagUuid
required
string

The UUID of the tag to add.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a list of STIX data items for a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to fetch STIX data for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a STIX item on a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to add to.

Request Body schema: application/json
required

The data item to create.

acl_uuid
string <uuid>

The UUID of the ACL of the data object

object

A map of individual components and their respective ACLs

audit
boolean

Is this data item an audit message

created
string = 25 characters

The time the item was created, as an ISO8601 timestamp

data
required
string

The raw bytes comprising the data, encoded in base 64

dataSource
string

Where the data came from

encryptionkey
string

The identifier of the encryption key to use on this data (if any)

fileLastMod
integer <int64> = 25 characters

The time the file was last modified, as an ISO8601 timestamp

fileName
string

The file name of the data, if it is a file

hidden
boolean

Is this data item hidden

mimeType
required
string

The MIME type of the data

parentStubUuid
required
string <uuid> = 36 characters

The UUID of the parent data object

significance
required
string

The signficance level of the data item

userUuid
required
string <uuid> = 36 characters

The UUID of the creator user

Responses

Request samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "acls": {
    },
  • "audit": true,
  • "created": "stringstringstringstrings",
  • "data": "string",
  • "dataSource": "string",
  • "encryptionkey": "string",
  • "fileLastMod": 0,
  • "fileName": "string",
  • "hidden": true,
  • "mimeType": "string",
  • "parentStubUuid": "4667ea44-479a-4fb0-bd53-33f403c2e183",
  • "significance": "string",
  • "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "audit": true,
  • "caseuuid": "519d5a33-a250-4f92-902b-f611373d6a2c",
  • "created": "stringstringstringstrings",
  • "creatorusername": "string",
  • "creatoruuid": "ccbafeff-c915-43d6-87d7-522425158a2c",
  • "datalocation": "string",
  • "datalocationtype": "string",
  • "datasize": 0,
  • "datasource": "string",
  • "deleted": true,
  • "edited": true,
  • "editorusername": "string",
  • "editoruuid": "e03292bb-2028-453b-ac58-61c54556974e",
  • "filename": "string",
  • "hidden": true,
  • "lastmodified": "stringstringstringstrings",
  • "location": "string",
  • "mimetype": "string",
  • "parentuuid": "aa1c3a76-8333-4916-8af9-6cefa79a483e",
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0
}

Creates a STIX item on a case, under a parent.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to add to.

parentStubId
required
string

The parent to add under.

Request Body schema: application/json
required

The data item to create.

acl_uuid
string <uuid>

The UUID of the ACL of the data object

object

A map of individual components and their respective ACLs

audit
boolean

Is this data item an audit message

created
string = 25 characters

The time the item was created, as an ISO8601 timestamp

data
required
string

The raw bytes comprising the data, encoded in base 64

dataSource
string

Where the data came from

encryptionkey
string

The identifier of the encryption key to use on this data (if any)

fileLastMod
integer <int64> = 25 characters

The time the file was last modified, as an ISO8601 timestamp

fileName
string

The file name of the data, if it is a file

hidden
boolean

Is this data item hidden

mimeType
required
string

The MIME type of the data

parentStubUuid
required
string <uuid> = 36 characters

The UUID of the parent data object

significance
required
string

The signficance level of the data item

userUuid
required
string <uuid> = 36 characters

The UUID of the creator user

Responses

Request samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "acls": {
    },
  • "audit": true,
  • "created": "stringstringstringstrings",
  • "data": "string",
  • "dataSource": "string",
  • "encryptionkey": "string",
  • "fileLastMod": 0,
  • "fileName": "string",
  • "hidden": true,
  • "mimeType": "string",
  • "parentStubUuid": "4667ea44-479a-4fb0-bd53-33f403c2e183",
  • "significance": "string",
  • "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "audit": true,
  • "caseuuid": "519d5a33-a250-4f92-902b-f611373d6a2c",
  • "created": "stringstringstringstrings",
  • "creatorusername": "string",
  • "creatoruuid": "ccbafeff-c915-43d6-87d7-522425158a2c",
  • "datalocation": "string",
  • "datalocationtype": "string",
  • "datasize": 0,
  • "datasource": "string",
  • "deleted": true,
  • "edited": true,
  • "editorusername": "string",
  • "editoruuid": "e03292bb-2028-453b-ac58-61c54556974e",
  • "filename": "string",
  • "hidden": true,
  • "lastmodified": "stringstringstringstrings",
  • "location": "string",
  • "mimetype": "string",
  • "parentuuid": "aa1c3a76-8333-4916-8af9-6cefa79a483e",
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0
}

Gets a list of watchers for a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to add to.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds a new watcher to a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to add user to as new watcher.

Request Body schema: application/json

The settings to create the watcher with.

acl_uuid
string <uuid> = 36 characters

The ACL to be applied to to the watcher

Responses

Request samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

actuator

GetActuators

Gets all actuators

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateActuator

Creates an actuator

Authorizations:
api_key
Request Body schema: application/json
required

The actuator to create.

api_poll_rate
required
integer <int64> (Duration)

A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.

required
object (integrationConfig)

IntegrationConfig is the config of an actuator or connector

required
object (integrationConfigSchema)

IntegrationConfigSchema is the schema for the config of an actuator or connector

description
string

The description of the actuator

heartbeat_rate
integer <int64> (Duration)

A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.

log_level
required
integer <uint64> (LogLevel)

LogLevel represents a logging level

name
required
string

The name of the actuator

principal_uuid
required
string <uuid> = 36 characters

The UUID of the actuator's user account

supported_connector_types
required
Array of strings <uuid> [ items <uuid > ]

The UUIDs of the connector types supported by this actuator

Responses

Request samples

Content type
application/json
{
  • "api_poll_rate": 0,
  • "config": {
    },
  • "config_schema": {
    },
  • "description": "string",
  • "heartbeat_rate": 0,
  • "log_level": 0,
  • "name": "string",
  • "principal_uuid": "4ba1b4e6-6a6c-469d-ad6f-12794b94efd0",
  • "supported_connector_types": [
    ]
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

GetActuator

Gets specified actuator

Authorizations:
api_key
path Parameters
actuatorId
required
string

The id of the actuator

Responses

Response samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "api_poll_rate": 0,
  • "config": {
    },
  • "config_schema": {
    },
  • "connectors": [
    ],
  • "description": "string",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "heartbeat": "2019-08-24T14:15:22Z",
  • "heartbeat_rate": 0,
  • "log_level": 0,
  • "name": "string",
  • "principal_uuid": "4ba1b4e6-6a6c-469d-ad6f-12794b94efd0",
  • "status": {
    },
  • "supported_connector_types": [
    ],
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

UpdateActuator

Updates the specified actuator

Authorizations:
api_key
path Parameters
actuatorId
required
string

The id of the actuator to update.

Request Body schema: application/json
required

The updated actuator request.

api_poll_rate
integer <int64> (Duration)

A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.

object (integrationConfig)

IntegrationConfig is the config of an actuator or connector

object (integrationConfigSchema)

IntegrationConfigSchema is the schema for the config of an actuator or connector

description
string

The updated description of the actuator

heartbeat_rate
integer <int64> (Duration)

A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.

log_level
integer <uint64> (LogLevel)

LogLevel represents a logging level

object (integrationStatus)

IntegrationStatus is the status of an actuator or connector

Responses

Request samples

Content type
application/json
{
  • "api_poll_rate": 0,
  • "config": {
    },
  • "config_schema": {
    },
  • "description": "string",
  • "heartbeat_rate": 0,
  • "log_level": 0,
  • "status": {
    }
}

Response samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "api_poll_rate": 0,
  • "config": {
    },
  • "config_schema": {
    },
  • "connectors": [
    ],
  • "description": "string",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "heartbeat": "2019-08-24T14:15:22Z",
  • "heartbeat_rate": 0,
  • "log_level": 0,
  • "name": "string",
  • "principal_uuid": "4ba1b4e6-6a6c-469d-ad6f-12794b94efd0",
  • "status": {
    },
  • "supported_connector_types": [
    ],
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

ActuatorHeartbeat

Sets the actuator's last heartbeat time

Authorizations:
api_key
path Parameters
actuatorId
required
string

The id of the actuator

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

auth

doAuthWithJwt

Creates a session using a JWT from an external source

Authorizations:
api_key
header Parameters
X-Cydarm-Authz
required
string

The external JWT to authenticate with, as a token

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

doAuthWithPassword

Creates a session by using username and password in the request body

Authorizations:
api_key
Request Body schema: application/json
required

The base64 encoded user's credentials

password
required
string

Base64 encoded Password

username
required
string

Base64 encoded Username

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "created": "string",
  • "group_uuids": [
    ],
  • "origin_ip": "string",
  • "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  • "username": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

doAuthRefresh

Refresh session authorization

Authorizations:
api_key
header Parameters
X-Cydarm-Authz
required
string

The Cydarm-derived JWT to refresh, as a token

Responses

Response samples

Content type
application/json
{
  • "created": "string",
  • "group_uuids": [
    ],
  • "origin_ip": "string",
  • "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  • "username": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

getSamlUrl

Gets a URL for SAML authentication

Authorizations:
api_key
query Parameters
redirect
string

A relay state variable to send

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "aclUuid": "304495e4-73ab-4ad7-be5a-5e192e1dd8d6",
  • "authSourceHandle": "string",
  • "authSourceId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "email": "string",
  • "familyName": "string",
  • "givenName": "string",
  • "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
  • "groupUuids": [
    ],
  • "human": true,
  • "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  • "phone": "string",
  • "username": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

doAuthWithSamlCallback

Creates a session based on a SAML assertion of an external IdP

Authorizations:
api_key
Request Body schema: application/x-www-form-urlencoded
RelayState
string

The RelayState returned by the IdP, as provided during the auth call

SAMLResponse
required
string

The IdP's response to the user's authentication attempt

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

endSession

Ends the current session

Authorizations:
api_key
path Parameters
sessionUuid
required
string

The UUID of the session to end

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

getSessionInfo

Gets user information for the current session

Authorizations:
api_key
path Parameters
sessionUuid
required
string

The UUID of the session to retrieve

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "aclUuid": "304495e4-73ab-4ad7-be5a-5e192e1dd8d6",
  • "authSourceHandle": "string",
  • "authSourceId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "email": "string",
  • "familyName": "string",
  • "givenName": "string",
  • "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
  • "groupUuids": [
    ],
  • "human": true,
  • "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  • "phone": "string",
  • "username": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

DeleteTotpConfig

Delete user TOTP information

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to delete TOTP config.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

GetTotpConfig

Gets user TOTP information

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to retrieve TOTP config.

Responses

Response samples

Content type
application/json
{
  • "enrolled": true,
  • "required": true,
  • "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}

InitialiseTotpEnrolment

Initialises a TOTP enrolment, returns the secret and QR code

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to enrol in TOTP.

Responses

Response samples

Content type
application/json
{
  • "qrBytedata": "string",
  • "totpSecret": "string"
}

ValidateTotpEnrolment

Validates an initialised but incomplete TOTP enrolment with the supplied QR code

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to enrol in TOTP.

Request Body schema: application/json
required

The TOTP code.

totpCode
required
string = 6 characters

The TOTP code

Responses

Request samples

Content type
application/json
{
  • "totpCode": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

case-cache

GetCaseCache

Gets a list of cases from the cache

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AddCaseCache

Creates a case cache entry

Authorizations:
api_key
Request Body schema: application/json
required

The case to add

caseUuid
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "caseUuid": "4b81719f-14c0-4a69-972f-fcc7ca1de9bb"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

DeleteCaseCache

Deletes a case from the cache

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to remove.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

case-severity

Gets a list of case severities.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

case-status

Gets a list of case statuses.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

case-tag

Gets a list of case tags.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a case tag.

Authorizations:
api_key
Request Body schema: application/json
required

The case tag to create.

acl
string <uuid>

The UUID of the ACL

deprecated
boolean non-empty

A boolean flag that specifies whether this caseTag is deprecated

description
required
string non-empty

A description for this caseTag

uuid
required
string <uuid> = 36 characters

The UUID of the tag

value
required
string non-empty

The name of the tag

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "deprecated": true,
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Delete a caseTag .

Authorizations:
api_key
path Parameters
tagUuid
required
string

The case tag to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Retrieve case tag with uuid.

Authorizations:
api_key
path Parameters
tagUuid
required
string

The case tag to retrieve.

Responses

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "deprecated": true,
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "value": "string"
}

Updates a case tag item.

Authorizations:
api_key
path Parameters
tagUuid
required
string

The UUID of the case tag to update.

Request Body schema: application/json
required

The case tag to update.

acl
string <uuid>

The UUID of the ACL

deprecated
boolean non-empty

A boolean flag that specifies whether this caseTag is deprecated

description
required
string non-empty

A description for this caseTag

uuid
required
string <uuid> = 36 characters

The UUID of the tag

value
required
string non-empty

The name of the tag

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "deprecated": true,
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "audit": true,
  • "caseuuid": "519d5a33-a250-4f92-902b-f611373d6a2c",
  • "created": "stringstringstringstrings",
  • "creatorusername": "string",
  • "creatoruuid": "ccbafeff-c915-43d6-87d7-522425158a2c",
  • "datalocation": "string",
  • "datalocationtype": "string",
  • "datasize": 0,
  • "datasource": "string",
  • "deleted": true,
  • "edited": true,
  • "editorusername": "string",
  • "editoruuid": "e03292bb-2028-453b-ac58-61c54556974e",
  • "filename": "string",
  • "hidden": true,
  • "lastmodified": "stringstringstringstrings",
  • "location": "string",
  • "mimetype": "string",
  • "parentuuid": "aa1c3a76-8333-4916-8af9-6cefa79a483e",
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0
}

Removes a tag from a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to remove a tag from.

Request Body schema: application/json
required

The case tag to remove.

acl
string <uuid>

The UUID of the ACL

deprecated
boolean non-empty

A boolean flag that specifies whether this caseTag is deprecated

description
required
string non-empty

A description for this caseTag

uuid
required
string <uuid> = 36 characters

The UUID of the tag

value
required
string non-empty

The name of the tag

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "deprecated": true,
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a list of tags for the case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to retrieve tags from.

Request Body schema: application/json
required

The case tag to create.

acl
string <uuid>

The UUID of the ACL

deprecated
boolean non-empty

A boolean flag that specifies whether this caseTag is deprecated

description
required
string non-empty

A description for this caseTag

uuid
required
string <uuid> = 36 characters

The UUID of the tag

value
required
string non-empty

The name of the tag

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "deprecated": true,
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "deprecated": true,
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "value": "string"
}

Adds a tag to a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to add to.

Request Body schema: application/json
required

The case tag to add.

tagValue
required
string non-empty

A description for this caseTag

Responses

Request samples

Content type
application/json
{
  • "tagValue": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "end": true,
  • "name": "string",
  • "next": [
    ],
  • "ord": 0,
  • "start": true,
  • "transitions": {
    }
}

sla

Gets a list of SLAs for a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a list of SLA warnings for a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a list of SLAs.

Authorizations:
api_key
query Parameters
org
string

If set, filter by organisation UUID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateSla

Creates an SLAs

Authorizations:
api_key
Request Body schema: application/json
required

The SLA to create.

aclUuid
required
string <uuid> = 36 characters

The UUID of the ACL for the SLA

applicability
required
string

The applicability, eg. 24x7x365 or business hours only)

completedTime
string

What time this SLA was completed for a case

deprecated
boolean

Whether this SLA is deprecated

endState
required
string

The state at which the SLA is ended

hoursApplicableEnd
required
string

The time at which the SLA is no longer enabled

hoursApplicableStart
required
string

The time from which the SLA is enabled

hoursApplicableTz
required
string

The timezone from which the SLA is enabled

name
string

The Name of this SLA (determined automatically if not provided)

orgUuid
required
string = 36 characters

The organisation for whom this SLA is in force

pauseStateName
string

A state for which the SLA is paused

pausedSince
string

When this SLA was paused for a case

severityPrecedence
required
integer <int64>

The precedence of the severity for the SLA

startState
required
string

The state from which the SLA is enabled

startTime
string

What time this SLA was added to a case

timeLimit
required
string

The time limit associated with this SLA

timeRemaining
string

How much time is left in this SLA for a case

uuid
string = 36 characters

The UUID of the SLA

version
string

The version of this SLA

warningState
string

The most severe warning state on this case, if any

warningTime
string

Distance from SLA breach (negative being after breach)

Responses

Request samples

Content type
application/json
{
  • "aclUuid": "304495e4-73ab-4ad7-be5a-5e192e1dd8d6",
  • "applicability": "string",
  • "completedTime": "string",
  • "deprecated": true,
  • "endState": "string",
  • "hoursApplicableEnd": "string",
  • "hoursApplicableStart": "string",
  • "hoursApplicableTz": "string",
  • "name": "string",
  • "orgUuid": "stringstringstringstringstringstring",
  • "pauseStateName": "string",
  • "pausedSince": "string",
  • "severityPrecedence": 0,
  • "startState": "string",
  • "startTime": "string",
  • "timeLimit": "string",
  • "timeRemaining": "string",
  • "uuid": "stringstringstringstringstringstring",
  • "version": "string",
  • "warningState": "string",
  • "warningTime": "string"
}

Response samples

Content type
application/json
{
  • "aclUuid": "304495e4-73ab-4ad7-be5a-5e192e1dd8d6",
  • "applicability": "string",
  • "completedTime": "string",
  • "deprecated": true,
  • "endState": "string",
  • "hoursApplicableEnd": "string",
  • "hoursApplicableStart": "string",
  • "hoursApplicableTz": "string",
  • "name": "string",
  • "orgUuid": "stringstringstringstringstringstring",
  • "pauseStateName": "string",
  • "pausedSince": "string",
  • "severityPrecedence": 0,
  • "startState": "string",
  • "startTime": "string",
  • "timeLimit": "string",
  • "timeRemaining": "string",
  • "uuid": "stringstringstringstringstringstring",
  • "version": "string",
  • "warningState": "string",
  • "warningTime": "string"
}

Deletes an SLA.

Authorizations:
api_key
path Parameters
slaUuid
required
string

The UUID of the SLA to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

data

Removes a watcher from a case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The case to remove the watcher from.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a list of data object.

Authorizations:
api_key
query Parameters
uuids
string

A relay state variable to send

timezone
string

timezone for the data object

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a data item.

Authorizations:
api_key
path Parameters
dataUuid
required
string

The UUID of the data object to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a data object.

Authorizations:
api_key
path Parameters
dataUuid
required
string

The UUID of the data object to retrieve.

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "bytedata": "string",
  • "created": "stringstringstringstrings",
  • "dataStubUuid": "786a90d4-869a-466c-b093-c7e6179ed30c",
  • "deletable": true,
  • "editable": true,
  • "encryptionkey": "string",
  • "filelastmod": "stringstringstringstrings",
  • "filename": "string",
  • "hidden": true,
  • "manageable": true,
  • "mimetype": "string",
  • "readable": true,
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Adds a reply to a comment.

Authorizations:
api_key
path Parameters
dataUuid
required
string

The UUID of the data object to update.

Request Body schema: application/json
required

The data object to update.

acl
string

The ACL of the data object

bytedata
required
string

The raw bytes comprising the data, encoded in base64

created
required
string = 25 characters

The time the item was created, as an ISO8601 timestamp

dataStubUuid
required
string <uuid> = 36 characters

The UUID of the data stub

deletable
required
boolean

Whether the data is deletable in the current context

editable
required
boolean

Whether the data is editable in the current context

encryptionkey
required
string

The identifier of the encryption key used on this data (if any)

filelastmod
required
string = 25 characters

The time the file was last modified, as an ISO8601 timestamp

filename
string

The file name of the data, if it is a file

hidden
boolean

Is this data item hidden

manageable
required
boolean

Whether the data is manageable in the current context

mimetype
required
string

The MIME type of the data

readable
required
boolean

Whether the data is readable in the current context

significance
required
string

The signficance level of the data item

sigprecedence
required
string

The precedence of the significance of the data item

uuid
required
string <uuid> = 36 characters

The UUID of the data object

Responses

Request samples

Content type
application/json
{
  • "acl": "string",
  • "bytedata": "string",
  • "created": "stringstringstringstrings",
  • "dataStubUuid": "786a90d4-869a-466c-b093-c7e6179ed30c",
  • "deletable": true,
  • "editable": true,
  • "encryptionkey": "string",
  • "filelastmod": "stringstringstringstrings",
  • "filename": "string",
  • "hidden": true,
  • "manageable": true,
  • "mimetype": "string",
  • "readable": true,
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "audit": true,
  • "caseuuid": "519d5a33-a250-4f92-902b-f611373d6a2c",
  • "created": "stringstringstringstrings",
  • "creatorusername": "string",
  • "creatoruuid": "ccbafeff-c915-43d6-87d7-522425158a2c",
  • "datalocation": "string",
  • "datalocationtype": "string",
  • "datasize": 0,
  • "datasource": "string",
  • "deleted": true,
  • "edited": true,
  • "editorusername": "string",
  • "editoruuid": "e03292bb-2028-453b-ac58-61c54556974e",
  • "filename": "string",
  • "hidden": true,
  • "lastmodified": "stringstringstringstrings",
  • "location": "string",
  • "mimetype": "string",
  • "parentuuid": "aa1c3a76-8333-4916-8af9-6cefa79a483e",
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0
}

Updates a data item.

Authorizations:
api_key
path Parameters
dataUuid
required
string

The UUID of the data object to update.

Request Body schema: application/json
required

The data object to update.

acl
string

The ACL of the data object

bytedata
required
string

The raw bytes comprising the data, encoded in base64

created
required
string = 25 characters

The time the item was created, as an ISO8601 timestamp

dataStubUuid
required
string <uuid> = 36 characters

The UUID of the data stub

deletable
required
boolean

Whether the data is deletable in the current context

editable
required
boolean

Whether the data is editable in the current context

encryptionkey
required
string

The identifier of the encryption key used on this data (if any)

filelastmod
required
string = 25 characters

The time the file was last modified, as an ISO8601 timestamp

filename
string

The file name of the data, if it is a file

hidden
boolean

Is this data item hidden

manageable
required
boolean

Whether the data is manageable in the current context

mimetype
required
string

The MIME type of the data

readable
required
boolean

Whether the data is readable in the current context

significance
required
string

The signficance level of the data item

sigprecedence
required
string

The precedence of the significance of the data item

uuid
required
string <uuid> = 36 characters

The UUID of the data object

Responses

Request samples

Content type
application/json
{
  • "acl": "string",
  • "bytedata": "string",
  • "created": "stringstringstringstrings",
  • "dataStubUuid": "786a90d4-869a-466c-b093-c7e6179ed30c",
  • "deletable": true,
  • "editable": true,
  • "encryptionkey": "string",
  • "filelastmod": "stringstringstringstrings",
  • "filename": "string",
  • "hidden": true,
  • "manageable": true,
  • "mimetype": "string",
  • "readable": true,
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "audit": true,
  • "caseuuid": "519d5a33-a250-4f92-902b-f611373d6a2c",
  • "created": "stringstringstringstrings",
  • "creatorusername": "string",
  • "creatoruuid": "ccbafeff-c915-43d6-87d7-522425158a2c",
  • "datalocation": "string",
  • "datalocationtype": "string",
  • "datasize": 0,
  • "datasource": "string",
  • "deleted": true,
  • "edited": true,
  • "editorusername": "string",
  • "editoruuid": "e03292bb-2028-453b-ac58-61c54556974e",
  • "filename": "string",
  • "hidden": true,
  • "lastmodified": "stringstringstringstrings",
  • "location": "string",
  • "mimetype": "string",
  • "parentuuid": "aa1c3a76-8333-4916-8af9-6cefa79a483e",
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": 0
}

Gets a data file for download.

Authorizations:
api_key
path Parameters
dataUuid
required
string

The UUID of the data file object to retrieve.

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "bytedata": "string",
  • "created": "stringstringstringstrings",
  • "dataStubUuid": "786a90d4-869a-466c-b093-c7e6179ed30c",
  • "deletable": true,
  • "editable": true,
  • "encryptionkey": "string",
  • "filelastmod": "stringstringstringstrings",
  • "filename": "string",
  • "hidden": true,
  • "manageable": true,
  • "mimetype": "string",
  • "readable": true,
  • "significance": "string",
  • "sigprecedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

connector

GetConnectors

Gets all connectors

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateConnector

Creates a connector

Authorizations:
api_key
Request Body schema: application/json
required

The connector to create.

active
required
boolean

Whether the connector is currently active

actuator_uuid
required
string <uuid>

The UUID of the actuator that this connector is running on

object (integrationConfig)

IntegrationConfig is the config of an actuator or connector

connector_type_uuid
required
string <uuid>

The UUID of the connector type

description
string

The description of the connector

name
required
string

The name of the connector

Array of objects (ConnectorEventTriggerRequest)

The triggers for this connector

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "actuator_uuid": "259a3551-53e0-4d46-ae8d-94f80461ae71",
  • "config": {
    },
  • "connector_type_uuid": "58051f02-f922-40a7-84d8-4539329e6c8a",
  • "description": "string",
  • "name": "string",
  • "triggers": [
    ]
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

GetConnectorTypes

Gets all connector types

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PostConnectorType

Creates a connector type

Authorizations:
api_key
Request Body schema: application/json
required

The connector type to create

acl_uuid
string <uuid>
object (integrationConfigSchema)

IntegrationConfigSchema is the schema for the config of an actuator or connector

description
string
display_name
string
name
string
supported_operations
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "config_schema": {
    },
  • "description": "string",
  • "display_name": "string",
  • "name": "string",
  • "supported_operations": [
    ]
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

GetConnectorType

Gets the specified connector type

Authorizations:
api_key
path Parameters
connectorTypeId
required
string

The id of the actuator type

Responses

Response samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "config_schema": {
    },
  • "description": "string",
  • "display_name": "string",
  • "name": "string",
  • "supported_operations": [
    ],
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

DeleteConnector

Deletes the specified connector

Authorizations:
api_key
path Parameters
connectorId
required
string

The id of the connector to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

GetConnector

Gets specified connector

Authorizations:
api_key
path Parameters
connectorId
required
string

The id of the connector

Responses

Response samples

Content type
application/json
{
  • "acl_uuid": "8f40421d-2a72-42df-816f-bd63691903ff",
  • "active": true,
  • "actuator_uuid": "259a3551-53e0-4d46-ae8d-94f80461ae71",
  • "config": {
    },
  • "connector_type_uuid": "58051f02-f922-40a7-84d8-4539329e6c8a",
  • "description": "string",
  • "name": "string",
  • "status": {
    },
  • "triggers": {
    },
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

UpdateConnector

Updates the specified connector

Authorizations:
api_key
path Parameters
connectorId
required
string

The id of the connector to update.

Request Body schema: application/json
required

The update connector request.

active
boolean

Whether the connector is active

object (integrationConfig)

IntegrationConfig is the config of an actuator or connector

description
string

The updated description

object (integrationStatus)

IntegrationStatus is the status of an actuator or connector

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "config": {
    },
  • "description": "string",
  • "status": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

connector-type

UpdateConnectorType

Updates the specified connector

Authorizations:
api_key
path Parameters
connectorTypeId
required
string

The id of the actuator type to update.

Request Body schema: application/json
required

The updated connector request.

object (integrationConfigSchema)

IntegrationConfigSchema is the schema for the config of an actuator or connector

description
string
display_name
string
supported_operations
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "config_schema": {
    },
  • "description": "string",
  • "display_name": "string",
  • "supported_operations": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

form

Gets a list of forms.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a form.

Authorizations:
api_key
Request Body schema: application/json
required

The form to create.

acl
string <uuid>

The ACL of the data object

deleted
boolean

Whether the form has been deleted

fields
required
string

The fields that comprise this form, as a base64 encoded JSON array

name
required
string non-empty

The display name of the form

precedence
required
integer <int64>

The order in which this form should be displayed

uuid
required
string <uuid> = 36 characters

The UUID of the form

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "deleted": true,
  • "fields": "string",
  • "name": "string",
  • "precedence": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Delete a form.

Authorizations:
api_key
path Parameters
formUuid
required
string

The UUID of the form to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Updates a form.

Authorizations:
api_key
path Parameters
formUuid
required
string

The UUID of the form to update.

Request Body schema: application/json
required

The form to be updated.

acl
string <uuid>

The ACL of the data object

deleted
boolean

Whether the form has been deleted

fields
required
string

The fields that comprise this form, as a base64 encoded JSON array

name
required
string non-empty

The display name of the form

precedence
required
integer <int64>

The order in which this form should be displayed

uuid
required
string <uuid> = 36 characters

The UUID of the form

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "deleted": true,
  • "fields": "string",
  • "name": "string",
  • "precedence": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

group

Gets a list of groups.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a group.

Authorizations:
api_key
Request Body schema: application/json
required

The group to create.

acl
required
string <uuid> = 36 characters

The group's ACL

category_mode
string

The mode of the group's category, either inclusive or exclusive

category_name
string

The name of the group's category

category_uuid
string <uuid> = 36 characters

The UUID of the group's category

created
required
string <date-time>

The time the group was created, as an ISO8601 timestamp

description
string non-empty

The name of the group

members
Array of strings <uuid> [ items <uuid > ]

The groups member users

name
required
string non-empty

The name of the group

parents
Array of strings <uuid> [ items <uuid > ]

The group's parent groups which it inherits from

public_key
Array of integers <uint8> [ items <uint8 > ]

The group's public key

uuid
required
string <uuid> = 36 characters

The UUID of the group

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "category_mode": "string",
  • "category_name": "string",
  • "category_uuid": "d5e0e6e9-d809-4adf-9920-3a698629ce74",
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "parents": [
    ],
  • "public_key": [
    ],
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Gets the group graph.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "group_graph": {
    }
}

Gets the group members of a group.

Authorizations:
api_key
path Parameters
groupUuid
required
string

The UUID of the group to retrieve

Responses

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "category_mode": "string",
  • "category_name": "string",
  • "category_uuid": "d5e0e6e9-d809-4adf-9920-3a698629ce74",
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "parents": [
    ],
  • "public_key": [
    ],
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Removes a group from a group.

Authorizations:
api_key
path Parameters
groupUuid
required
string

The UUID of the group to modify.

memberGroupUuid
required
string

The UUID of the group to remove.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Adds a group to another group.

Authorizations:
api_key
path Parameters
groupUuid
required
string

The group to modify.

memberGroupUuid
required
string

The UUID of the group to add.

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Gets the user members of a group.

Authorizations:
api_key
path Parameters
groupUuid
required
string

The UUID of the group to retrieve.

query Parameters
recursive
boolean
Default: false

Whether to retrieve member users of member groups.

Responses

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "category_mode": "string",
  • "category_name": "string",
  • "category_uuid": "d5e0e6e9-d809-4adf-9920-3a698629ce74",
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "members": [
    ],
  • "name": "string",
  • "parents": [
    ],
  • "public_key": [
    ],
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Removes a user from a group.

Authorizations:
api_key
path Parameters
groupUuid
required
string

The UUID of the group to modify.

memberUserUuid
required
string

The UUID of the user to remove.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Add a user to a group.

Authorizations:
api_key
path Parameters
groupUuid
required
string

The group to modify.

memberUserUuid
required
string

The UUID of the user to add.

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

meta

Gets a list of metadata fields.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a metadata field definition.

Authorizations:
api_key
Request Body schema: application/json
required

The metadata field to create.

acl
string

The UUID or name of the ACL

match
string

A regex to validate values of this field

name
required
string non-empty

The name of field

precedence
required
string

The precedence of this field (defines the order of appearance)

uuid
string <uuid> = 36 characters

The UUID of the metadata field

Responses

Request samples

Content type
application/json
{
  • "acl": "string",
  • "match": "string",
  • "name": "string",
  • "precedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Deletes a metadata item.

Authorizations:
api_key
path Parameters
metaUuid
required
string

The UUID of the metadata to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Updates a metadata item.

Authorizations:
api_key
path Parameters
metaUuid
required
string

The UUID of the metadata to delete.

Request Body schema: application/json
required

The updated metadata field.

acl
string

The UUID or name of the ACL

match
string

A regex to validate values of this field

name
required
string non-empty

The name of field

precedence
required
string

The precedence of this field (defines the order of appearance)

uuid
string <uuid> = 36 characters

The UUID of the metadata field

Responses

Request samples

Content type
application/json
{
  • "acl": "string",
  • "match": "string",
  • "name": "string",
  • "precedence": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

metrics

GetMetricsCases

Gets a metrics report on cases. (This endpoint is currently disabled)

Authorizations:
api_key
query Parameters
start
required
string

The start time as an RFC3339 timestamp

end
required
string

The end time as an RFC3339 timestamp

Responses

Response samples

Content type
application/json
{
  • "totalClosedCases": 0,
  • "totalNewCases": 0
}

Gets a metrics report on cases opened versus closed.

Authorizations:
api_key
query Parameters
startPeriod
required
string

The start time as an RFC3339 timestamp

endPeriod
required
string

The end time as an RFC3339 timestamp

orgs
string

The org to filter with

Responses

Response samples

Content type
application/json
{
  • "totalClosedCases": 0,
  • "totalNewCases": 0
}

Gets a metrics report on case status timing.

Authorizations:
api_key
query Parameters
startPeriod
required
string

The start time as an RFC3339 timestamp

endPeriod
required
string

The end time as an RFC3339 timestamp

orgs
required
Array of strings

filter to which have these organisations

Responses

Response samples

Content type
application/json
{
  • "endPeriod": "stringstringstringstrings",
  • "precedence": {
    },
  • "startPeriod": "stringstringstringstrings",
  • "times": {
    },
  • "totalClosedCases": 0,
  • "totalNewCases": 0
}

GetMetricsUsers

Gets a metrics report on users. (This endpoint is currently disabled)

Authorizations:
api_key
Request Body schema: application/json
required
end
string <date-time>
start
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "end": "2019-08-24T14:15:22Z",
  • "start": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "endPeriod": "stringstringstringstrings",
  • "precedence": {
    },
  • "startPeriod": "stringstringstringstrings",
  • "times": {
    },
  • "totalClosedCases": 0,
  • "totalNewCases": 0
}

report

Generates a report for time taken for cases to arrive at a given state.

Authorizations:
api_key
Request Body schema: application/json
required
end_state
required
string

State to measure to

filter_tags
Array of strings

Filter to cases which have these tags

include_end_state
required
boolean

Include time spend in target state

include_start_state
boolean

Include time spent in starting state

orgs
Array of strings <uuid> [ items <uuid > ]

Filter to which have these organisation

required
object (JSONTime)
required
object (JSONTime)
start_state
string

State to measure from

time_increment
required
string
Enum: "daily" "weekly" "monthly" "quarterly" "semi-annually" "annually"

Reporting increment

timezone
required
string

The timezone of the request datetime information

Responses

Request samples

Content type
application/json
{
  • "end_state": "string",
  • "filter_tags": [
    ],
  • "include_end_state": true,
  • "include_start_state": true,
  • "orgs": [
    ],
  • "period_end": {
    },
  • "period_start": {
    },
  • "start_state": "string",
  • "time_increment": "daily",
  • "timezone": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

NOTE: THIS REPORT TYPE IS CURRENTLY DEACTIVATED AND ALL REQUESTS WILL RECEIVE A RESPONSE OF 503 - SERVICE UNAVAILABLE

Generates an analyst report for given users, over a time period.

Authorizations:
api_key
Request Body schema: application/json
required
tags
Array of strings

The names of tags to be included in the report.

endTime
required
string

The end time of the report.

format
string

The format of the report.

org
required
string <uuid>

The org uuid for the report to be generated for.

startTime
required
string

The start time of the report.

states
Array of strings

The case states to be included in the report.

userNames
required
Array of strings

The names of users to be included in the report.

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "endTime": "string",
  • "format": "string",
  • "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  • "startTime": "string",
  • "states": [
    ],
  • "userNames": [
    ]
}

Response samples

Content type
application/json
{
  • "tags": "string",
  • "acl": "string",
  • "closed": "string",
  • "description": "string",
  • "locator": "string",
  • "opened": "string",
  • "organisation": "string",
  • "severity": "string",
  • "status": "string",
  • "uuid": "stringstringstringstringstringstring"
}

Generates a report for a given case.

Authorizations:
api_key
path Parameters
caseUuid
required
string

The UUID of the case to generate a report for.

Request Body schema: application/json
required
aclReadList
Array of strings

The ACL read list for the report to include.

endTime
required
integer <int64>

The end time of the report.

format
string

The format of the report.

significances
Array of strings

The significances for the report to include.

startTime
required
integer <int64>

The start time of the report.

timezone
required
string

The timezone of the report.

Responses

Request samples

Content type
application/json
{
  • "aclReadList": [
    ],
  • "endTime": 0,
  • "format": "string",
  • "significances": [
    ],
  • "startTime": 0,
  • "timezone": "string"
}

Response samples

Content type
application/json
{
  • "tags": "string",
  • "acl": "string",
  • "closed": "string",
  • "description": "string",
  • "locator": "string",
  • "opened": "string",
  • "organisation": "string",
  • "severity": "string",
  • "status": "string",
  • "uuid": "stringstringstringstringstringstring"
}

Generates a summary of current groups.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Generates an heatmap report for given tag frequencies together on a case, over a time period.

Authorizations:
api_key
Request Body schema: application/json
required
endTime
required
string

The end time of the report.

format
string

The format of the report.

org
required
string <uuid>

The org uuid for the report to be generated for.

startTime
required
string

The start time of the report.

timezone
required
string

The timezone of the report.

xTagPrefixes
required
Array of strings

The names of x axis tags to be included in the report.

yTagPrefixes
required
Array of strings

The names of y axis tags to be included in the report.

Responses

Request samples

Content type
application/json
{
  • "endTime": "string",
  • "format": "string",
  • "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  • "startTime": "string",
  • "timezone": "string",
  • "xTagPrefixes": [
    ],
  • "yTagPrefixes": [
    ]
}

Response samples

Content type
application/json
{
  • "endTime": "string",
  • "format": "string",
  • "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  • "startTime": "string",
  • "timezone": "string",
  • "xTagPrefixes": [
    ],
  • "yTagPrefixes": [
    ]
}

Generates an MTTX report for given users and additional parameters, over a time period.

Authorizations:
api_key
Request Body schema: application/json
required
endTime
required
integer <int64>

The end time of the report.

excludeTags
Array of strings

The names of tags to be excluded in the report.

format
string

The format of the report.

includeTags
Array of strings

The names of tags to be included in the report.

org
required
string <uuid>

The organisation.

severities
Array of strings

The case severities to be included in the report.

startTime
required
integer <int64>

The start time of the report.

userNames
Array of strings

The names of users to be included in the report.

Responses

Request samples

Content type
application/json
{
  • "endTime": 0,
  • "excludeTags": [
    ],
  • "format": "string",
  • "includeTags": [
    ],
  • "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  • "severities": [
    ],
  • "startTime": 0,
  • "userNames": [
    ]
}

Response samples

Content type
application/json
{
  • "tags": "string",
  • "acl": "string",
  • "closed": "string",
  • "description": "string",
  • "locator": "string",
  • "opened": "string",
  • "organisation": "string",
  • "severity": "string",
  • "status": "string",
  • "uuid": "stringstringstringstringstringstring"
}

Generates a summary report for a given organisation, over a time period.

Authorizations:
api_key
Request Body schema: application/json
required
endTime
required
integer <int64>

The end time of the report.

format
string

The format of the report.

orgUuidList
required
Array of strings <uuid> [ items <uuid > ]

The org uuid list for the report to be generated for.

startTime
required
integer <int64>

The start time of the report.

timezone
required
string

The timezone of the report.

Responses

Request samples

Content type
application/json
{
  • "endTime": 0,
  • "format": "string",
  • "orgUuidList": [
    ],
  • "startTime": 0,
  • "timezone": "string"
}

Response samples

Content type
{
  • "tags": "string",
  • "acl": "string",
  • "closed": "string",
  • "description": "string",
  • "locator": "string",
  • "opened": "string",
  • "organisation": "string",
  • "severity": "string",
  • "status": "string",
  • "uuid": "stringstringstringstringstringstring"
}

Generates a summary of current user accounts.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

notify

Sends a notification to a third-party service.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to notify of payload.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

GetErrorMessages

Gets all error messages for the supplied consumer

Authorizations:
api_key
path Parameters
service
required
string

The name of the consumer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PostErrorMessage

Posts an error message for the specified consumer

Authorizations:
api_key
path Parameters
service
required
string

The name of the service which has reported an error

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

DeleteErrorMessage

Deletes the error msg for the specified consumer

Authorizations:
api_key
path Parameters
service
required
string

The name of the consumer

msgUuid
required
string <uuid>

The UUID of the error msg to be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

GetMessages

Gets all messages for the supplied consumer

Authorizations:
api_key
path Parameters
service
required
string

The name of the consumer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DeleteMessage

Deletes the msg for the specified consumer

Authorizations:
api_key
path Parameters
service
required
string

The name of the consumer

msgUuid
required
string <uuid>

The UUID of the msg to be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

org

Gets a list of orgs.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an org.

Authorizations:
api_key
Request Body schema: application/json
required

The org to create.

acl
required
string <uuid> = 36 characters

The UUID of the ACL of the org

groupUuid
required
string <uuid> = 36 characters

The UUID of the group linked to the org

name
required
string non-empty

The name of the org

uuid
required
string <uuid> = 36 characters

The UUID of the org

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
  • "name": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Deletes an org.

Authorizations:
api_key
path Parameters
orgUuid
required
string

The org to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets an org.

Authorizations:
api_key
path Parameters
orgUuid
required
string

The UUID of the org to retrieve.

Responses

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
  • "name": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Updates an org.

Authorizations:
api_key
path Parameters
orgUuid
required
string

The UUID of the org to update.

Request Body schema: application/json
required

The org body to update with.

acl
required
string <uuid> = 36 characters

The UUID of the ACL of the org

groupUuid
required
string <uuid> = 36 characters

The UUID of the group linked to the org

name
required
string non-empty

The name of the org

uuid
required
string <uuid> = 36 characters

The UUID of the org

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
  • "name": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

org-prop

Gets a list of org properties.

Authorizations:
api_key
path Parameters
orgUuid
required
string

The UUID of the org whose properties are being retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes an org property.

Authorizations:
api_key
path Parameters
orgUuid
required
string

The UUID of the org whose property is being deleted.

propName
required
string

The name of the property to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets an org property.

Authorizations:
api_key
path Parameters
orgUuid
required
string

The UUID of the org whose property is being retrieved.

propName
required
string

The name of the property to retrieve.

Responses

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "encryptionKey": {
    },
  • "name": "string",
  • "orgUuid": "62c7d8f0-170d-4f52-bd12-155ee2cbe31e",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "value": [
    ]
}

Creates an org property,

Authorizations:
api_key
path Parameters
orgUuid
required
string

The UUID of the org whose property is being created.

propName
required
string

The name of the property to create.

Request Body schema: application/json
required

The org property to create.

acl
string = 36 characters

The name/UUID of this property's ACL

encrypt
boolean

Whether or not to encrypt the value

name
required
string

The name of the property

value
required
Array of integers <uint8> [ items <uint8 > ]

The value of the property

Responses

Request samples

Content type
application/json
{
  • "acl": "stringstringstringstringstringstring",
  • "encrypt": true,
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Updates an org property.

Authorizations:
api_key
path Parameters
orgUuid
required
string

The UUID of the org whose property is being updated.

propName
required
string

The name of the property to update.

Request Body schema: application/json
required

The updated org property.

acl
string = 36 characters

The new name/UUID of this property's ACL

name
string

The new name of the property

value
Array of integers <uint8> [ items <uint8 > ]

The new value of the property

Responses

Request samples

Content type
application/json
{
  • "acl": "stringstringstringstringstringstring",
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

playbook

Gets a list of playbooks.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a playbook.

Authorizations:
api_key
Request Body schema: application/json
required

The playbook to create.

object (atcPlaybook)

AtcPlaybook is a sequence of actions used in incident response

object (cacaoPlaybookRequest)

CacaoPlaybookRequest is a request to create or update a CACAO playbook

Responses

Request samples

Content type
application/json
{
  • "atc": {
    },
  • "cacao": {
    }
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Creates a playbook by upload file.

Authorizations:
api_key
Request Body schema: application/json
required

The playbook file content to create.

tags
required
Array of strings

The tags associated with the playbook

acl
string <uuid> = 36 characters

The UUID of the ACL of the playbook

required
Array of objects (atcAction)

The actions included in the playbook

created
string = 25 characters

The time the playbook was created, as an ISO8601 timestamp

deleted
boolean = 25 characters

The time the playbook was deleted, as an ISO8601 timestamp

description
string

A description for the playbook

modified
string = 25 characters

The time the playbook was last modified, as an ISO8601 timestamp

name
required
string non-empty

The name of the playbook

uuid
required
string <uuid> = 36 characters

The UUID of the playbook

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "actions": [
    ],
  • "created": "stringstringstringstrings",
  • "deleted": true,
  • "description": "string",
  • "modified": "stringstringstringstrings",
  • "name": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Exporting a playbook to file.

Authorizations:
api_key
path Parameters
playbookUuid
required
string

The uuid of playbook to export.

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Deletes a playbook.

Authorizations:
api_key
path Parameters
playbookUuid
required
string

The UUID of the playbook to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a playbook.

Authorizations:
api_key
path Parameters
playbookUuid
required
string

The UUID of the playbook to retrieve

Responses

Response samples

Content type
application/json
{
  • "atc": {
    },
  • "cacao": {
    }
}

Duplicate a playbook.

Authorizations:
api_key
path Parameters
playbookUuid
required
string

The UUID of the playbook to duplicate.

Responses

Response samples

Content type
application/json
{
  • "atc": {
    },
  • "cacao": {
    }
}

Updates a playbook.

Authorizations:
api_key
path Parameters
playbookUuid
required
string

The UUID of the playbook to update.

Request Body schema: application/json
required

The updated playbook

object (atcPlaybook)

AtcPlaybook is a sequence of actions used in incident response

object (cacaoPlaybookRequest)

CacaoPlaybookRequest is a request to create or update a CACAO playbook

Responses

Request samples

Content type
application/json
{
  • "atc": {
    },
  • "cacao": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Removes a tag from a playbook.

Authorizations:
api_key
path Parameters
playbookUuid
required
string

The playbook to remove from.

caseTagUuid
required
string

The tag to remove.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Adds a tag to a playbook.

Authorizations:
api_key
path Parameters
playbookUuid
required
string

The playbook to add to.

caseTagUuid
required
string

The tag to add.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Removes an action from a playbook.

Authorizations:
api_key
path Parameters
playbookUuid
required
string

The playbook to remove from.

playbookActionUuid
required
string

The playbook action to remove.

query Parameters
position
string

The position to remove the playbook action from.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Adds an action to a playbook.

Authorizations:
api_key
path Parameters
playbookUuid
required
string

The playbook to add to.

playbookActionUuid
required
string

The playbook action to add.

Request Body schema: application/json
required

The control flow details for the acton in the playbook

object (AtcControlFlowReques is a request to add an ATC action to a playbook with the specified control flow.)
object (CacaoControlFlowRequest is a request to add a CACAO action to a playbook with the specified control flow.)

Responses

Request samples

Content type
application/json
{
  • "atc": {
    },
  • "cacao": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

playbook-action

Gets a list of playbook actions.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a playbook action.

Authorizations:
api_key
Request Body schema: application/json
required

The action to add to the playbook.

object (atcAction)

AtcAction is an action used in ATC playbooks

object (cacaoActionRequest)

CacaoActionRequest is a request to create or update a CACAO action

Responses

Request samples

Content type
application/json
{
  • "atc": {
    },
  • "cacao": {
    }
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Deletes a playbook action.

Authorizations:
api_key
path Parameters
uuid
required
string

The UUID of the playbook action to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a playbook action.

Authorizations:
api_key
path Parameters
uuid
required
string

The UUID of the playbook action to retrieve.

Responses

Response samples

Content type
application/json
{
  • "atc": {
    },
  • "cacao": {
    }
}

Updates a playbook action.

Authorizations:
api_key
path Parameters
uuid
required
string

The UUID of the playbook action to update.

Request Body schema: application/json
required

The playbook action to be updated.

object (atcAction)

AtcAction is an action used in ATC playbooks

object (cacaoActionRequest)

CacaoActionRequest is a request to create or update a CACAO action

Responses

Request samples

Content type
application/json
{
  • "atc": {
    },
  • "cacao": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Deletes a playbook action tag map.

Authorizations:
api_key
path Parameters
uuid
required
string

The UUID of the playbook action to delete.

tagUuid
required
string

The UUID of the tag to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Create a playbook action tag map.

Authorizations:
api_key
path Parameters
uuid
required
string

The UUID of the playbook action to create.

tagUuid
required
string

The UUID of the tag to create.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

other

Gets a list of resources.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

UpdateResource

Updates a resource

Authorizations:
api_key
path Parameters
resourceUuid
required
string

The UUID of the resource to update

Request Body schema: application/json
required

The resource body to update with.

Acl
string <uuid>
Array of objects (Trigger)
description
string
resource
string
uuid
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "Acl": "b5ae0d5f-ecdb-4462-ae7e-577433dbb8e5",
  • "Triggers": [
    ],
  • "description": "string",
  • "resource": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

stix

Get a list of Assets.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "data": {
    },
  • "deletable": true,
  • "editable": true,
  • "manageable": true,
  • "readable": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Creates a asset in STIX.

Authorizations:
api_key
Request Body schema: application/json
required

The asset to create.

acl
string <uuid>

The ACL of the data object

description
string

Description of asset

infrastructureTypes
required
Array of strings

The infrastructure_type labels on this asset, eg. server, database, s3-bucket

ipAddresses
Array of strings

list of IPv4 or IPv6 addresses used by this asset

location
string

Location of asset, eg. datacentre, cloud tenancy

name
required
string

Name of asset

orgUuid
string <uuid>

UUID of organisation from cy_org

organisation
string

Organisation the asset belongs to

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "description": "string",
  • "infrastructureTypes": [
    ],
  • "ipAddresses": [
    ],
  • "location": "string",
  • "name": "string",
  • "orgUuid": "62c7d8f0-170d-4f52-bd12-155ee2cbe31e",
  • "organisation": "string"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Creates assets in STIX.

CSV requires a header row in the following order: Type, Name, Email, Phone, Organisation

Authorizations:
api_key
Request Body schema:
required

CSV file with a list of assets to create.

string <binary>

CSV file with a list of assets to create.

Responses

Request samples

Content type
"string"

Response samples

Content type
application/json
{
  • "failedRequests": [
    ],
  • "noSuccessfullyLoaded": 0
}

Deletes a asset.

Authorizations:
api_key
path Parameters
assetUuid
required
string

The UUID of the asset object to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Update an asset.

Authorizations:
api_key
path Parameters
uuid
required
string

The UUID of the asset object to update.

Request Body schema: application/json
required

The asset request

acl
string <uuid>

The ACL of the data object

description
string

Description of asset

infrastructureTypes
required
Array of strings

The infrastructure_type labels on this asset, eg. server, database, s3-bucket

ipAddresses
Array of strings

list of IPv4 or IPv6 addresses used by this asset

location
string

Location of asset, eg. datacentre, cloud tenancy

name
required
string

Name of asset

orgUuid
string <uuid>

UUID of organisation from cy_org

organisation
string

Organisation the asset belongs to

userUuid
string <uuid>

UUID of user requesting update

uuid
required
string <uuid>

The UUID of this asset

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "description": "string",
  • "infrastructureTypes": [
    ],
  • "ipAddresses": [
    ],
  • "location": "string",
  • "name": "string",
  • "orgUuid": "62c7d8f0-170d-4f52-bd12-155ee2cbe31e",
  • "organisation": "string",
  • "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Get a list of Contacts.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "data": {
    },
  • "deletable": true,
  • "editable": true,
  • "manageable": true,
  • "readable": true,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Creates a contact in STIX.

Authorizations:
api_key
Request Body schema: application/json
required

The contact to create.

acl
string <uuid>

The ACL of the data object

contactType
required
string

The contact type of this contact

email
Array of strings

List of email addresses for contact

name
required
string

First name of contact

orgUuid
string <uuid>

UUID of organisation from cy_org

organisation
string

Organisation the contact is from

phone
Array of strings

list of phone numbers for contact

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "contactType": "string",
  • "email": [
    ],
  • "name": "string",
  • "orgUuid": "62c7d8f0-170d-4f52-bd12-155ee2cbe31e",
  • "organisation": "string",
  • "phone": [
    ]
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Creates contacts in STIX.

CSV requires a header row in the following order: Type, Name, Email, Phone, Organisation

Authorizations:
api_key
Request Body schema:
required

CSV file with a list of contacts to create.

string <binary>

CSV file with a list of contacts to create.

Responses

Request samples

Content type
"string"

Response samples

Content type
application/json
{
  • "failedRequests": [
    ],
  • "noSuccessfullyLoaded": 0
}

Deletes a contact.

Authorizations:
api_key
path Parameters
contactUuid
required
string

The UUID of the contact object to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Update a contact.

Authorizations:
api_key
path Parameters
contactUuid
required
string

The UUID of the contact object to update.

Request Body schema: application/json
required

The contact request

acl
string <uuid>

The ACL of the data object

email
Array of strings

List of email addresses for contact

name
string

First name of contact

orgUuid
string <uuid>

UUID of organisation from cy_org

organisation
string

Organisation the contact is from

phone
Array of strings

list of phone numbers for contact

userUuid
string <uuid>

UUID of user requesting update

uuid
required
string <uuid>

The UUID of this contact

Responses

Request samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "email": [
    ],
  • "name": "string",
  • "orgUuid": "62c7d8f0-170d-4f52-bd12-155ee2cbe31e",
  • "organisation": "string",
  • "phone": [
    ],
  • "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Updates a STIX node.

Authorizations:
api_key
path Parameters
id
required
string

The UUID of the STIX to be updated.

Request Body schema: application/json
required

The updated STIX object.

Acl
string <uuid> = 36 characters

The UUID of the new ACL

UserUuid
string <uuid> = 36 characters

The UUID of the User

Uuid
required
string <uuid> = 36 characters

The UUID of the STIX node to be updated

Value
string

The new value of the STIX item

Responses

Request samples

Content type
application/json
{
  • "Acl": "b5ae0d5f-ecdb-4462-ae7e-577433dbb8e5",
  • "UserUuid": "01c61da3-9fc5-47b7-9228-1bdd8cc74793",
  • "Uuid": "f3131686-c052-4b3a-8d25-90d96e4d2c56",
  • "Value": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

sys-prop

Gets a list of system properties.

Authorizations:
api_key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a system property.

Authorizations:
api_key
Request Body schema: application/json
required

The system property to create.

acl
string = 36 characters

The name/UUID of this property's ACL

encrypt
boolean

Whether or not to encrypt the value

name
required
string

The name of the property

value
required
Array of integers <uint8> [ items <uint8 > ]

The value of the property

Responses

Request samples

Content type
application/json
{
  • "acl": "stringstringstringstringstringstring",
  • "encrypt": true,
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Deletes a system property.

Authorizations:
api_key
path Parameters
sysPropUuid
required
string

The UUID of the system property to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a system property.

Authorizations:
api_key
path Parameters
sysPropUuid
required
string

The UUID of the system property to retrieve.

Responses

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "encryptionKey": {
    },
  • "name": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "value": [
    ]
}

Updates a system property.

Authorizations:
api_key
path Parameters
sysPropUuid
required
string

The UUID of the system property to update.

Request Body schema: application/json
required

The system property to update.

acl
string = 36 characters

The new name/UUID of this property's ACL

name
string

The new name of the property

value
Array of integers <uint8> [ items <uint8 > ]

The new value of the property

Responses

Request samples

Content type
application/json
{
  • "acl": "stringstringstringstringstringstring",
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

third

Fetches cache for third party integration cache.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to fetch cache for.

Responses

Response samples

Content type
application/json
{
  • "service_cache": [
    ],
  • "service_details": {
    }
}

Fetches cache for third party integration cache.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to create.

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Updates details of integrated service.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to fetch cache for.

Request Body schema: application/json

The details to update (only last_sync can be updated).

object (JSONTime)
service
required
string [ 3 .. 30 ] characters

The third party service's name

uuid
string <uuid> = 36 characters

The third party service's internal UUID

Responses

Request samples

Content type
application/json
{
  • "last_sync": {
    },
  • "service": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Creates a new cache item for third party integration.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to fetch cache for.

Request Body schema: application/json

The details of the cache to create.

checksum
required
string

The item's latest SHA256 checksum

external
boolean

Whether the item is from an external source

foreign_id
required
string

The cached item's foreign id

foreign_table
required
string

The cached item's foreign table/endpoint

local_case_uuid
required
string <uuid>

The cached item's local case uuid mapping

local_table
required
string

The cached item's local table mapping

local_uuid
string <uuid>

The cached item's local uuid mapping

org_name
string

Cache item case's organisation name

object (JSONTime)
uuid
string <uuid> = 36 characters

The cached item's UUID

Responses

Request samples

Content type
application/json
{
  • "checksum": "string",
  • "external": true,
  • "foreign_id": "string",
  • "foreign_table": "string",
  • "local_case_uuid": "4fd25a2e-1950-409b-8c48-7a87e2e7ece3",
  • "local_table": "string",
  • "local_uuid": "16750b99-0885-4ae2-9edf-192825c23170",
  • "org_name": "string",
  • "updated": {
    },
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Deletes an item from the third party cache.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to update item on.

itemUuid
required
string

The name of the service to fetch cache for.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Updates a cache item for a third party integration cache.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to update item on.

itemUuid
required
string

The UUID of the item to update.

Request Body schema: application/json

The details to update (only checksum can be updated).

checksum
required
string

The item's latest SHA256 checksum

external
boolean

Whether the item is from an external source

foreign_id
required
string

The cached item's foreign id

foreign_table
required
string

The cached item's foreign table/endpoint

local_case_uuid
required
string <uuid>

The cached item's local case uuid mapping

local_table
required
string

The cached item's local table mapping

local_uuid
string <uuid>

The cached item's local uuid mapping

org_name
string

Cache item case's organisation name

object (JSONTime)
uuid
string <uuid> = 36 characters

The cached item's UUID

Responses

Request samples

Content type
application/json
{
  • "checksum": "string",
  • "external": true,
  • "foreign_id": "string",
  • "foreign_table": "string",
  • "local_case_uuid": "4fd25a2e-1950-409b-8c48-7a87e2e7ece3",
  • "local_table": "string",
  • "local_uuid": "16750b99-0885-4ae2-9edf-192825c23170",
  • "org_name": "string",
  • "updated": {
    },
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

party

Fetches cache for third party integration cache.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to fetch cache for.

Responses

Response samples

Content type
application/json
{
  • "service_cache": [
    ],
  • "service_details": {
    }
}

Fetches cache for third party integration cache.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to create.

Responses

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Updates details of integrated service.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to fetch cache for.

Request Body schema: application/json

The details to update (only last_sync can be updated).

object (JSONTime)
service
required
string [ 3 .. 30 ] characters

The third party service's name

uuid
string <uuid> = 36 characters

The third party service's internal UUID

Responses

Request samples

Content type
application/json
{
  • "last_sync": {
    },
  • "service": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Creates a new cache item for third party integration.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to fetch cache for.

Request Body schema: application/json

The details of the cache to create.

checksum
required
string

The item's latest SHA256 checksum

external
boolean

Whether the item is from an external source

foreign_id
required
string

The cached item's foreign id

foreign_table
required
string

The cached item's foreign table/endpoint

local_case_uuid
required
string <uuid>

The cached item's local case uuid mapping

local_table
required
string

The cached item's local table mapping

local_uuid
string <uuid>

The cached item's local uuid mapping

org_name
string

Cache item case's organisation name

object (JSONTime)
uuid
string <uuid> = 36 characters

The cached item's UUID

Responses

Request samples

Content type
application/json
{
  • "checksum": "string",
  • "external": true,
  • "foreign_id": "string",
  • "foreign_table": "string",
  • "local_case_uuid": "4fd25a2e-1950-409b-8c48-7a87e2e7ece3",
  • "local_table": "string",
  • "local_uuid": "16750b99-0885-4ae2-9edf-192825c23170",
  • "org_name": "string",
  • "updated": {
    },
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Deletes an item from the third party cache.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to update item on.

itemUuid
required
string

The name of the service to fetch cache for.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Updates a cache item for a third party integration cache.

Authorizations:
api_key
path Parameters
service
required
string

The name of the service to update item on.

itemUuid
required
string

The UUID of the item to update.

Request Body schema: application/json

The details to update (only checksum can be updated).

checksum
required
string

The item's latest SHA256 checksum

external
boolean

Whether the item is from an external source

foreign_id
required
string

The cached item's foreign id

foreign_table
required
string

The cached item's foreign table/endpoint

local_case_uuid
required
string <uuid>

The cached item's local case uuid mapping

local_table
required
string

The cached item's local table mapping

local_uuid
string <uuid>

The cached item's local uuid mapping

org_name
string

Cache item case's organisation name

object (JSONTime)
uuid
string <uuid> = 36 characters

The cached item's UUID

Responses

Request samples

Content type
application/json
{
  • "checksum": "string",
  • "external": true,
  • "foreign_id": "string",
  • "foreign_table": "string",
  • "local_case_uuid": "4fd25a2e-1950-409b-8c48-7a87e2e7ece3",
  • "local_table": "string",
  • "local_uuid": "16750b99-0885-4ae2-9edf-192825c23170",
  • "org_name": "string",
  • "updated": {
    },
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

user

Gets a list of users.

Authorizations:
api_key
query Parameters
include_deleted
integer

If set, deleted user records are included in the list.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a system property.

Authorizations:
api_key
Request Body schema: application/json
required

The user to create.

Id
integer <int64>
aclUuid
required
string <uuid> = 36 characters

The UUID of an ACL for this user

authSourceHandle
required
string non-empty

The user's idenifier on the authentication source where they come from

authSourceId
required
string non-empty

The authentication source where the user comes from

created
required
string <date-time> = 25 characters

The time the user was created, as an ISO8601 timestamp

deleted
required
boolean

Whether the user has been deleted

email
required
string non-empty

The email address of the user

familyName
required
string non-empty

The family name of the user

givenName
required
string non-empty

The given name of the user

groupUuid
string <uuid> = 36 characters

The UUID of this user's personal group

groupUuids
Array of strings <uuid> [ items <uuid > ]

The UUIDs of the all of the user's groups

human
required
boolean

Whether the user is a human

org
string <uuid> = 36 characters

The UUID of the user's org

phone
required
string non-empty

The phone number of the user

username
required
string non-empty

The username (login name) of the user

uuid
required
string <uuid> = 36 characters

The UUID of the user

Responses

Request samples

Content type
application/json
{
  • "Id": 0,
  • "aclUuid": "304495e4-73ab-4ad7-be5a-5e192e1dd8d6",
  • "authSourceHandle": "string",
  • "authSourceId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "email": "string",
  • "familyName": "string",
  • "givenName": "string",
  • "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
  • "groupUuids": [
    ],
  • "human": true,
  • "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  • "phone": "string",
  • "username": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Deletes a user.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a user.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to retrieve.

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "aclUuid": "304495e4-73ab-4ad7-be5a-5e192e1dd8d6",
  • "authSourceHandle": "string",
  • "authSourceId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "email": "string",
  • "familyName": "string",
  • "givenName": "string",
  • "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
  • "groupUuids": [
    ],
  • "human": true,
  • "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  • "phone": "string",
  • "username": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Updates a user.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to update.

Request Body schema: application/json
required

The user to update.

Id
integer <int64>
aclUuid
required
string <uuid> = 36 characters

The UUID of an ACL for this user

authSourceHandle
required
string non-empty

The user's idenifier on the authentication source where they come from

authSourceId
required
string non-empty

The authentication source where the user comes from

created
required
string <date-time> = 25 characters

The time the user was created, as an ISO8601 timestamp

deleted
required
boolean

Whether the user has been deleted

email
required
string non-empty

The email address of the user

familyName
required
string non-empty

The family name of the user

givenName
required
string non-empty

The given name of the user

groupUuid
string <uuid> = 36 characters

The UUID of this user's personal group

groupUuids
Array of strings <uuid> [ items <uuid > ]

The UUIDs of the all of the user's groups

human
required
boolean

Whether the user is a human

org
string <uuid> = 36 characters

The UUID of the user's org

phone
required
string non-empty

The phone number of the user

username
required
string non-empty

The username (login name) of the user

uuid
required
string <uuid> = 36 characters

The UUID of the user

Responses

Request samples

Content type
application/json
{
  • "Id": 0,
  • "aclUuid": "304495e4-73ab-4ad7-be5a-5e192e1dd8d6",
  • "authSourceHandle": "string",
  • "authSourceId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "email": "string",
  • "familyName": "string",
  • "givenName": "string",
  • "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
  • "groupUuids": [
    ],
  • "human": true,
  • "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  • "phone": "string",
  • "username": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a list of pending playbook actions assigned to the user.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to retrieve.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a user.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to update.

Request Body schema: application/json
required

The user to update.

Id
integer <int64>
aclUuid
required
string <uuid> = 36 characters

The UUID of an ACL for this user

authSourceHandle
required
string non-empty

The user's idenifier on the authentication source where they come from

authSourceId
required
string non-empty

The authentication source where the user comes from

created
required
string <date-time> = 25 characters

The time the user was created, as an ISO8601 timestamp

deleted
required
boolean

Whether the user has been deleted

email
required
string non-empty

The email address of the user

familyName
required
string non-empty

The family name of the user

givenName
required
string non-empty

The given name of the user

groupUuid
string <uuid> = 36 characters

The UUID of this user's personal group

groupUuids
Array of strings <uuid> [ items <uuid > ]

The UUIDs of the all of the user's groups

human
required
boolean

Whether the user is a human

org
string <uuid> = 36 characters

The UUID of the user's org

phone
required
string non-empty

The phone number of the user

username
required
string non-empty

The username (login name) of the user

uuid
required
string <uuid> = 36 characters

The UUID of the user

Responses

Request samples

Content type
application/json
{
  • "Id": 0,
  • "aclUuid": "304495e4-73ab-4ad7-be5a-5e192e1dd8d6",
  • "authSourceHandle": "string",
  • "authSourceId": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "email": "string",
  • "familyName": "string",
  • "givenName": "string",
  • "groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
  • "groupUuids": [
    ],
  • "human": true,
  • "org": "3b4eb1f5-aaca-43c1-9ccf-5bbd44308aba",
  • "phone": "string",
  • "username": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Reactivate a user account.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to reactivate.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a list of cases the user watches.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user to retrieve.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

user-prop

Gets a list of user properties.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user whose properties are being retrieved.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a user property.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user whose property is being deleted.

propName
required
string

The name of the property to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Gets a user property.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user whose property is being retrieved.

propName
required
string

The name of the property to retrieve.

Responses

Response samples

Content type
application/json
{
  • "acl": "a1b41ec0-9206-4855-af6b-537c6de5689f",
  • "encryptionKey": {
    },
  • "name": "string",
  • "username": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "value": [
    ]
}

Creates a user property,

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user whose property is being created.

propName
required
string

The name of the property to create.

Request Body schema: application/json
required

The user property.

acl
string = 36 characters

The new name/UUID of this property's ACL

name
string

The new name of the property

value
Array of integers <uint8> [ items <uint8 > ]

The new value of the property

Responses

Request samples

Content type
application/json
{
  • "acl": "stringstringstringstringstringstring",
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
application/json
{
  • "acl": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

Updates a user property.

Authorizations:
api_key
path Parameters
userUuid
required
string

The UUID of the user whose property is being updated.

propName
required
string

The name of the property to update.

Request Body schema: application/json
required

The updated user property.

acl
string = 36 characters

The new name/UUID of this property's ACL

name
string

The new name of the property

value
Array of integers <uint8> [ items <uint8 > ]

The new value of the property

Responses

Request samples

Content type
application/json
{
  • "acl": "stringstringstringstringstringstring",
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

wiki

Editable knowledge base

Search wiki for pages

query Parameters
q
required
string

The search query

page[number]
required
integer

The results page to return

page[size]
required
integer

The size of each page to return

include
Array of strings

Which additional objects to include

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": [
    ]
}

Get all wiki pages

query Parameters
page[number]
required
integer

The results page to return

page[size]
required
integer

The size of each page to return

include
Array of strings

Which additional objects to include

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": [
    ]
}

Create a new wiki page

Request Body schema: application/vnd.api+json
object or null (JsonApiLinks)
object or null (JsonApiServerImpl)
included
Array of objects

A list of objects related to this resource

Array of objects or null (JsonApiError)

A list of error objects

object or null (WikiPageObjectResource)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Delete an existing wiki page

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "id": "string",
  • "status": "string",
  • "code": "string",
  • "title": "string",
  • "details": "string",
  • "source": "string"
}

Get the content of a wiki page

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

query Parameters
include
Array of strings

Which additional objects to include

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Edit an existing wiki page

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Request Body schema: application/vnd.api+json
object or null (JsonApiLinks)
object or null (JsonApiServerImpl)
included
Array of objects

A list of objects related to this resource

Array of objects or null (JsonApiError)

A list of error objects

object or null (WikiPageObjectResource)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Replace an existing wiki page

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Request Body schema: application/vnd.api+json
object or null (JsonApiLinks)
object or null (JsonApiServerImpl)
included
Array of objects

A list of objects related to this resource

Array of objects or null (JsonApiError)

A list of error objects

object or null (WikiPageObjectResource)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

risk

Risk register

Get all risks and their latest assessments

query Parameters
page[number]
required
integer

The results page to return

page[size]
required
integer

The size of each page to return

include
Array of strings

Which additional objects to include

header Parameters
Accept
string

The Accept header

Responses

Response samples

Content type
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": [
    ]
}

Create a new risk

Request Body schema: application/vnd.api+json
object or null (RiskRequestResource)

Used to create a new risk, or update an existing risk

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Delete a risk and all of its assessments

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Responses

Get the specified risk and its latest assessment

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

query Parameters
include
Array of strings

Which additional objects to include

header Parameters
Accept
string

The Accept header

Responses

Response samples

Content type
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Edit a risk

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Request Body schema: application/vnd.api+json
object or null (RiskRequestResource)

Used to create a new risk, or update an existing risk

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Create a new risk assessment and associate it with a risk

Request Body schema: application/vnd.api+json
object or null (RiskAssessmentRequestResource)

Used to create or update a risk assessment

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Delete a risk assessment

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Responses

Edit a risk assessment

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Request Body schema: application/vnd.api+json
object or null (RiskAssessmentRequestResource)

Used to create or update a risk assessment

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

connector-operation-type

Connector operation types

Get all connector operation types

query Parameters
page[number]
required
integer

The results page to return

page[size]
required
integer

The size of each page to return

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": [
    ]
}

Create a new connector operation type

Request Body schema: application/vnd.api+json
object or null (ConnectorOperationTypeRequestResource)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Delete an existing connector operation type

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Responses

Get the specified connector operation type

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Update an existing connector operation type

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Request Body schema: application/vnd.api+json
object or null (ConnectorOperationTypeUpdateRequestResource)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

event-trigger

Event triggers

Get all event triggers

query Parameters
page[number]
required
integer

The results page to return

page[size]
required
integer

The size of each page to return

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": [
    ]
}

Create a new event trigger

Request Body schema: application/vnd.api+json
object or null (EventTriggerRequestResource)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Delete an event trigger

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Responses

Get the specified event trigger

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Responses

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

Edit an event trigger

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Request Body schema: application/vnd.api+json
object or null (EventTriggerPatchResource)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "included": [
    ],
  • "errors": [
    ],
  • "data": {
    }
}

case-data

Case data

Add new data to a case

Request Body schema: application/vnd.api+json
object or null (CaseDataRequestResource)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "links": {
    },
  • "included": [
    ],
  • "errors": [
    ]
}

gets a data item

path Parameters
uuid
required
string <UuidPtr>

The resource UUID

Request Body schema: application/vnd.api+json
object or null (CaseDataRequestResource)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "jsonapi": {
    },
  • "data": {
    },
  • "links": {
    },
  • "included": [
    ],
  • "errors": [
    ]
}

operations

Atomic operations

Perform a sequence of operations atomically

Request Body schema: application/vnd.api+json;ext="https://jsonapi.org/ext/atomic"
object or null (JsonApiLinks)
object or null (JsonApiServerImpl)
Array of objects (AtomicOperation)

A list of atomic operations

Responses

Request samples

Content type
application/vnd.api+json;ext="https://jsonapi.org/ext/atomic"
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "atomic:operations": [
    ]
}

Response samples

Content type
application/vnd.api+json;ext="https://jsonapi.org/ext/atomic"
{
  • "links": {
    },
  • "jsonapi": {
    },
  • "atomic:results": [
    ],
  • "errors": [
    ]
}