Skip to main content

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
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
  • 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. Accepts array format. Note: Server also accepts map format internally but array is preferred for clients.

  • starting_actions string[]

    IDs of actions to execute first after data input completes. If provided, enables tree-based execution where only these actions start initially, and child actions are triggered via the children field. If NOT provided, all actions execute in parallel (legacy behavior).

Responses

Workflow updated successfully

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
  • 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[]

    Actions configuration. Currently returned as an array for backwards compatibility. Note: Server may return either array or map format depending on feature flags. Clients should handle both formats.

  • starting_actions string[]

    IDs of actions to execute first (after data input). Only present when actions is in map format (new format). Omitted in legacy array format for backwards compatibility.

  • is_latest boolean

    Whether this is the latest version