Get workflow details

Retrieve details of a specific workflow. When include_configuration=true, the response also includes the latest workflow configuration (data_input_config, actions, version, etc.).

Path Parameters

• workflow_id string required

  Workflow identifier

Query Parameters

• include_configuration boolean

  Include latest workflow configuration in response

Header Parameters

• SlashID-OrgID string required

  The organization ID

  Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1

Responses

• 200
• 404

---

Workflow details

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

  oneOf

  • MOD1
  • MOD2

  ---

  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

  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
  }
}

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"
    }
  ]
}