@@ -351,6 +351,13 @@ components:
351
351
required: true
352
352
schema:
353
353
type: string
354
+ InstanceId:
355
+ description: The ID of the workflow instance.
356
+ in: path
357
+ name: instance_id
358
+ required: true
359
+ schema:
360
+ type: string
354
361
MetricID:
355
362
description: The name of the log-based metric.
356
363
in: path
@@ -536,6 +543,13 @@ components:
536
543
schema:
537
544
example: 00000000-0000-9999-0000-000000000000
538
545
type: string
546
+ WorkflowId:
547
+ description: The ID of the workflow.
548
+ in: path
549
+ name: workflow_id
550
+ required: true
551
+ schema:
552
+ type: string
539
553
requestBodies: {}
540
554
responses:
541
555
BadRequestResponse:
@@ -23594,6 +23608,89 @@ components:
23594
23608
- PAST_SIX_MONTHS
23595
23609
- PAST_ONE_YEAR
23596
23610
- ALERT
23611
+ WorkflowInstanceCreateMeta:
23612
+ description: Additional information for creating a workflow instance.
23613
+ properties:
23614
+ payload:
23615
+ additionalProperties: {}
23616
+ description: The input parameters to the workflow.
23617
+ type: object
23618
+ type: object
23619
+ WorkflowInstanceCreateRequest:
23620
+ description: Request used to create a workflow instance.
23621
+ properties:
23622
+ meta:
23623
+ $ref: '#/components/schemas/WorkflowInstanceCreateMeta'
23624
+ type: object
23625
+ WorkflowInstanceCreateResponse:
23626
+ additionalProperties: {}
23627
+ description: Response returned upon successful workflow instance creation.
23628
+ properties:
23629
+ data:
23630
+ $ref: '#/components/schemas/WorkflowInstanceCreateResponseData'
23631
+ type: object
23632
+ WorkflowInstanceCreateResponseData:
23633
+ additionalProperties: {}
23634
+ description: Data about the created workflow instance.
23635
+ properties:
23636
+ id:
23637
+ description: The ID of the workflow execution. It can be used to fetch the
23638
+ execution status.
23639
+ type: string
23640
+ type: object
23641
+ WorkflowInstanceListItem:
23642
+ additionalProperties: {}
23643
+ description: An item in the workflow instances list.
23644
+ properties:
23645
+ id:
23646
+ description: The ID of the workflow instance
23647
+ type: string
23648
+ type: object
23649
+ WorkflowListInstancesResponse:
23650
+ additionalProperties: {}
23651
+ description: Response returned when listing workflow instances.
23652
+ properties:
23653
+ data:
23654
+ description: A list of workflow instances.
23655
+ items:
23656
+ $ref: '#/components/schemas/WorkflowInstanceListItem'
23657
+ type: array
23658
+ type: object
23659
+ WorklflowCancelInstanceResponse:
23660
+ description: Information about the canceled instance.
23661
+ properties:
23662
+ data:
23663
+ $ref: '#/components/schemas/WorklflowCancelInstanceResponseData'
23664
+ type: object
23665
+ WorklflowCancelInstanceResponseData:
23666
+ description: Data about the canceled instance.
23667
+ properties:
23668
+ id:
23669
+ description: The id of the canceled instance
23670
+ type: string
23671
+ type: object
23672
+ WorklflowGetInstanceResponse:
23673
+ additionalProperties: {}
23674
+ description: The state of the given workflow instance.
23675
+ properties:
23676
+ data:
23677
+ $ref: '#/components/schemas/WorklflowGetInstanceResponseData'
23678
+ type: object
23679
+ WorklflowGetInstanceResponseData:
23680
+ additionalProperties: {}
23681
+ description: The data of the instance response.
23682
+ properties:
23683
+ attributes:
23684
+ $ref: '#/components/schemas/WorklflowGetInstanceResponseDataAttributes'
23685
+ type: object
23686
+ WorklflowGetInstanceResponseDataAttributes:
23687
+ additionalProperties: {}
23688
+ description: The attributes of the instance response data.
23689
+ properties:
23690
+ id:
23691
+ description: The id of the instance.
23692
+ type: string
23693
+ type: object
23597
23694
securitySchemes:
23598
23695
AuthZ:
23599
23696
description: This API uses OAuth 2 with the implicit grant flow.
@@ -37501,6 +37598,148 @@ paths:
37501
37598
summary: Get user memberships
37502
37599
tags:
37503
37600
- Teams
37601
+ /api/v2/workflows/{workflow_id}/instances:
37602
+ get:
37603
+ description: List all instances of a given workflow.
37604
+ operationId: ListWorkflowInstances
37605
+ parameters:
37606
+ - $ref: '#/components/parameters/WorkflowId'
37607
+ - $ref: '#/components/parameters/PageSize'
37608
+ - $ref: '#/components/parameters/PageNumber'
37609
+ responses:
37610
+ '200':
37611
+ content:
37612
+ application/json:
37613
+ schema:
37614
+ $ref: '#/components/schemas/WorkflowListInstancesResponse'
37615
+ description: OK
37616
+ '400':
37617
+ content:
37618
+ application/json:
37619
+ schema:
37620
+ $ref: '#/components/schemas/APIErrorResponse'
37621
+ description: Bad Request
37622
+ '403':
37623
+ content:
37624
+ application/json:
37625
+ schema:
37626
+ $ref: '#/components/schemas/APIErrorResponse'
37627
+ description: Forbidden
37628
+ '429':
37629
+ $ref: '#/components/responses/TooManyRequestsResponse'
37630
+ summary: List workflow instances
37631
+ tags:
37632
+ - Workflow Automation
37633
+ post:
37634
+ description: Execute the given workflow
37635
+ operationId: CreateWorkflowInstance
37636
+ parameters:
37637
+ - $ref: '#/components/parameters/WorkflowId'
37638
+ requestBody:
37639
+ content:
37640
+ application/json:
37641
+ schema:
37642
+ $ref: '#/components/schemas/WorkflowInstanceCreateRequest'
37643
+ required: true
37644
+ responses:
37645
+ '200':
37646
+ content:
37647
+ application/json:
37648
+ schema:
37649
+ $ref: '#/components/schemas/WorkflowInstanceCreateResponse'
37650
+ description: Created
37651
+ '400':
37652
+ content:
37653
+ application/json:
37654
+ schema:
37655
+ $ref: '#/components/schemas/APIErrorResponse'
37656
+ description: Bad Request
37657
+ '403':
37658
+ content:
37659
+ application/json:
37660
+ schema:
37661
+ $ref: '#/components/schemas/APIErrorResponse'
37662
+ description: Forbidden
37663
+ '429':
37664
+ $ref: '#/components/responses/TooManyRequestsResponse'
37665
+ summary: Execute a workflow
37666
+ tags:
37667
+ - Workflow Automation
37668
+ x-codegen-request-body-name: body
37669
+ /api/v2/workflows/{workflow_id}/instances/{instance_id}:
37670
+ get:
37671
+ description: Get a specific execution of a given workflow.
37672
+ operationId: GetWorkflowInstance
37673
+ parameters:
37674
+ - $ref: '#/components/parameters/WorkflowId'
37675
+ - $ref: '#/components/parameters/InstanceId'
37676
+ responses:
37677
+ '200':
37678
+ content:
37679
+ application/json:
37680
+ schema:
37681
+ $ref: '#/components/schemas/WorklflowGetInstanceResponse'
37682
+ description: OK
37683
+ '400':
37684
+ content:
37685
+ application/json:
37686
+ schema:
37687
+ $ref: '#/components/schemas/APIErrorResponse'
37688
+ description: Bad Request
37689
+ '403':
37690
+ content:
37691
+ application/json:
37692
+ schema:
37693
+ $ref: '#/components/schemas/APIErrorResponse'
37694
+ description: Forbidden
37695
+ '404':
37696
+ content:
37697
+ application/json:
37698
+ schema:
37699
+ $ref: '#/components/schemas/APIErrorResponse'
37700
+ description: Not Found
37701
+ '429':
37702
+ $ref: '#/components/responses/TooManyRequestsResponse'
37703
+ summary: Get a workflow instance
37704
+ tags:
37705
+ - Workflow Automation
37706
+ /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel:
37707
+ put:
37708
+ description: Cancels a specific execution of a given workflow.
37709
+ operationId: CancelWorkflowInstance
37710
+ parameters:
37711
+ - $ref: '#/components/parameters/WorkflowId'
37712
+ - $ref: '#/components/parameters/InstanceId'
37713
+ responses:
37714
+ '200':
37715
+ content:
37716
+ application/json:
37717
+ schema:
37718
+ $ref: '#/components/schemas/WorklflowCancelInstanceResponse'
37719
+ description: OK
37720
+ '400':
37721
+ content:
37722
+ application/json:
37723
+ schema:
37724
+ $ref: '#/components/schemas/APIErrorResponse'
37725
+ description: Bad Request
37726
+ '403':
37727
+ content:
37728
+ application/json:
37729
+ schema:
37730
+ $ref: '#/components/schemas/APIErrorResponse'
37731
+ description: Forbidden
37732
+ '404':
37733
+ content:
37734
+ application/json:
37735
+ schema:
37736
+ $ref: '#/components/schemas/APIErrorResponse'
37737
+ description: Not Found
37738
+ '429':
37739
+ $ref: '#/components/responses/TooManyRequestsResponse'
37740
+ summary: Cancel a workflow instance
37741
+ tags:
37742
+ - Workflow Automation
37504
37743
security:
37505
37744
- apiKeyAuth: []
37506
37745
appKeyAuth: []
@@ -37872,4 +38111,9 @@ tags:
37872
38111
externalDocs:
37873
38112
url: https://docs.datadoghq.com/account_management/users
37874
38113
name: Users
38114
+ - description: Automate your teams operational processes with Datadog Workflow Automation.
38115
+ externalDocs:
38116
+ description: Find out more at
38117
+ url: https://docs.datadoghq.com/service_management/workflows/
38118
+ name: Workflow Automation
37875
38119
x-group-parameters: true
0 commit comments