--- title: List workflows description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Workflow Automation --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). {% callout %} # Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com {% alert level="danger" %} This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}). {% /alert %} {% /callout %} # List workflows{% #list-workflows %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/workflows | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/workflows | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/workflows | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/workflows | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/workflows | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/workflows | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/workflows | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/workflows | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/workflows | ### Overview List all workflows in your organization. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection.md#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys.md#actions-api-access). This endpoint requires the `workflows_read` permission. ### Arguments #### Query Strings | Name | Type | Description | | -------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | limit | integer | The maximum number of workflows to return per page. | | page | integer | The page number to return, starting from 0. | | sort | string | The sort order for the returned workflows. Provide a comma-separated list of fields, each optionally prefixed with `-` for descending order. Supported fields are `name`, `createdAt`, `updatedAt`, `creatorName`, `ownerName`, and `lastExecutedAt`. | | filter[query] | string | A search query used to filter the returned workflows. The query performs a case-insensitive substring match against each workflow's name, creator name, and handle. If the query contains a colon (for example, `team:infra`), the query is treated as a `key:value` tag filter. | | filter[triggerIds] | array | Filters the returned workflows by one or more trigger types, such as `monitor`, `schedule`, or `githubWebhook`. To specify the multiple types, repeat this parameter. | | filter[includeUnpublished] | boolean | Whether to include unpublished workflows in the response. | | filter[includeSpecs] | boolean | Whether to include the full spec of each workflow in the response. When `false` (the default), each workflow's `spec` is returned as `null`. | ### Response {% tab title="200" %} OK {% tab title="Model" %} The response object for a listing workflows request. | Parent field | Field | Type | Description | | -------------------------------- | -------------------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | data | [object] | A list of workflows. | | data | attributes [*required*] | object | Attributes of a workflow returned in a list response. | | attributes | createdAt | date-time | When the workflow was created. | | attributes | description | string | Description of the workflow. | | attributes | name [*required*] | string | Name of the workflow. | | attributes | published | boolean | Whether the workflow is published. Unpublished workflows can only be run manually. Automatic triggers such as Schedule do not fire until the workflow is published. | | attributes | runAsUserMode | enum | The effective type of identity used to run the workflow. Allowed enum values: `owner,service_account,initiator` | | attributes | spec | object | A complete Workflow Automation definition, including its triggers, steps, and connections. | | spec | annotations | [object] | Up to 100 text annotations displayed on the workflow canvas. | | annotations | display [*required*] | object | The annotation's position and size on the workflow canvas. | | display | bounds | object | Canvas coordinates and dimensions for an annotation on the workflow canvas. | | bounds | height | double | The annotation's height on the canvas. | | bounds | width | double | The annotation's width on the canvas. | | bounds | x | double | The annotation's horizontal canvas coordinate. | | bounds | y | double | The annotation's vertical canvas coordinate. | | annotations | id [*required*] | string | The unique identifier of this annotation within the workflow. | | annotations | markdownTextAnnotation [*required*] | object | Markdown content displayed in an annotation. | | markdownTextAnnotation | text | string | The annotation's Markdown content. | | spec | connectionEnvs | [object] | A list of connections or connection groups used in the workflow. | | connectionEnvs | connectionGroups | [object] | The `ConnectionEnv` `connectionGroups`. | | connectionGroups | connectionGroupId [*required*] | string | The `ConnectionGroup` `connectionGroupId`. | | connectionGroups | label [*required*] | string | The `ConnectionGroup` `label`. | | connectionGroups | tags [*required*] | [string] | The `ConnectionGroup` `tags`. | | connectionEnvs | connections | [object] | The `ConnectionEnv` `connections`. | | connections | connectionId [*required*] | string | The `Connection` `connectionId`. | | connections | label [*required*] | string | The `Connection` `label`. | | connectionEnvs | env [*required*] | enum | The definition of `ConnectionEnvEnv` object. Allowed enum values: `default` | | spec | handle | string | Unique identifier used to trigger workflows automatically in Datadog. | | spec | inputSchema | object | A list of input parameters for the workflow. Input parameters are available under the `Trigger` object and can be referenced in workflow steps using `{{ Trigger. }}`. | | inputSchema | parameters | [object] | The `InputSchema` `parameters`. | | parameters | allowExtraValues | boolean | The `InputSchemaParameters` `allowExtraValues`. | | parameters | allowedValues | | The `InputSchemaParameters` `allowedValues`. | | parameters | defaultValue | | The `InputSchemaParameters` `defaultValue`. | | parameters | description | string | The `InputSchemaParameters` `description`. | | parameters | label | string | The `InputSchemaParameters` `label`. | | parameters | name [*required*] | string | The `InputSchemaParameters` `name`. | | parameters | type [*required*] | enum | The definition of `InputSchemaParametersType` object. Allowed enum values: `STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT` | | spec | outputSchema | object | A list of output parameters for the workflow. | | outputSchema | parameters | [object] | The `OutputSchema` `parameters`. | | parameters | defaultValue | | The `OutputSchemaParameters` `defaultValue`. | | parameters | description | string | The `OutputSchemaParameters` `description`. | | parameters | label | string | The `OutputSchemaParameters` `label`. | | parameters | name [*required*] | string | The `OutputSchemaParameters` `name`. | | parameters | type [*required*] | enum | The definition of `OutputSchemaParametersType` object. Allowed enum values: `STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT` | | parameters | value | | The `OutputSchemaParameters` `value`. | | spec | steps | [object] | A `Step` is a sub-component of a workflow. Each `Step` performs an action. | | steps | actionId [*required*] | string | The unique identifier of an action. | | steps | completionGate | object | Used to create conditions before running subsequent actions. | | completionGate | completionCondition [*required*] | object | The definition of `CompletionCondition` object. | | completionCondition | operand1 [*required*] | | The `CompletionCondition` `operand1`. | | completionCondition | operand2 | | The `CompletionCondition` `operand2`. | | completionCondition | operator [*required*] | enum | The definition of `CompletionConditionOperator` object. Allowed enum values: `OPERATOR_EQUAL,OPERATOR_NOT_EQUAL,OPERATOR_GREATER_THAN,OPERATOR_LESS_THAN,OPERATOR_GREATER_THAN_OR_EQUAL_TO,OPERATOR_LESS_THAN_OR_EQUAL_TO,OPERATOR_CONTAINS,OPERATOR_DOES_NOT_CONTAIN,OPERATOR_IS_NULL,OPERATOR_IS_NOT_NULL` | | completionGate | retryStrategy [*required*] | object | The definition of `RetryStrategy` object. | | retryStrategy | kind [*required*] | enum | The definition of `RetryStrategyKind` object. Allowed enum values: `RETRY_STRATEGY_LINEAR` | | retryStrategy | linear [*required*] | object | The definition of `RetryStrategyLinear` object. | | linear | interval [*required*] | string | The `RetryStrategyLinear` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | linear | maxRetries [*required*] | int32 | The `RetryStrategyLinear` `maxRetries`. | | steps | connectionLabel | string | The unique identifier of a connection defined in the spec. | | steps | display | object | The position of a step on the workflow canvas. Omit `display` from every step to use automatic layout, or provide it for every step to preserve a manual layout. | | display | bounds | object | The definition of `StepDisplayBounds` object. | | bounds | x | double | The `bounds` `x`. | | bounds | y | double | The `bounds` `y`. | | steps | errorHandlers | [object] | The `Step` `errorHandlers`. | | errorHandlers | fallbackStepName [*required*] | string | The `ErrorHandler` `fallbackStepName`. | | errorHandlers | retryStrategy [*required*] | object | The definition of `RetryStrategy` object. | | retryStrategy | kind [*required*] | enum | The definition of `RetryStrategyKind` object. Allowed enum values: `RETRY_STRATEGY_LINEAR` | | retryStrategy | linear [*required*] | object | The definition of `RetryStrategyLinear` object. | | linear | interval [*required*] | string | The `RetryStrategyLinear` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | linear | maxRetries [*required*] | int32 | The `RetryStrategyLinear` `maxRetries`. | | steps | name [*required*] | string | Name of the step. | | steps | outboundEdges | [object] | A list of subsequent actions to run. This list is empty for a terminal step. | | outboundEdges | branchName [*required*] | string | The `OutboundEdge` `branchName`. | | outboundEdges | nextStepName [*required*] | string | The `OutboundEdge` `nextStepName`. | | steps | parameters | [object] | A list of inputs for an action. | | parameters | name [*required*] | string | The `Parameter` `name`. | | parameters | value [*required*] | | The `Parameter` `value`. | | steps | readinessGate | object | Used to merge multiple branches into a single branch. | | readinessGate | thresholdType [*required*] | enum | The definition of `ReadinessGateThresholdType` object. Allowed enum values: `ANY,ALL` | | spec | triggers | [ ] | The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once. | | triggers | Object 1 | object | Schema for an agent-based trigger. | | Object 1 | agentTrigger [*required*] | object | Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP. | | agentTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 1 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 2 | object | Schema for an API-based trigger. | | Object 2 | apiTrigger [*required*] | object | Trigger a workflow from an API request. The workflow must be published. | | apiTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 2 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 3 | object | Schema for an App-based trigger. | | Object 3 | appTrigger [*required*] | object | Trigger a workflow from an App. | | Object 3 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 4 | object | Schema for a Case-based trigger. | | Object 4 | caseTrigger [*required*] | object | Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published. | | caseTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 4 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 5 | object | Schema for a Change Event-based trigger. | | Object 5 | changeEventTrigger [*required*] | object | Trigger a workflow from a Change Event. | | Object 5 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 6 | object | Schema for a Database Monitoring-based trigger. | | Object 6 | databaseMonitoringTrigger [*required*] | object | Trigger a workflow from Database Monitoring. | | Object 6 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 7 | object | Schema for a Datastore-based trigger. | | Object 7 | datastoreTrigger [*required*] | object | Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published. | | datastoreTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 7 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 8 | object | Schema for a Dashboard-based trigger. | | Object 8 | dashboardTrigger [*required*] | object | Trigger a workflow from a Dashboard. | | Object 8 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 9 | object | Schema for a Form-based trigger. | | Object 9 | formTrigger [*required*] | object | Trigger a workflow from a Form. | | formTrigger | formId | string | The form UUID. | | Object 9 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 10 | object | Schema for a GitHub webhook-based trigger. | | Object 10 | githubWebhookTrigger [*required*] | object | Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a `webhookSecret`. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published. | | githubWebhookTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 10 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 11 | object | Schema for an incident declared trigger. | | Object 11 | incidentCreatedTrigger [*required*] | object | Trigger a workflow when an incident is declared. | | incidentCreatedTrigger | incidentType | string | The type of incident that triggers the workflow. | | incidentCreatedTrigger | tagCondition | object | Conditions that determine which incidents trigger the workflow. | | tagCondition | tagValues | [object] | Incident tags and values used to filter matching incidents. | | tagValues | tag [*required*] | string | The incident tag to match. | | tagValues | values [*required*] | [string] | The accepted values for the incident tag. | | Object 11 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 12 | object | Schema for an incident impact created trigger. | | Object 12 | incidentImpactCreatedTrigger [*required*] | object | Trigger a workflow when an impact is created for an incident. | | incidentImpactCreatedTrigger | executionLimit | object | The maximum number of times to execute a workflow for an incident. | | executionLimit | count [*required*] | int32 | The maximum number of workflow executions. | | incidentImpactCreatedTrigger | incidentType | string | The type of incident that triggers the workflow. | | incidentImpactCreatedTrigger | tagCondition | object | Conditions that determine which incidents trigger the workflow. | | tagCondition | tagValues | [object] | Incident tags and values used to filter matching incidents. | | tagValues | tag [*required*] | string | The incident tag to match. | | tagValues | values [*required*] | [string] | The accepted values for the incident tag. | | Object 12 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 13 | object | Schema for an incident impact updated trigger. | | Object 13 | incidentImpactUpdatedTrigger [*required*] | object | Trigger a workflow when an impact is updated for an incident. | | incidentImpactUpdatedTrigger | executionLimit | object | The maximum number of times to execute a workflow for an incident. | | executionLimit | count [*required*] | int32 | The maximum number of workflow executions. | | incidentImpactUpdatedTrigger | incidentType | string | The type of incident that triggers the workflow. | | incidentImpactUpdatedTrigger | tagCondition | object | Conditions that determine which incidents trigger the workflow. | | tagCondition | tagValues | [object] | Incident tags and values used to filter matching incidents. | | tagValues | tag [*required*] | string | The incident tag to match. | | tagValues | values [*required*] | [string] | The accepted values for the incident tag. | | Object 13 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 14 | object | Schema for an incident postmortem updated trigger. | | Object 14 | incidentPostmortemUpdatedTrigger [*required*] | object | Trigger a workflow when a postmortem is updated for an incident. | | incidentPostmortemUpdatedTrigger | executionLimit | object | The maximum number of times to execute a workflow for an incident. | | executionLimit | count [*required*] | int32 | The maximum number of workflow executions. | | incidentPostmortemUpdatedTrigger | incidentType | string | The type of incident that triggers the workflow. | | incidentPostmortemUpdatedTrigger | tagCondition | object | Conditions that determine which incidents trigger the workflow. | | tagCondition | tagValues | [object] | Incident tags and values used to filter matching incidents. | | tagValues | tag [*required*] | string | The incident tag to match. | | tagValues | values [*required*] | [string] | The accepted values for the incident tag. | | Object 14 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 15 | object | Schema for an incident responder created trigger. | | Object 15 | incidentResponderCreatedTrigger [*required*] | object | Trigger a workflow when a responder is created for an incident. | | incidentResponderCreatedTrigger | executionLimit | object | The maximum number of times to execute a workflow for an incident. | | executionLimit | count [*required*] | int32 | The maximum number of workflow executions. | | incidentResponderCreatedTrigger | incidentType | string | The type of incident that triggers the workflow. | | incidentResponderCreatedTrigger | tagCondition | object | Conditions that determine which incidents trigger the workflow. | | tagCondition | tagValues | [object] | Incident tags and values used to filter matching incidents. | | tagValues | tag [*required*] | string | The incident tag to match. | | tagValues | values [*required*] | [string] | The accepted values for the incident tag. | | Object 15 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 16 | object | Schema for an incident declared or updated trigger. | | Object 16 | incidentSavedTrigger [*required*] | object | Trigger a workflow when an incident is declared or updated. | | incidentSavedTrigger | executionLimit | object | The maximum number of times to execute a workflow for an incident. | | executionLimit | count [*required*] | int32 | The maximum number of workflow executions. | | incidentSavedTrigger | incidentType | string | The type of incident that triggers the workflow. | | incidentSavedTrigger | serialExecution | object | Whether to execute the workflow serially for an incident. | | serialExecution | enabled [*required*] | boolean | Whether serial execution is enabled. | | incidentSavedTrigger | tagCondition | object | Conditions that determine which incidents trigger the workflow. | | tagCondition | tagValues | [object] | Incident tags and values used to filter matching incidents. | | tagValues | tag [*required*] | string | The incident tag to match. | | tagValues | values [*required*] | [string] | The accepted values for the incident tag. | | Object 16 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 17 | object | Schema for an incident schedule trigger. | | Object 17 | incidentScheduleTrigger [*required*] | object | Trigger a workflow on a schedule for an incident. | | incidentScheduleTrigger | incidentType | string | The type of incident that triggers the workflow. | | incidentScheduleTrigger | rrule [*required*] | string | The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string. | | incidentScheduleTrigger | tagCondition | object | Conditions that determine which incidents trigger the workflow. | | tagCondition | tagValues | [object] | Incident tags and values used to filter matching incidents. | | tagValues | tag [*required*] | string | The incident tag to match. | | tagValues | values [*required*] | [string] | The accepted values for the incident tag. | | Object 17 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 18 | object | Schema for an incident-based trigger. | | Object 18 | incidentTrigger [*required*] | object | Trigger a workflow from an incident. For automatic triggering a handle must be configured and the workflow must be published. | | incidentTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | incidentTrigger | version | string | Version of the incident manual trigger. | | Object 18 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 19 | object | Schema for a Monitor-based trigger. | | Object 19 | monitorTrigger [*required*] | object | Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published. | | monitorTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 19 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 20 | object | Schema for a Notebook-based trigger. | | Object 20 | notebookTrigger [*required*] | object | Trigger a workflow from a Notebook. | | Object 20 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 21 | object | Schema for an On-Call-based trigger. | | Object 21 | onCallTrigger [*required*] | object | Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published. | | onCallTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 21 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 22 | object | Schema for a Schedule-based trigger. | | Object 22 | scheduleTrigger [*required*] | object | Trigger a workflow from a Schedule. The workflow must be published. | | scheduleTrigger | overlapBehavior | enum | Controls whether a scheduled workflow run may start while another instance is still running. Allowed enum values: `EXCLUSIVE_RUN,OVERLAP_ALLOWED` | | scheduleTrigger | rruleExpression [*required*] | string | Recurrence rule expression for scheduling. | | Object 22 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 23 | object | Schema for a Security-based trigger. | | Object 23 | securityTrigger [*required*] | object | Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published. | | securityTrigger | rateLimit | object | Defines a rate limit for a trigger. | | rateLimit | count | int64 | The `TriggerRateLimit` `count`. | | rateLimit | interval | string | The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s | | Object 23 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 24 | object | Schema for a Self Service-based trigger. | | Object 24 | selfServiceTrigger [*required*] | object | Trigger a workflow from Self Service. | | Object 24 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 25 | object | Schema for a Slack-based trigger. | | Object 25 | slackTrigger [*required*] | object | Trigger a workflow from Slack. The workflow must be published. | | slackTrigger | reactionTriggers | [object] | Slack emoji reactions that trigger the workflow. | | reactionTriggers | reactionEmoji [*required*] | string | The Slack emoji reaction name. | | reactionTriggers | teamId [*required*] | string | The Slack workspace ID. | | Object 25 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 26 | object | Schema for a Software Catalog-based trigger. | | Object 26 | softwareCatalogTrigger [*required*] | object | Trigger a workflow from Software Catalog. | | Object 26 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | triggers | Object 27 | object | Schema for a Workflow-based trigger. | | Object 27 | startStepNames | [string] | Names of existing workflow steps that run first after a trigger fires. | | Object 27 | workflowTrigger [*required*] | object | Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger. | | attributes | tags | [string] | Tags of the workflow. | | attributes | updatedAt | date-time | When the workflow was last updated. | | data | id | string | The workflow identifier. | | data | relationships | object | The definition of `WorkflowDataRelationships` object. | | relationships | creator | object | The definition of `WorkflowUserRelationship` object. | | creator | data | object | The definition of `WorkflowUserRelationshipData` object. | | data | id [*required*] | string | The user identifier | | data | type [*required*] | enum | The definition of `WorkflowUserRelationshipType` object. Allowed enum values: `users` | | relationships | owner | object | The definition of `WorkflowUserRelationship` object. | | owner | data | object | The definition of `WorkflowUserRelationshipData` object. | | data | id [*required*] | string | The user identifier | | data | type [*required*] | enum | The definition of `WorkflowUserRelationshipType` object. Allowed enum values: `users` | | relationships | runAs | object | The service account used to run the workflow. Present when `runAsUserMode` is `service_account`. | | runAs | data | object | The definition of `WorkflowUserRelationshipData` object. | | data | id [*required*] | string | The user identifier | | data | type [*required*] | enum | The definition of `WorkflowUserRelationshipType` object. Allowed enum values: `users` | | data | type [*required*] | enum | The definition of `WorkflowDataType` object. Allowed enum values: `workflows` | | | meta | object | Metadata for a List Workflows response. | | meta | page | object | Pagination metadata for a List Workflows response. | | page | totalCount | int64 | The total number of workflows in the organization. | | page | totalFilteredCount | int64 | The total number of workflows matching the applied filters. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "createdAt": "2019-09-19T10:00:00.000Z", "description": "string", "name": "My Workflow", "published": false, "runAsUserMode": "owner", "spec": { "annotations": [ { "display": { "bounds": { "height": "number", "width": "number", "x": "number", "y": "number" } }, "id": "", "markdownTextAnnotation": { "text": "string" } } ], "connectionEnvs": [ { "connectionGroups": [ { "connectionGroupId": "", "label": "", "tags": [ "" ] } ], "connections": [ { "connectionId": "", "label": "" } ], "env": "default" } ], "handle": "string", "inputSchema": { "parameters": [ { "allowExtraValues": false, "allowedValues": "undefined", "defaultValue": "undefined", "description": "string", "label": "string", "name": "", "type": "STRING" } ] }, "outputSchema": { "parameters": [ { "defaultValue": "undefined", "description": "string", "label": "string", "name": "", "type": "STRING", "value": "undefined" } ] }, "steps": [ { "actionId": "", "completionGate": { "completionCondition": { "operand1": "undefined", "operand2": "undefined", "operator": "OPERATOR_EQUAL" }, "retryStrategy": { "kind": "RETRY_STRATEGY_LINEAR", "linear": { "interval": "", "maxRetries": 0 } } }, "connectionLabel": "string", "display": { "bounds": { "x": "number", "y": "number" } }, "errorHandlers": [ { "fallbackStepName": "", "retryStrategy": { "kind": "RETRY_STRATEGY_LINEAR", "linear": { "interval": "", "maxRetries": 0 } } } ], "name": "", "outboundEdges": [ { "branchName": "main", "nextStepName": "Step2" } ], "parameters": [ { "name": "", "value": "undefined" } ], "readinessGate": { "thresholdType": "ANY" } } ], "triggers": [ { "agentTrigger": { "rateLimit": { "count": "integer", "interval": "string" } }, "startStepNames": [ "" ] } ] }, "tags": [], "updatedAt": "2019-09-19T10:00:00.000Z" }, "id": "string", "relationships": { "creator": { "data": { "id": "", "type": "users" } }, "owner": { "data": { "id": "", "type": "users" } }, "runAs": { "data": { "id": "", "type": "users" } } }, "type": "workflows" } ], "meta": { "page": { "totalCount": "integer", "totalFilteredCount": "integer" } } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/workflows" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ List workflows returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.workflow_automation_api import WorkflowAutomationApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = WorkflowAutomationApi(api_client) response = api_instance.list_workflows() print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # List workflows returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::WorkflowAutomationAPI.new p api_instance.list_workflows() ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // List workflows returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewWorkflowAutomationApi(apiClient) resp, r, err := api.ListWorkflows(ctx, *datadogV2.NewListWorkflowsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `WorkflowAutomationApi.ListWorkflows`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `WorkflowAutomationApi.ListWorkflows`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // List workflows returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.WorkflowAutomationApi; import com.datadog.api.client.v2.model.ListWorkflowsResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); WorkflowAutomationApi apiInstance = new WorkflowAutomationApi(defaultClient); try { ListWorkflowsResponse result = apiInstance.listWorkflows(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling WorkflowAutomationApi#listWorkflows"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // List workflows returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_workflow_automation::ListWorkflowsOptionalParams; use datadog_api_client::datadogV2::api_workflow_automation::WorkflowAutomationAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = WorkflowAutomationAPI::with_config(configuration); let resp = api .list_workflows(ListWorkflowsOptionalParams::default()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * List workflows returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.WorkflowAutomationApi(configuration); apiInstance .listWorkflows() .then((data: v2.ListWorkflowsResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}