openapi: 3.0.0 info: contact: email: support@datadoghq.com name: Datadog Support url: https://www.datadoghq.com/support/ description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically. title: Datadog Account Workflows API version: '1.0' servers: - url: https://{subdomain}.{site} variables: site: default: datadoghq.com description: The regional site for Datadog customers. enum: - datadoghq.com - us3.datadoghq.com - us5.datadoghq.com - ap1.datadoghq.com - datadoghq.eu - ddog-gov.com subdomain: default: api description: The subdomain where the API is deployed. - url: '{protocol}://{name}' variables: name: default: api.datadoghq.com description: Full site DNS name. protocol: default: https description: The protocol for accessing the API. - url: https://{subdomain}.{site} variables: site: default: datadoghq.com description: Any Datadog deployment. subdomain: default: api description: The subdomain where the API is deployed. security: - apiKeyAuth: [] appKeyAuth: [] tags: - name: Workflows paths: /api/v2/integration/ms-teams/configuration/workflows-webhook-handles: get: description: Get a list of all Workflows webhook handles from the Datadog Microsoft Teams integration. operationId: ListWorkflowsWebhookHandles parameters: - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleNameQueryParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandlesResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '412': $ref: '#/components/responses/PreconditionFailedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Get All Workflows Webhook Handles tags: - Workflows x-menu-order: 1 x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Create a Workflows webhook handle in the Datadog Microsoft Teams integration. operationId: CreateWorkflowsWebhookHandle requestBody: content: application/json: schema: $ref: '#/components/schemas/MicrosoftTeamsCreateWorkflowsWebhookHandleRequest' description: Workflows Webhook handle payload. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse' description: CREATED '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '409': $ref: '#/components/responses/ConflictResponse' '412': $ref: '#/components/responses/PreconditionFailedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Create Workflows Webhook Handle tags: - Workflows x-codegen-request-body-name: body x-given: workflows_webhook_handle: parameters: - name: body value: "{\n \"data\": {\n \"attributes\": {\n \"name\": \"{{ unique }}\",\n \"url\": \"https://prod-100.westus.logic.azure.com:443/workflows/abcd1234\"\n },\n \"type\": \"workflows-webhook-handle\"\n }\n}" step: there is a valid "workflows_webhook_handle" in the system x-menu-order: 1 x-undo: operationId: DeleteWorkflowsWebhookHandle parameters: - name: handle_id source: data.id type: unsafe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/integration/ms-teams/configuration/workflows-webhook-handles/{handle_id}: delete: description: Delete a Workflows webhook handle from the Datadog Microsoft Teams integration. operationId: DeleteWorkflowsWebhookHandle parameters: - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter' responses: '204': description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '412': $ref: '#/components/responses/PreconditionFailedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Delete Workflows Webhook Handle tags: - Workflows x-menu-order: 1 x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: Get the name of a Workflows webhook handle from the Datadog Microsoft Teams integration. operationId: GetWorkflowsWebhookHandle parameters: - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter' responses: '200': content: application/json: schema: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '412': $ref: '#/components/responses/PreconditionFailedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Get Workflows Webhook Handle Information tags: - Workflows x-menu-order: 1 x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: description: Update a Workflows webhook handle from the Datadog Microsoft Teams integration. operationId: UpdateWorkflowsWebhookHandle parameters: - $ref: '#/components/parameters/MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter' requestBody: content: application/json: schema: $ref: '#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest' description: Workflows Webhook handle payload. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '409': $ref: '#/components/responses/ConflictResponse' '412': $ref: '#/components/responses/PreconditionFailedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Update Workflows Webhook Handle tags: - Workflows x-codegen-request-body-name: body x-menu-order: 1 x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/workflows: post: description: Create a new workflow, returning the workflow ID. This API requires an application key scoped with the `workflows_write` permission. operationId: CreateWorkflow requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWorkflowRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreateWorkflowResponse' description: Successfully created a workflow. '400': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Forbidden '429': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Too many requests summary: Datadog Create a Workflow tags: - Workflows x-given: workflow: parameters: - name: body value: "{\n \"data\": {\n \"type\": \"workflows\",\n \"attributes\": {\n \"name\": \"Cassette Workflow x-given\",\n \"spec\": {\n \"triggers\": [\n {\n \"startStepNames\": [\"No_op\"],\n \"workflowTrigger\": {}\n }\n ],\n \"steps\": [\n {\n \"name\": \"No_op\",\n \"actionId\": \"com.datadoghq.core.noop\"\n }\n ]\n }\n }\n }\n}" step: there is a valid "workflow" in the system x-menu-order: 2 x-permission: operator: OR permissions: - workflows_write x-undo: operationId: DeleteWorkflow parameters: - name: workflow_id source: data.id type: unsafe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/workflows/{workflow_id}: delete: description: Delete a workflow by ID. This API requires an application key scoped with the `workflows_write` permission. operationId: DeleteWorkflow parameters: - $ref: '#/components/parameters/WorkflowId' responses: '204': description: Successfully deleted a workflow. '403': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Not found '429': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Too many requests summary: Datadog Delete an Existing Workflow tags: - Workflows x-menu-order: 4 x-permission: operator: OR permissions: - workflows_write x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: Get a workflow by ID. This API requires an application key scoped with the `workflows_read` permission. operationId: GetWorkflow parameters: - $ref: '#/components/parameters/WorkflowId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetWorkflowResponse' description: Successfully got a workflow. '400': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Not found '429': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Too many requests summary: Datadog Get an Existing Workflow tags: - Workflows x-menu-order: 1 x-permission: operator: OR permissions: - workflows_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: description: Update a workflow by ID. This API requires an application key scoped with the `workflows_write` permission. operationId: UpdateWorkflow parameters: - $ref: '#/components/parameters/WorkflowId' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowResponse' description: Successfully updated a workflow. '400': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Bad request '403': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Not found '429': content: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' description: Too many requests summary: Datadog Update an Existing Workflow tags: - Workflows x-menu-order: 3 x-permission: operator: OR permissions: - workflows_write x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/workflows/{workflow_id}/instances: get: description: List all instances of a given workflow. This API requires an application key scoped with the workflows_read permission. operationId: ListWorkflowInstances parameters: - $ref: '#/components/parameters/WorkflowId' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageNumber' responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkflowListInstancesResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - workflows_read summary: Datadog List Workflow Instances tags: - Workflows x-menu-order: 5 x-permission: operator: OR permissions: - workflows_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Execute the given workflow. This API requires an application key scoped with the workflows_run permission. operationId: CreateWorkflowInstance parameters: - $ref: '#/components/parameters/WorkflowId' requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowInstanceCreateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkflowInstanceCreateResponse' description: Created '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - workflows_run summary: Datadog Execute a Workflow tags: - Workflows x-codegen-request-body-name: body x-menu-order: 6 x-permission: operator: OR permissions: - workflows_run x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/workflows/{workflow_id}/instances/{instance_id}: get: description: Get a specific execution of a given workflow. This API requires an application key scoped with the workflows_read permission. operationId: GetWorkflowInstance parameters: - $ref: '#/components/parameters/WorkflowId' - $ref: '#/components/parameters/InstanceId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorklflowGetInstanceResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: - workflows_read summary: Datadog Get a Workflow Instance tags: - Workflows x-menu-order: 7 x-permission: operator: OR permissions: - workflows_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel: put: description: Cancels a specific execution of a given workflow. This API requires an application key scoped with the workflows_run permission. operationId: CancelWorkflowInstance parameters: - $ref: '#/components/parameters/WorkflowId' - $ref: '#/components/parameters/InstanceId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorklflowCancelInstanceResponse' description: OK '400': $ref: '#/components/responses/BadRequestResponse' '403': $ref: '#/components/responses/ForbiddenResponse' '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Cancel a Workflow Instance tags: - Workflows x-menu-order: 8 x-permission: operator: OR permissions: - workflows_run x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: Annotation: description: A list of annotations used in the workflow. These are like sticky notes for your workflow! properties: display: $ref: '#/components/schemas/AnnotationDisplay' id: description: The `Annotation` `id`. example: '' type: string markdownTextAnnotation: $ref: '#/components/schemas/AnnotationMarkdownTextAnnotation' required: - id - display - markdownTextAnnotation type: object SoftwareCatalogTriggerWrapper: description: Schema for a Software Catalog-based trigger. properties: softwareCatalogTrigger: description: Trigger a workflow from Software Catalog. type: object startStepNames: $ref: '#/components/schemas/StartStepNames' required: - softwareCatalogTrigger type: object MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest: description: Update Workflows webhook handle request. properties: data: $ref: '#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData' required: - data type: object WorkflowDataUpdate: description: Data related to the workflow being updated. properties: attributes: $ref: '#/components/schemas/WorkflowDataUpdateAttributes' id: description: The workflow identifier type: string example: abc-123-def relationships: $ref: '#/components/schemas/WorkflowDataRelationships' type: $ref: '#/components/schemas/WorkflowDataType' required: - type - attributes type: object APITrigger: description: Trigger a workflow from an API request. The workflow must be published. properties: rateLimit: $ref: '#/components/schemas/TriggerRateLimit' type: object StartStepNames: description: A list of steps that run first after a trigger fires. example: - '' items: description: The `StartStepNames` `items`. type: string type: array UpdateWorkflowRequest: description: A request object for updating an existing workflow. example: data: attributes: description: A sample workflow. name: Example Workflow published: true spec: annotations: - display: bounds: height: 150 width: 300 x: -375 y: -0.5 id: 99999999-9999-9999-9999-999999999999 markdownTextAnnotation: text: Example annotation. connectionEnvs: - connections: - connectionId: 11111111-1111-1111-1111-111111111111 label: INTEGRATION_DATADOG env: default handle: my-handle inputSchema: parameters: - defaultValue: default name: input type: STRING outputSchema: parameters: - name: output type: ARRAY_OBJECT value: '{{ Steps.Step1 }}' steps: - actionId: com.datadoghq.dd.monitor.listMonitors connectionLabel: INTEGRATION_DATADOG name: Step1 outboundEdges: - branchName: main nextStepName: Step2 parameters: - name: tags value: service:monitoring - actionId: com.datadoghq.core.noop name: Step2 triggers: - monitorTrigger: rateLimit: count: 1 interval: 3600s startStepNames: - Step1 - githubWebhookTrigger: {} startStepNames: - Step1 tags: - team:infra - service:monitoring - foo:bar id: 22222222-2222-2222-2222-222222222222 type: workflows properties: data: $ref: '#/components/schemas/WorkflowDataUpdate' required: - data type: object JSONAPIErrorItem: description: API error response body properties: detail: description: A human-readable explanation specific to this occurrence of the error. example: Missing required attribute in body type: string meta: additionalProperties: {} description: Non-standard meta-information about the error type: object source: $ref: '#/components/schemas/JSONAPIErrorItemSource' status: description: Status code of the response. example: '400' type: string title: description: Short human-readable summary of the error. example: Bad Request type: string type: object OutputSchemaParametersType: description: The definition of `OutputSchemaParametersType` object. enum: - STRING - NUMBER - BOOLEAN - OBJECT - ARRAY_STRING - ARRAY_NUMBER - ARRAY_BOOLEAN - ARRAY_OBJECT example: STRING type: string x-enum-varnames: - STRING - NUMBER - BOOLEAN - OBJECT - ARRAY_STRING - ARRAY_NUMBER - ARRAY_BOOLEAN - ARRAY_OBJECT GithubWebhookTrigger: description: 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. properties: rateLimit: $ref: '#/components/schemas/TriggerRateLimit' type: object WorklflowGetInstanceResponse: additionalProperties: {} description: The state of the given workflow instance. properties: data: $ref: '#/components/schemas/WorklflowGetInstanceResponseData' type: object CreateWorkflowResponse: description: The response object after creating a new workflow. properties: data: $ref: '#/components/schemas/WorkflowData' required: - data type: object MicrosoftTeamsWorkflowsWebhookHandlesResponse: description: Response with a list of Workflows webhook handles. properties: data: description: An array of Workflows webhook handles. example: - attributes: name: general-handle id: 596da4af-0563-4097-90ff-07230c3f9db3 type: workflows-webhook-handle - attributes: name: general-handle-2 id: 596da4af-0563-4097-90ff-07230c3f9db4 type: workflows-webhook-handle items: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData' type: array required: - data type: object StepDisplayBounds: description: The definition of `StepDisplayBounds` object. properties: x: description: The `bounds` `x`. format: double type: number example: 95.5 y: description: The `bounds` `y`. format: double type: number example: 95.5 type: object MicrosoftTeamsWorkflowsWebhookHandleAttributes: description: Workflows Webhook handle attributes. properties: name: description: Workflows Webhook handle name. example: fake-handle-name maxLength: 255 type: string url: description: Workflows Webhook URL. example: https://fake.url.com maxLength: 255 type: string type: object JSONAPIErrorResponse: description: API error response. properties: errors: description: A list of errors. items: $ref: '#/components/schemas/JSONAPIErrorItem' type: array required: - errors type: object InputSchema: description: A list of input parameters for the workflow. These can be used as dynamic runtime values in your workflow. properties: parameters: description: The `InputSchema` `parameters`. items: $ref: '#/components/schemas/InputSchemaParameters' type: array type: object CaseTrigger: description: Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published. properties: rateLimit: $ref: '#/components/schemas/TriggerRateLimit' type: object AppTriggerWrapper: description: Schema for an App-based trigger. properties: appTrigger: description: Trigger a workflow from an App. type: object startStepNames: $ref: '#/components/schemas/StartStepNames' required: - appTrigger type: object WorklflowCancelInstanceResponse: description: Information about the canceled instance. properties: data: $ref: '#/components/schemas/WorklflowCancelInstanceResponseData' type: object WorkflowTriggerWrapper: description: Schema for a Workflow-based trigger. properties: startStepNames: $ref: '#/components/schemas/StartStepNames' workflowTrigger: description: Trigger a workflow from the Datadog UI. Only required if no other trigger exists. type: object required: - workflowTrigger type: object GithubWebhookTriggerWrapper: description: Schema for a GitHub webhook-based trigger. properties: githubWebhookTrigger: $ref: '#/components/schemas/GithubWebhookTrigger' startStepNames: $ref: '#/components/schemas/StartStepNames' required: - githubWebhookTrigger type: object Trigger: description: One of the triggers that can start the execution of a workflow. oneOf: - $ref: '#/components/schemas/APITriggerWrapper' - $ref: '#/components/schemas/AppTriggerWrapper' - $ref: '#/components/schemas/CaseTriggerWrapper' - $ref: '#/components/schemas/ChangeEventTriggerWrapper' - $ref: '#/components/schemas/DatabaseMonitoringTriggerWrapper' - $ref: '#/components/schemas/DashboardTriggerWrapper' - $ref: '#/components/schemas/GithubWebhookTriggerWrapper' - $ref: '#/components/schemas/IncidentTriggerWrapper' - $ref: '#/components/schemas/MonitorTriggerWrapper' - $ref: '#/components/schemas/NotebookTriggerWrapper' - $ref: '#/components/schemas/ScheduleTriggerWrapper' - $ref: '#/components/schemas/SecurityTriggerWrapper' - $ref: '#/components/schemas/SelfServiceTriggerWrapper' - $ref: '#/components/schemas/SlackTriggerWrapper' - $ref: '#/components/schemas/SoftwareCatalogTriggerWrapper' - $ref: '#/components/schemas/WorkflowTriggerWrapper' UpdateWorkflowResponse: description: The response object after updating a workflow. properties: data: $ref: '#/components/schemas/WorkflowDataUpdate' type: object StepDisplay: description: The definition of `StepDisplay` object. properties: bounds: $ref: '#/components/schemas/StepDisplayBounds' type: object MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes: description: Workflows Webhook handle attributes. properties: name: description: Workflows Webhook handle name. example: fake-handle-name maxLength: 255 type: string url: description: Workflows Webhook URL. example: https://fake.url.com maxLength: 255 type: string required: - name - url type: object WorkflowDataUpdateAttributes: description: The definition of `WorkflowDataUpdateAttributes` object. properties: createdAt: description: When the workflow was created. format: date-time readOnly: true type: string example: example_value description: description: Description of the workflow. type: string example: example_value name: description: Name of the workflow. type: string example: Example Monitor published: description: Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published. type: boolean example: true spec: $ref: '#/components/schemas/Spec' tags: description: Tags of the workflow. items: type: string type: array updatedAt: description: When the workflow was last updated. format: date-time readOnly: true type: string example: '2026-04-17T12:00:00Z' webhookSecret: description: If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here. type: string writeOnly: true example: example_value type: object TriggerRateLimit: description: Defines a rate limit for a trigger. properties: count: description: The `TriggerRateLimit` `count`. format: int64 type: integer example: 42 interval: description: The `TriggerRateLimit` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s type: string example: example_value type: object ConnectionEnvEnv: description: The definition of `ConnectionEnvEnv` object. enum: - default example: default type: string x-enum-varnames: - DEFAULT MicrosoftTeamsWorkflowsWebhookHandleResponseData: description: Workflows Webhook handle data from a response. properties: attributes: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookResponseAttributes' id: description: The ID of the Workflows webhook handle. example: 596da4af-0563-4097-90ff-07230c3f9db3 maxLength: 100 minLength: 1 type: string type: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType' type: object WorkflowInstanceListItem: additionalProperties: {} description: An item in the workflow instances list. properties: id: description: The ID of the workflow instance type: string example: abc-123-def type: object DatabaseMonitoringTriggerWrapper: description: Schema for a Database Monitoring-based trigger. properties: databaseMonitoringTrigger: description: Trigger a workflow from Database Monitoring. type: object startStepNames: $ref: '#/components/schemas/StartStepNames' required: - databaseMonitoringTrigger type: object WorkflowListInstancesResponse: additionalProperties: {} description: Response returned when listing workflow instances. properties: data: description: A list of workflow instances. items: $ref: '#/components/schemas/WorkflowInstanceListItem' type: array meta: $ref: '#/components/schemas/WorkflowListInstancesResponseMeta' type: object AnnotationDisplay: description: The definition of `AnnotationDisplay` object. properties: bounds: $ref: '#/components/schemas/AnnotationDisplayBounds' type: object ScheduleTriggerWrapper: description: Schema for a Schedule-based trigger. properties: scheduleTrigger: $ref: '#/components/schemas/ScheduleTrigger' startStepNames: $ref: '#/components/schemas/StartStepNames' required: - scheduleTrigger type: object WorkflowInstanceCreateMeta: description: Additional information for creating a workflow instance. properties: payload: additionalProperties: {} description: The input parameters to the workflow. type: object type: object JSONAPIErrorItemSource: description: References to the source of the error. properties: header: description: A string indicating the name of a single request header which caused the error. example: Authorization type: string parameter: description: A string indicating which URI query parameter caused the error. example: limit type: string pointer: description: A JSON pointer to the value in the request document that caused the error. example: /data/attributes/title type: string type: object WorkflowListInstancesResponseMetaPage: additionalProperties: {} description: Page information for the list instances response. properties: totalCount: description: The total count of items. format: int64 type: integer example: 42 type: object SecurityTriggerWrapper: description: Schema for a Security-based trigger. properties: securityTrigger: $ref: '#/components/schemas/SecurityTrigger' startStepNames: $ref: '#/components/schemas/StartStepNames' required: - securityTrigger type: object WorkflowDataAttributes: description: The definition of `WorkflowDataAttributes` object. properties: createdAt: description: When the workflow was created. format: date-time readOnly: true type: string example: example_value description: description: Description of the workflow. type: string example: example_value name: description: Name of the workflow. example: '' type: string published: description: Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published. type: boolean example: true spec: $ref: '#/components/schemas/Spec' tags: description: Tags of the workflow. items: type: string type: array updatedAt: description: When the workflow was last updated. format: date-time readOnly: true type: string example: '2026-04-17T12:00:00Z' webhookSecret: description: If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here. type: string writeOnly: true example: example_value required: - name - spec type: object IncidentTrigger: description: Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published. properties: rateLimit: $ref: '#/components/schemas/TriggerRateLimit' type: object ConnectionGroup: description: The definition of `ConnectionGroup` object. properties: connectionGroupId: description: The `ConnectionGroup` `connectionGroupId`. example: '' type: string label: description: The `ConnectionGroup` `label`. example: '' type: string tags: description: The `ConnectionGroup` `tags`. example: - '' items: type: string type: array required: - connectionGroupId - label - tags type: object ReadinessGateThresholdType: description: The definition of `ReadinessGateThresholdType` object. enum: - ANY - ALL example: ANY type: string x-enum-varnames: - ANY - ALL AnnotationMarkdownTextAnnotation: description: The definition of `AnnotationMarkdownTextAnnotation` object. properties: text: description: The `markdownTextAnnotation` `text`. type: string example: example_value type: object WorklflowGetInstanceResponseData: additionalProperties: {} description: The data of the instance response. properties: attributes: $ref: '#/components/schemas/WorklflowGetInstanceResponseDataAttributes' type: object SelfServiceTriggerWrapper: description: Schema for a Self Service-based trigger. properties: selfServiceTrigger: description: Trigger a workflow from Self Service. type: object startStepNames: $ref: '#/components/schemas/StartStepNames' required: - selfServiceTrigger type: object OutputSchemaParameters: description: The definition of `OutputSchemaParameters` object. properties: defaultValue: description: The `OutputSchemaParameters` `defaultValue`. example: example_value description: description: The `OutputSchemaParameters` `description`. type: string example: example_value label: description: The `OutputSchemaParameters` `label`. type: string example: example_value name: description: The `OutputSchemaParameters` `name`. example: '' type: string type: $ref: '#/components/schemas/OutputSchemaParametersType' value: description: The `OutputSchemaParameters` `value`. example: example_value required: - name - type type: object SecurityTrigger: description: Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published. properties: rateLimit: $ref: '#/components/schemas/TriggerRateLimit' type: object CaseTriggerWrapper: description: Schema for a Case-based trigger. properties: caseTrigger: $ref: '#/components/schemas/CaseTrigger' startStepNames: $ref: '#/components/schemas/StartStepNames' required: - caseTrigger type: object WorklflowGetInstanceResponseDataAttributes: additionalProperties: {} description: The attributes of the instance response data. properties: id: description: The id of the instance. type: string example: abc-123-def type: object MonitorTrigger: description: Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published. properties: rateLimit: $ref: '#/components/schemas/TriggerRateLimit' type: object WorkflowDataRelationships: description: The definition of `WorkflowDataRelationships` object. properties: creator: $ref: '#/components/schemas/WorkflowUserRelationship' owner: $ref: '#/components/schemas/WorkflowUserRelationship' readOnly: true type: object MicrosoftTeamsCreateWorkflowsWebhookHandleRequest: description: Create Workflows webhook handle request. properties: data: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestData' required: - data type: object APIErrorResponse: description: API error response. properties: errors: description: A list of errors. example: - Bad Request items: description: A list of items. example: Bad Request type: string type: array required: - errors type: object WorkflowListInstancesResponseMeta: additionalProperties: {} description: Metadata about the instances list properties: page: $ref: '#/components/schemas/WorkflowListInstancesResponseMetaPage' type: object RetryStrategyLinear: description: The definition of `RetryStrategyLinear` object. properties: interval: description: The `RetryStrategyLinear` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s example: '' type: string maxRetries: description: The `RetryStrategyLinear` `maxRetries`. example: 0 format: double type: number required: - interval - maxRetries type: object WorkflowUserRelationshipType: description: The definition of `WorkflowUserRelationshipType` object. enum: - users example: users type: string x-enum-varnames: - USERS CompletionCondition: description: The definition of `CompletionCondition` object. properties: operand1: description: The `CompletionCondition` `operand1`. example: example_value operand2: description: The `CompletionCondition` `operand2`. example: example_value operator: $ref: '#/components/schemas/CompletionConditionOperator' required: - operand1 - operator type: object CompletionConditionOperator: description: The definition of `CompletionConditionOperator` object. enum: - 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 - OPERATOR_IS_EMPTY - OPERATOR_IS_NOT_EMPTY example: OPERATOR_EQUAL type: string x-enum-varnames: - 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 - OPERATOR_IS_EMPTY - OPERATOR_IS_NOT_EMPTY OutputSchema: description: A list of output parameters for the workflow. properties: parameters: description: The `OutputSchema` `parameters`. items: $ref: '#/components/schemas/OutputSchemaParameters' type: array type: object InputSchemaParameters: description: The definition of `InputSchemaParameters` object. properties: defaultValue: description: The `InputSchemaParameters` `defaultValue`. example: example_value description: description: The `InputSchemaParameters` `description`. type: string example: example_value label: description: The `InputSchemaParameters` `label`. type: string example: example_value name: description: The `InputSchemaParameters` `name`. example: '' type: string type: $ref: '#/components/schemas/InputSchemaParametersType' required: - name - type type: object ConnectionEnv: description: A list of connections or connection groups used in the workflow. properties: connectionGroups: description: The `ConnectionEnv` `connectionGroups`. items: $ref: '#/components/schemas/ConnectionGroup' type: array connections: description: The `ConnectionEnv` `connections`. items: $ref: '#/components/schemas/Connection' type: array env: $ref: '#/components/schemas/ConnectionEnvEnv' required: - env type: object WorkflowInstanceCreateRequest: description: Request used to create a workflow instance. properties: meta: $ref: '#/components/schemas/WorkflowInstanceCreateMeta' type: object WorkflowInstanceCreateResponseData: additionalProperties: {} description: Data about the created workflow instance. properties: id: description: The ID of the workflow execution. It can be used to fetch the execution status. type: string example: abc-123-def type: object MicrosoftTeamsWorkflowsWebhookHandleType: default: workflows-webhook-handle description: Specifies the Workflows webhook handle resource type. enum: - workflows-webhook-handle example: workflows-webhook-handle type: string x-enum-varnames: - WORKFLOWS_WEBHOOK_HANDLE InputSchemaParametersType: description: The definition of `InputSchemaParametersType` object. enum: - STRING - NUMBER - BOOLEAN - OBJECT - ARRAY_STRING - ARRAY_NUMBER - ARRAY_BOOLEAN - ARRAY_OBJECT example: STRING type: string x-enum-varnames: - STRING - NUMBER - BOOLEAN - OBJECT - ARRAY_STRING - ARRAY_NUMBER - ARRAY_BOOLEAN - ARRAY_OBJECT Parameter: description: The definition of `Parameter` object. properties: name: description: The `Parameter` `name`. example: '' type: string value: description: The `Parameter` `value`. example: example_value required: - name - value type: object WorkflowDataType: description: The definition of `WorkflowDataType` object. enum: - workflows example: workflows type: string x-enum-varnames: - WORKFLOWS DashboardTriggerWrapper: description: Schema for a Dashboard-based trigger. properties: dashboardTrigger: description: Trigger a workflow from a Dashboard. type: object startStepNames: $ref: '#/components/schemas/StartStepNames' required: - dashboardTrigger type: object WorkflowInstanceCreateResponse: additionalProperties: {} description: Response returned upon successful workflow instance creation. properties: data: $ref: '#/components/schemas/WorkflowInstanceCreateResponseData' type: object Connection: description: The definition of `Connection` object. properties: connectionId: description: The `Connection` `connectionId`. example: '' type: string label: description: The `Connection` `label`. example: '' type: string required: - connectionId - label type: object ReadinessGate: description: Used to merge multiple branches into a single branch. properties: thresholdType: $ref: '#/components/schemas/ReadinessGateThresholdType' required: - thresholdType type: object ChangeEventTriggerWrapper: description: Schema for a Change Event-based trigger. properties: changeEventTrigger: description: Trigger a workflow from a Change Event. type: object startStepNames: $ref: '#/components/schemas/StartStepNames' required: - changeEventTrigger type: object OutboundEdge: description: The definition of `OutboundEdge` object. properties: branchName: description: The `OutboundEdge` `branchName`. example: '' type: string nextStepName: description: The `OutboundEdge` `nextStepName`. example: '' type: string required: - nextStepName - branchName type: object APITriggerWrapper: description: Schema for an API-based trigger. properties: apiTrigger: $ref: '#/components/schemas/APITrigger' startStepNames: $ref: '#/components/schemas/StartStepNames' required: - apiTrigger type: object AnnotationDisplayBounds: description: The definition of `AnnotationDisplayBounds` object. properties: height: description: The `bounds` `height`. format: double type: number example: 95.5 width: description: The `bounds` `width`. format: double type: number example: 95.5 x: description: The `bounds` `x`. format: double type: number example: 95.5 y: description: The `bounds` `y`. format: double type: number example: 95.5 type: object NotebookTriggerWrapper: description: Schema for a Notebook-based trigger. properties: notebookTrigger: description: Trigger a workflow from a Notebook. type: object startStepNames: $ref: '#/components/schemas/StartStepNames' required: - notebookTrigger type: object WorkflowData: description: Data related to the workflow. properties: attributes: $ref: '#/components/schemas/WorkflowDataAttributes' id: description: The workflow identifier readOnly: true type: string example: abc-123-def relationships: $ref: '#/components/schemas/WorkflowDataRelationships' type: $ref: '#/components/schemas/WorkflowDataType' required: - type - attributes type: object MicrosoftTeamsWorkflowsWebhookHandleResponse: description: Response of a Workflows webhook handle. properties: data: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData' required: - data type: object CreateWorkflowRequest: description: A request object for creating a new workflow. example: data: attributes: description: A sample workflow. name: Example Workflow published: true spec: annotations: - display: bounds: height: 150 width: 300 x: -375 y: -0.5 id: 99999999-9999-9999-9999-999999999999 markdownTextAnnotation: text: Example annotation. connectionEnvs: - connections: - connectionId: 11111111-1111-1111-1111-111111111111 label: INTEGRATION_DATADOG env: default handle: my-handle inputSchema: parameters: - defaultValue: default name: input type: STRING outputSchema: parameters: - name: output type: ARRAY_OBJECT value: '{{ Steps.Step1 }}' steps: - actionId: com.datadoghq.dd.monitor.listMonitors connectionLabel: INTEGRATION_DATADOG name: Step1 outboundEdges: - branchName: main nextStepName: Step2 parameters: - name: tags value: service:monitoring - actionId: com.datadoghq.core.noop name: Step2 triggers: - monitorTrigger: rateLimit: count: 1 interval: 3600s startStepNames: - Step1 - githubWebhookTrigger: {} startStepNames: - Step1 tags: - team:infra - service:monitoring - foo:bar type: workflows properties: data: $ref: '#/components/schemas/WorkflowData' required: - data type: object WorkflowUserRelationship: description: The definition of `WorkflowUserRelationship` object. properties: data: $ref: '#/components/schemas/WorkflowUserRelationshipData' type: object WorkflowUserRelationshipData: description: The definition of `WorkflowUserRelationshipData` object. properties: id: description: The user identifier example: '' type: string type: $ref: '#/components/schemas/WorkflowUserRelationshipType' required: - type - id type: object MicrosoftTeamsWorkflowsWebhookHandleRequestData: description: Workflows Webhook handle data from a response. properties: attributes: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes' type: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType' required: - type - attributes type: object IncidentTriggerWrapper: description: Schema for an Incident-based trigger. properties: incidentTrigger: $ref: '#/components/schemas/IncidentTrigger' startStepNames: $ref: '#/components/schemas/StartStepNames' required: - incidentTrigger type: object SlackTriggerWrapper: description: Schema for a Slack-based trigger. properties: slackTrigger: description: Trigger a workflow from Slack. The workflow must be published. type: object startStepNames: $ref: '#/components/schemas/StartStepNames' required: - slackTrigger type: object RetryStrategy: description: The definition of `RetryStrategy` object. properties: kind: $ref: '#/components/schemas/RetryStrategyKind' linear: $ref: '#/components/schemas/RetryStrategyLinear' required: - kind type: object MicrosoftTeamsWorkflowsWebhookResponseAttributes: description: Workflows Webhook handle attributes. properties: name: description: Workflows Webhook handle name. example: fake-handle-name maxLength: 255 type: string type: object RetryStrategyKind: description: The definition of `RetryStrategyKind` object. enum: - RETRY_STRATEGY_LINEAR example: RETRY_STRATEGY_LINEAR type: string x-enum-varnames: - RETRY_STRATEGY_LINEAR ErrorHandler: description: Used to handle errors in an action. properties: fallbackStepName: description: The `ErrorHandler` `fallbackStepName`. example: '' type: string retryStrategy: $ref: '#/components/schemas/RetryStrategy' required: - retryStrategy - fallbackStepName type: object MonitorTriggerWrapper: description: Schema for a Monitor-based trigger. properties: monitorTrigger: $ref: '#/components/schemas/MonitorTrigger' startStepNames: $ref: '#/components/schemas/StartStepNames' required: - monitorTrigger type: object MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData: description: Workflows Webhook handle data from a response. properties: attributes: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleAttributes' type: $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType' required: - type - attributes type: object CompletionGate: description: Used to create conditions before running subsequent actions. properties: completionCondition: $ref: '#/components/schemas/CompletionCondition' retryStrategy: $ref: '#/components/schemas/RetryStrategy' required: - completionCondition - retryStrategy type: object WorklflowCancelInstanceResponseData: description: Data about the canceled instance. properties: id: description: The id of the canceled instance type: string example: abc-123-def type: object Spec: description: The spec defines what the workflow does. properties: annotations: description: A list of annotations used in the workflow. These are like sticky notes for your workflow! items: $ref: '#/components/schemas/Annotation' type: array connectionEnvs: description: A list of connections or connection groups used in the workflow. items: $ref: '#/components/schemas/ConnectionEnv' type: array handle: description: Unique identifier used to trigger workflows automatically in Datadog. type: string example: example_value inputSchema: $ref: '#/components/schemas/InputSchema' outputSchema: $ref: '#/components/schemas/OutputSchema' steps: description: A `Step` is a sub-component of a workflow. Each `Step` performs an action. items: $ref: '#/components/schemas/Step' type: array triggers: description: The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once. items: $ref: '#/components/schemas/Trigger' type: array type: object Step: description: A Step is a sub-component of a workflow. Each Step performs an action. properties: actionId: description: The unique identifier of an action. example: '' type: string completionGate: $ref: '#/components/schemas/CompletionGate' connectionLabel: description: The unique identifier of a connection defined in the spec. type: string example: example_value display: $ref: '#/components/schemas/StepDisplay' errorHandlers: description: The `Step` `errorHandlers`. items: $ref: '#/components/schemas/ErrorHandler' type: array name: description: Name of the step. example: '' type: string outboundEdges: description: A list of subsequent actions to run. items: $ref: '#/components/schemas/OutboundEdge' type: array parameters: description: A list of inputs for an action. items: $ref: '#/components/schemas/Parameter' type: array readinessGate: $ref: '#/components/schemas/ReadinessGate' required: - name - actionId type: object ScheduleTrigger: description: Trigger a workflow from a Schedule. The workflow must be published. properties: rruleExpression: description: Recurrence rule expression for scheduling. example: '' type: string required: - rruleExpression type: object GetWorkflowResponse: description: The response object after getting a workflow. properties: data: $ref: '#/components/schemas/WorkflowData' type: object responses: NotFoundResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Not Found PreconditionFailedResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Failed Precondition ForbiddenResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden ConflictResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Conflict TooManyRequestsResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Too many requests BadRequestResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Bad Request parameters: MicrosoftTeamsWorkflowsWebhookHandleIDPathParameter: description: Your Workflows webhook handle id. in: path name: handle_id required: true schema: type: string PageSize: description: Size for a given page. The maximum allowed value is 100. in: query name: page[size] required: false schema: default: 10 example: 10 format: int64 type: integer MicrosoftTeamsWorkflowsWebhookHandleNameQueryParameter: description: Your Workflows webhook handle name. in: query name: name required: false schema: type: string PageNumber: description: Specific page number to return. in: query name: page[number] required: false schema: default: 0 example: 0 format: int64 type: integer InstanceId: description: The ID of the workflow instance. in: path name: instance_id required: true schema: type: string WorkflowId: description: The ID of the workflow. in: path name: workflow_id required: true schema: type: string securitySchemes: AuthZ: description: This API uses OAuth 2 with the implicit grant flow. flows: authorizationCode: authorizationUrl: /oauth2/v1/authorize scopes: apm_api_catalog_read: View API catalog and API definitions. apm_api_catalog_write: Add, modify, and delete API catalog definitions. apm_read: Read and query APM and Trace Analytics. apm_service_catalog_read: View service catalog and service definitions. apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog. appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source. cases_read: View Cases. cases_write: Create and update cases. ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API. ci_visibility_read: View CI Visibility. cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs. cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs. code_analysis_read: View Code Analysis. continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO). create_webhooks: Create webhooks integrations. dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'. dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'. dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally. dashboards_read: View dashboards. dashboards_write: Create and change dashboards. data_scanner_read: View Data Scanner configurations. data_scanner_write: Edit Data Scanner configurations. embeddable_graphs_share: Generate public links to share embeddable graphs externally. events_read: Read Events data. hosts_read: List hosts and their attributes. incident_notification_settings_write: Configure Incidents Notification settings. incident_read: View incidents in Datadog. incident_settings_write: Configure Incident Settings. incident_write: Create, view, and manage incidents in Datadog. metrics_read: View custom metrics. monitor_config_policy_write: Edit and delete monitor configuration. monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes. monitors_read: View monitors. monitors_write: Edit, delete, and resolve individual monitors. org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization. security_comments_read: Read comments of vulnerabilities. security_monitoring_filters_read: Read Security Filters. security_monitoring_filters_write: Create, edit, and delete Security Filters. security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks. security_monitoring_notification_profiles_read: View Rule Security Notification rules. security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. security_monitoring_signals_read: View Security Signals. security_monitoring_suppressions_read: Read Rule Suppressions. security_monitoring_suppressions_write: Write Rule Suppressions. security_pipelines_read: View Security Pipelines. security_pipelines_write: Create, edit, and delete CSM Security Pipelines. slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs. slos_read: View SLOs and status corrections. slos_write: Create, edit, and delete SLOs. synthetics_global_variable_read: View, search, and use Synthetics global variables. synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics. synthetics_private_location_read: View, search, and use Synthetics private locations. synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines. synthetics_read: List and view configured Synthetic tests and test results. synthetics_write: Create, edit, and delete Synthetic tests. teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission. teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team. test_optimization_read: View Test Optimization. timeseries_query: Query Timeseries data. usage_read: View your organization's usage and usage attribution. user_access_invite: Invite other users to your organization. user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries. user_access_read: View users and their roles and settings. workflows_read: View workflows. workflows_run: Run workflows. workflows_write: Create, edit, and delete workflows. tokenUrl: /oauth2/v1/token type: oauth2 apiKeyAuth: description: Your Datadog API Key. in: header name: DD-API-KEY type: apiKey x-env-name: DD_API_KEY appKeyAuth: description: Your Datadog APP Key. in: header name: DD-APPLICATION-KEY type: apiKey x-env-name: DD_APP_KEY bearerAuth: scheme: bearer type: http x-env-name: DD_BEARER_TOKEN x-group-parameters: true x-merge-override: paths: false