Update workflow

Update a workflow and create a new version

Path Parameters

workflow_id string required
Workflow identifier

Header Parameters

SlashID-OrgID string required
The organization ID
Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1

application/json

Request Body required

Workflow update request

name string
Possible values: non-empty and <= 255 characters
New workflow name
description string
Possible values: <= 1000 characters
New workflow description
data_input_config object
oneOf
MOD1
type string required
Possible values: [detection]
Data input type discriminator
scim_filter string required
Possible values: non-empty
SCIM filter string to apply when querying detections. Examples:

severity eq "critical"

type eq "aws_identity_unused" and status eq "new"

entity_type eq "aws_iam_user"

severity eq "critical" or severity eq "high"

limit integer
Possible values: <= 10000
Maximum number of detections to retrieve (0 for no limit)
sorting object[]
Sorting configuration for results
field string required
Field to sort by
direction string required
Possible values: [asc, desc]
Default value: desc
Sort direction
actions object[]
Possible values: >= 1
Updated list of actions

Responses

Workflow updated successfully

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
errors object[]
httpcode integer
message string
result object
id string
Unique workflow identifier
org_id string
Organization ID
name string
Possible values: non-empty and <= 255 characters
Workflow name
description string
Possible values: <= 1000 characters
Workflow description
status string
Possible values: [draft, active, paused, deleted]
Current state of a workflow
created_by string
User ID who created the workflow
created_at date-time
Workflow creation timestamp
updated_by string
User ID who last updated the workflow
updated_at date-time
Last update timestamp
activated_at date-time
When workflow was first activated
paused_at date-time
When workflow was paused
last_executed_at date-time
Last execution timestamp
execution_count integer
Total execution count
success_count integer
Successful execution count
failure_count integer
Failed execution count
latest_configuration_id string
ID of the latest configuration version
latest_configuration_version integer
Latest configuration version number
workflow_id string
Parent workflow ID
version integer
Possible values: >= 1
Configuration version number
data_input_config object
oneOf
MOD1
type string
Possible values: [detection]
Data input type discriminator
scim_filter string
Possible values: non-empty
SCIM filter string to apply when querying detections. Examples:

severity eq "critical"

type eq "aws_identity_unused" and status eq "new"

entity_type eq "aws_iam_user"

severity eq "critical" or severity eq "high"

limit integer
Possible values: <= 10000
Maximum number of detections to retrieve (0 for no limit)
sorting object[]
Sorting configuration for results
field string
Field to sort by
direction string
Possible values: [asc, desc]
Default value: desc
Sort direction
actions object[]
Possible values: >= 1
List of actions to execute
is_latest boolean
Whether this is the latest version

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ],
  "result": {
    "id": "string",
    "org_id": "string",
    "name": "string",
    "description": "string",
    "status": "draft",
    "created_by": "string",
    "created_at": "2005-12-24T18:29:30.033157Z",
    "updated_by": "string",
    "updated_at": "2005-12-24T18:29:30.033157Z",
    "activated_at": "2005-12-24T18:29:30.033157Z",
    "paused_at": "2005-12-24T18:29:30.033157Z",
    "last_executed_at": "2005-12-24T18:29:30.033157Z",
    "execution_count": 0,
    "success_count": 0,
    "failure_count": 0,
    "latest_configuration_id": "string",
    "latest_configuration_version": 0,
    "workflow_id": "string",
    "version": 0,
    "data_input_config": {
      "type": "detection",
      "scim_filter": "string",
      "limit": 0,
      "sorting": [
        {
          "field": "string",
          "direction": "desc"
        }
      ]
    },
    "actions": [
      {
        "id": "string",
        "type": "remediation",
        "name": "string",
        "description": "string",
        "enabled": true,
        "action": "suspend",
        "target_type": "user",
        "parameters": {},
        "dry_run": false
      },
      {
        "id": "string",
        "type": "remediation",
        "name": "string",
        "description": "string",
        "enabled": true,
        "ticket_system": "jira",
        "project_key": "string",
        "issue_type": "string",
        "title_template": "string",
        "description_template": "string",
        "labels": [
          "string"
        ],
        "assignee": "string",
        "priority": "string"
      },
      {
        "id": "string",
        "type": "remediation",
        "name": "string",
        "description": "string",
        "enabled": true,
        "sink_type": "s3",
        "connection_config": {},
        "data_format": "json",
        "include_fields": [
          "string"
        ],
        "transform_rules": [
          {}
        ]
      },
      {
        "id": "string",
        "type": "remediation",
        "name": "string",
        "description": "string",
        "enabled": true,
        "url": "string",
        "method": "POST",
        "headers": {},
        "body_template": "string",
        "timeout_seconds": 30,
        "retry_config": {
          "max_retries": 3,
          "backoff_seconds": 5
        }
      },
      {
        "id": "string",
        "type": "remediation",
        "name": "string",
        "description": "string",
        "enabled": true,
        "notification_type": "email",
        "recipients": [
          "string"
        ],
        "subject_template": "string",
        "message_template": "string",
        "severity": "warning",
        "include_data": true
      }
    ],
    "is_latest": true
  }
}

Bad Request

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Not Found

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Update workflow​

Update workflow