Get a playbook

Parameter	Description
name	The name of the playbook

 

playbookByName(name: "playbook_name") {
  id
  name
  description
  enabled
}

Activate a playbook

Parameter	Description
id	The id of the playbook

 

updatePlaybook(
  id: "playbook_id",
  input: {
    name: "playbook_name",
    enabled: true
  }
) {
  id
}

Pause a playbook

Parameter	Description
id	The id of the playbook

 

updatePlaybook(
  id: "playbook_id",
  input: {
    name: "playbook_name",
    enabled: false
  }
) {
  id
}

Get targets for a specific playbook

Parameter	Description
name	The name of the playbook

 

playbookByName(name: "playbook_name") {
  targets{
    id
    name
    description
    items {
      idpObjID
      idpObjType
      displayName
      email
    }
  }
}

Get all playbooks a user runs

Parameter	Description
name	The name of the user

 

idpUserByName(name: "user_name") {
  playbooks {
    id
    name
    description
    enabled
  }
}

Get all playbooks a group runs

Parameter	Description
name	The name of the group

 

idpGroupByName(name: "group_name") {
  playbooks {
    id
    name
    description
    enabled
  }
}

Add tragets to a playbook target group

Parameter	Description
id	Target group ID
input	A collection of user and groups to be added. See InputAddTargetsToTargetGroup

 

addTargetsToTargetGroup(
  id: "target_group_id",
  input: {"items": [{"idpObjID": "4", "idpObjType": "USER"}, {"idpObjID": "6", "idpObjType": "GROUP"}]}
) {
  id
}

Remove tragets from a playbook target group

Parameter	Description
id	Target group ID
input	A collection of items IDs to be removed. See InputRemoveTargetsFromTargetGroups

 

removeTargetsFromTargetGroup(
  id: "target_group_id",
  input: {"items": [{"id": "2"}]}
) {
  id
}

Get a domain list

Parameter	Description
name	The name of the list

 

listByName(name: "list_name") {
  id
  items {
    id
    ... on DomainListItem {
      value
    }
  }
  ... on PredefinedList{
    predefinedItems {
      id
      ... on PredefinedDomainListItem {
        value
      }
      enabled
    }
  }
}

Response example:

{
  "data": {
    "listByName": {
      "id": "a027a90a-bf21-4305-a53a-287469c2fe14",
      "items": [
        {
          "id": "cd92e474-0e2f-4518-b14c-6d206ccc84ff",
          "value": "domain.com"
        },
        {
          "id": "5e529162-61f5-42a9-8673-f9f4e0602fbe",
          "value": "domain.org"
        }
      ]
    }
  }
}

Add items to a domain list

Parameter	Description
id	The id of the list
input	A collection of domains to be added. See InputAddItemsToDomainList

 

addItemsToDomainList(
  id: "list_id",
  input: {"items": [{"value": "domain.com"}, {"value": "domain.org"}]}
) {
  id
}

Remove items from a domain list

Parameter	Description
id	The id of the list
input	A collection of items IDs to be removed. See InputRemoveItemsFromDomainList

 

removeItemsFromDomainList(
  id: "list_id",
  input: {"items": [{"id": "2"}]}
) {
  id
}

Enable or disable a predefined domain list item

Parameter	Description
id	The id of the list
input	The ID of the item to be disbled/enabled. See InputUpdatePredefinedItem

 

updatePredefinedItem(
  id: "list_id",
  input: {"itemID": "3", "enabled": false}
) {
  id
}

Get an application

Get an application

Parameter	Description
name	The name of the application

 

appByName(
  name: "app_name"
) {
  id
  name
  description
}

Get an applications list

Parameter	Description
name	The name of the list

 

listByName(name: "list_name") {
  id
  items {
    id
    ... on AppListItem {
      id
      name
      description
    }
  }
  ... on PredefinedList{
    predefinedItems {
      id
      ... on PredefinedAppListItem {
        id
        name
        description
      }
      enabled
    }
  }
}

Response example:

{
  "data": {
    "listByName": {
      "id": "5a8b29dd-2180-4bab-b0bf-9ffafa492ca6",
      "items": [
        {
          "id": "6033d649510ef18ad79e91f82a4138f6",
          "name": "Microsoft Azure",
          "description": "Windows Azure and SQL Azure enable you to build, host and scale applications in Microsoft datacenters"
        },
        {
          "id": "b9bb902f32b23ca22b613bf3ac156b23",
          "name": "Microsoft Skype",
          "description": "Skype is for connecting with the people that matter most in your life and work"
        }
      ]
    }
  }
}

Add items to an applications list

Parameter	Description
id	The id of the list
input	A collection of applications IDs to be added. See InputAddRemoveItemsAppList

 

addItemsToAppList(
  id: "list_id",
  input: {"items": [{"id": "5"}]}
) {
  id
}

Remove items from an applications list

Parameter	Description
id	The id of the list
input	A collection of applications IDs to be removed. See InputAddRemoveItemsAppList

 

removeItemsFromAppList(
  id: "list_id",
  input: {"items": [{"id": "2"}, {"id": "5"}]}
) {
  id
}

Enable or disable a predefined applications list item

Parameter	Description
id	The id of the list
input	The ID of the item to be disbled/enabled. See InputUpdatePredefinedItem

 

updatePredefinedItem(
  id: "list_id",
  input: {"itemID": "3", "enabled": false}
) {
  id
}

Get logs

Get x logs from timestamp

Parameter	Description
timestamp	Fetch logs from this timestamp
size	Number of logs to fetch. The maximum value is 1000

 

logs( 
  timestamp: "2022-12-08T09:05:09Z",
  size: 150
) {
  data
  size
}