You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Attributes of a workflow returned in a list response.
106623
+
properties:
106624
+
createdAt:
106625
+
description: When the workflow was created.
106626
+
format: date-time
106627
+
readOnly: true
106628
+
type: string
106629
+
description:
106630
+
description: Description of the workflow.
106631
+
type: string
106632
+
name:
106633
+
description: Name of the workflow.
106634
+
example: "My Workflow"
106635
+
type: string
106636
+
published:
106637
+
description: 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.
106638
+
type: boolean
106639
+
spec:
106640
+
$ref: "#/components/schemas/Spec"
106641
+
nullable: true
106642
+
tags:
106643
+
description: Tags of the workflow.
106644
+
items:
106645
+
description: A tag string in `key:value` format.
106646
+
type: string
106647
+
type: array
106648
+
updatedAt:
106649
+
description: When the workflow was last updated.
106650
+
format: date-time
106651
+
readOnly: true
106652
+
type: string
106653
+
required:
106654
+
- name
106655
+
type: object
106575
106656
WorkflowTriggerWrapper:
106576
106657
description: "Schema for a Workflow-based trigger."
106577
106658
properties:
@@ -188773,6 +188854,120 @@ paths:
188773
188854
- manage_log_reports
188774
188855
- product_analytics_saved_widgets_write
188775
188856
/api/v2/workflows:
188857
+
get:
188858
+
description: List all workflows in your organization. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
188859
+
operationId: ListWorkflows
188860
+
parameters:
188861
+
- description: The maximum number of workflows to return per page.
188862
+
example: 50
188863
+
in: query
188864
+
name: limit
188865
+
required: false
188866
+
schema:
188867
+
default: 50
188868
+
format: int64
188869
+
type: integer
188870
+
- description: The page number to return, starting from 0.
188871
+
example: 0
188872
+
in: query
188873
+
name: page
188874
+
required: false
188875
+
schema:
188876
+
default: 0
188877
+
format: int64
188878
+
type: integer
188879
+
- description: "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`."
188880
+
example: "-updatedAt"
188881
+
in: query
188882
+
name: sort
188883
+
required: false
188884
+
schema:
188885
+
type: string
188886
+
- description: "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."
188887
+
example: deploy
188888
+
in: query
188889
+
name: filter[query]
188890
+
required: false
188891
+
schema:
188892
+
type: string
188893
+
- description: Filters the returned workflows by one or more trigger types, such as `monitor`, `schedule`, or `githubWebhook`. To specify the multiple types, repeat this parameter.
188894
+
example:
188895
+
- monitor
188896
+
explode: true
188897
+
in: query
188898
+
name: filter[triggerIds]
188899
+
required: false
188900
+
schema:
188901
+
items:
188902
+
type: string
188903
+
type: array
188904
+
- description: Whether to include unpublished workflows in the response.
188905
+
in: query
188906
+
name: filter[includeUnpublished]
188907
+
required: false
188908
+
schema:
188909
+
default: false
188910
+
type: boolean
188911
+
- description: Whether to include the full spec of each workflow in the response. When `false` (the default), each workflow's `spec` is returned as `null`.
description: Create a new workflow, returning the workflow ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
0 commit comments